Quickstart

export NDI_API_KEY="your-api-key"
export NDI_BASE_URL="https://ndi-api.nace.ai"

JOB=$(curl -s -X POST "$NDI_BASE_URL/v1/parse" \
  -H "X-API-Key: $NDI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source": {
      "type": "url",
      "url": "https://example.com/annual-report.pdf",
      "file_name": "annual-report.pdf"
    }
  }')

JOB_ID=$(echo "$JOB" | jq -r '.job_id')
echo "Job ID: $JOB_ID"

until [[ $(curl -s "$NDI_BASE_URL/v1/jobs/$JOB_ID" -H "X-API-Key: $NDI_API_KEY" | jq -r '.status') =~ succeeded|failed|cancelled ]]; do
  sleep 3
done

curl -s "$NDI_BASE_URL/v1/jobs/$JOB_ID" -H "X-API-Key: $NDI_API_KEY"

{
  "job_id": "...",
  "kind": "parse",
  "status": "succeeded",
  "result": {
    "result_type": "parse",
    "file_name": "annual-report.pdf",
    "lane": "document",
    "document": {
      "page_count": 96,
      "markdown": "# Annual Report 2025\n\n...",
      "text": null,
      "blocks": null,
      "chunks": []
    },
    "ocr_applied": false,
    "units": 24
  }
}

curl -s -X POST "$NDI_BASE_URL/v1/parse?wait_seconds=120" \
  -H "X-API-Key: $NDI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source": {"type": "url", "url": "https://example.com/annual-report.pdf", "file_name": "annual-report.pdf"}}'

# Create workspace (domain_slug sets the taxonomy vocabulary)
WS=$(curl -s -X POST "$NDI_BASE_URL/v1/workspaces" \
  -H "X-API-Key: $NDI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-workspace", "domain_slug": "generic"}' | jq -r '.workspace_id')

# Upload a file (returns a Job; wait for it to complete)
UPLOAD_JOB=$(curl -s -X POST "$NDI_BASE_URL/v1/workspaces/$WS/files" \
  -H "X-API-Key: $NDI_API_KEY" \
  -F "file=@document.pdf" \
  -F 'metadata={"path":"document.pdf"}')

FILE_JOB_ID=$(echo "$UPLOAD_JOB" | jq -r '.job_id')
# ... poll until succeeded ...
FILE_ID=$(curl -s "$NDI_BASE_URL/v1/jobs/$FILE_JOB_ID" -H "X-API-Key: $NDI_API_KEY" | jq -r '.result.file.file_id')

# Ingest to create derived outputs (markdown, search index, tables)
INGEST_JOB=$(curl -s -X POST "$NDI_BASE_URL/v1/workspaces/$WS/ingestions" \
  -H "X-API-Key: $NDI_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"selection\":{\"type\":\"file_ids\",\"file_ids\":[\"$FILE_ID\"]}}" | jq -r '.job_id')

# ... poll until ingestion job succeeded ...

curl -s -X POST "$NDI_BASE_URL/v1/workspaces/$WS/tools/hybrid-search" \
  -H "X-API-Key: $NDI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "revenue by segment", "k": 10}'