Endpoint Reference
Purpose
Section titled “Purpose”This page lists the public API endpoints for document extraction. It maps each route to what it does and links to the detailed guides for request and response examples.
These docs cover the extraction API only. Other capabilities, such as creating templates, filters, workflows, and document review, are managed in the product UI and are not part of the public API at this stage.
API Surface
Section titled “API Surface”| Surface | Base URL placeholder | Auth | Use |
|---|---|---|---|
| Extraction runtime | $EXTRACTION_BASE_URL | Authorization: api-key <environment-api-key> | Submit documents, poll jobs, and fetch results |
Use the tenant-specific value supplied during onboarding.
Public Integration Routes
Section titled “Public Integration Routes”These are the routes available to API-key backend integrations.
| Capability | Endpoint | Auth | Notes |
|---|---|---|---|
| Synchronous extraction | POST /api/v1/extractFields | API key | Immediate extraction response. Use for small or manual flows. See Synchronous Extraction. |
| Create async extraction job | POST /api/v1/extraction-jobs | API key | Production default for durable extraction. Supports polling or webhook delivery. See Asynchronous Extraction. |
| Get job status | GET /api/v1/extraction-jobs/:id | API key | Poll queued, processing, review-required, completed, and failed jobs. |
| Get job result | GET /api/v1/extraction-jobs/:id/result | API key | Fetches the full extraction payload after completion. |
| Legacy async create | POST /api/v1/extractFieldsAsync | API key | Polling-only compatibility route. New integrations should use /api/v1/extraction-jobs. |
| Legacy async status | GET /api/v1/checkStatus/:guid | Compatibility GUID | Retained for older clients. New integrations should use /api/v1/extraction-jobs/:id. |
When you submit an extraction request, you reference a template or filter by the name shown for it in the product UI.
Managed In The Product UI
Section titled “Managed In The Product UI”The following are product UI features, not public API endpoints:
- creating, generating, editing, and deleting templates
- creating and editing filters
- building and running workflows
- reviewing and approving low-confidence results (document review)
- API key, usage, account, workspace, and organization management
If you need programmatic access to any of these, let us know and we can extend the API and these docs.
Decision Tree
Section titled “Decision Tree”- Use
POST /api/v1/extraction-jobsfor production document extraction. - Use
POST /api/v1/extractFieldsfor immediate or manual extraction. - Set up templates, filters, workflows, and document review in the product UI.