Skip to main content

Endpoint

Authentication

Requires extractions:write scope.

Path Parameters

Request Body

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.

Explicit review contract opt-in

Omitting review_contract, or sending "legacy", preserves the existing workflow even when the project and API-key owner have managed-review access. Existing web extraction requests omit this field and remain legacy. After validating your robot’s terminal-state handling and confirming project/access prerequisites, send:
The persisted review_decision_managed response field selects the document workflow. Request intent is not proof of enrollment. Sending an opt-in field on a document with an existing unmanaged extraction does not convert it; use a new document identity for a new managed processing attempt. Review capabilities describe eligibility, not automatic enrollment. Synchronous extraction responses do not include technical status. Managed automation reads stored extraction status using the polling helper.

Response

Success (200)

Examples

Error Responses

Next Steps

Upload Documents

Upload documents first

List Extractions

Query extraction results