Get a document by ID

{
  "created_at": "2024-01-15T09:30:00Z",
  "has_active_workflow": true,
  "id": 1,
  "is_valid": true,
  "name": "Electricity_Invoice_Jan2024.pdf",
  "organization_id": "org_9f8e7d6c5b4a3",
  "status": "ready",
  "document_class": "Invoice",
  "document_subclass": "Utility Bill",
  "extraction_results": [
    {
      "prompt_id": 42,
      "value": {
        "data_type": "String",
        "issues": [
          "Low confidence in date format"
        ],
        "name": "Billing Date",
        "parsed_value": "2023-12-31",
        "raw_value": "31/12/2023",
        "readability": 0.85,
        "traceback": [
          {
            "bbox": {
              "Height": 45,
              "Left": 120.5,
              "Top": 300,
              "Width": 150
            },
            "confidence": 0.78,
            "page": 1,
            "issues": [
              "Blurred text"
            ]
          }
        ]
      }
    }
  ],
  "file_size": 254000,
  "folder_id": 12,
  "page_count": 3,
  "source_document": 0
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idintegerRequired>=1

Query parameters

prompt_idsstringOptional

Optional comma-separated extractor prompt IDs. If omitted, no prompt extraction values are returned.

Response

Document

created_atdatetime

has_active_workflowboolean

True if there is a workflow currently running for this document

idinteger

is_validboolean

namestring

organization_idstring

statusenum

Lifecycle status for a document.

uploading: an upload URL has been issued for the document, but the file has not yet been uploaded to that URL.
processing: the file has been uploaded and the system is ingesting it, extracting metadata, and preparing it for use.
ready: processing is complete and the document can be used in workflows, selectors, and extraction jobs.

Allowed values:

document_classstring or nullOptional

Classification result for this document, if present.

document_subclassstring or nullOptional

Subclass result for this document (nested under document_class). Null when no subclass was assigned.

extraction_resultslist of objects or nullOptional

Extraction values for requested prompt IDs.

file_sizeinteger or nullOptional

folder_idinteger or nullOptional

Folder containing the document. Null or omitted means the document is at root.

page_countinteger or nullOptional

source_documentinteger or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error