DocMindDOCS
Dashboard
API Reference / Extractions

Extractions

An extraction is one run of a template against one document. Retrieve it to read the result and status.

Retrieve an extraction

GET/v1/extractions/:id

Poll this until status is completed or failed.

200 OK
curl https://api.docmind.wistfare.com/v1/extractions/2f14eb10-6b1d-4f0e-9a3b-1c7e6d5a8b21 \
  -H "Authorization: Bearer sk_live_..."

{
  "id": "2f14eb10-6b1d-4f0e-9a3b-1c7e6d5a8b21",
  "status": "completed",
  "fields": {
    "schema": "docmind.compact_extraction.v1",
    "document": {
      "template_id": "tpl_481",
      "template_name": "Invoice",
      "document_type": "Invoice",
      "document_title": "Tax Invoice",
      "document_language": "en"
    },
    "values": {
      "invoice_number": "INV-2026-0481",
      "total_amount": 19872.0,
      "issue_date": "2026-05-21",
      "line_items": [
        { "description": "Consulting", "quantity": "2", "amount": "1200.00" }
      ]
    },
    "sections": [
      {
        "name": "invoice_details",
        "title": "Invoice details",
        "fields": [
          {
            "name": "invoice_number",
            "title": "Invoice No",
            "type": "string",
            "section": "invoice_details",
            "control_type": "text",
            "value": "INV-2026-0481",
            "confidence": 0.96,
            "bounding_box": { "page": 1, "x": 0.427, "y": 0.305, "width": 0.16, "height": 0.022 },
            "coordinate_space": { "type": "normalized", "page": 1, "width": 1, "height": 1 }
          }
        ]
      }
    ]
  },
  "latency_ms": 2410,
  "created_at": "2026-06-07T10:41:55Z"
}

Statuses

NAMETYPEDESCRIPTION
queuedstatusAccepted and waiting for a worker.
processingstatusCurrently being extracted.
completedstatusDone — fields holds the structured result.
failedstatusCould not complete — error holds the reason. No credits are charged.

The extraction object

NAMETYPEDESCRIPTION
idstringUnique identifier of the extraction.
statusstringqueued · processing · completed · failed.
fields.valuesobjectPlain extracted values keyed by template field name. Dynamic tables are returned as arrays of row objects.
fields.document.document_languagestringFor multi-language templates: which language variant the scanned document matched. Titles and bounding boxes in sections follow this variant.
fields.sectionsarraySectioned field details with title, type, value, confidence, bounding box and options. Boxes from templates created after July 2026 are normalized page fractions (0–1).
precontextobjectRaw provider OCR evidence. Hidden by default; request with include_precontext=1 for debugging.
errorstringFailure reason. Present when failed.
latency_msnumberEnd-to-end processing time in milliseconds.

List extractions

GET/v1/extractions

Returns recent extractions, newest first. Page with limit and offset.

200 OK
GET /v1/extractions?limit=25&offset=0

{ "data": [ { "id": "...", "status": "completed", ... }, ... ] }
PreviousExtractNextWebhooks