Skip to main content

​
Endpoint

POST https://api.documind.cloud/api/v1/extract/{document_id}

​
Authentication

Requires extractions:write scope.

​
Path Parameters

ParameterTypeRequiredDescription
document_idstring (UUID)YesID of the uploaded document

​
Request Body

FieldTypeRequiredDescription
schemaobjectNoJSON Schema defining fields to extract. Strongly recommended for structured output
promptstringNoCustom extraction instructions
modelstringNoModel for Basic mode: qwen-3-vl, google-gemini-2.5-flash, or google-gemini-3-flash
extraction_modestringNoSet to vlm for VLM mode
review_thresholdnumberNoConfidence threshold for review (0-100, default: 80)
include_citationsbooleanNoEnable citation/source matching. Only available for Advanced mode
agentic_ocrbooleanNoUse the higher OCR tier for Advanced mode parsing
confidence_instructionstringNoAdditional instructions for confidence scoring in Advanced mode
Extraction Modes:
  • Basic: Set model parameter (2-6 credits/page)
  • VLM: Set extraction_mode to vlm (10 credits/page)
  • Advanced: Don’t set model or extraction_mode (15 credits/page with confidence scoring)
Citation matching is only available in Advanced mode. Do not set model or extraction_mode when include_citations is true.

​
Response

​
Success (200)

{
  "document_id": "123e4567-e89b-12d3-a456-426614174000",
  "results": {
    "invoice_number": "INV-2024-001",
    "total": 1250.00,
    "vendor": {
      "name": "Acme Corp"
    }
  },
  "needs_review": false,
  "needs_review_metadata": {
    "confidence_scores": {},
    "review_flags": {}
  }
}

​
Examples

import requests

API_KEY = "your_api_key"
document_id = "123e4567-e89b-12d3-a456-426614174000"

schema = {
    "type": "object",
    "named_entities": {
        "invoice_number": {"type": "string"},
        "total": {"type": "number"}
    },
    "required": ["invoice_number", "total"]
}

# Basic mode
response = requests.post(
    f"https://api.documind.cloud/api/v1/extract/{document_id}",
    headers={"X-API-Key": API_KEY},
    json={
        "schema": schema,
        "model": "qwen-3-vl"
    }
)

result = response.json()
print(f"Invoice: {result['results']['invoice_number']}")
print(f"Total: ${result['results']['total']}")

​
Error Responses

CodeDescription
400Invalid schema or parameters
402Insufficient credits
404Document not found
500Extraction failed

​
Next Steps

Upload Documents

Upload documents first

List Extractions

Query extraction results