Skip to main content
GET
/
v1
/
documents
/
{document_id}
/
status
Get document extraction status
curl --request GET \
  --url http://localhost:8000/v1/documents/{document_id}/status \
  --header 'Authorization: Bearer <token>'
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "vault_uri": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "processing_started_at": "2023-11-07T05:31:56Z",
  "processing_completed_at": "2023-11-07T05:31:56Z",
  "processing_time_seconds": 123,
  "page_count": 123,
  "error_message": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: dk_test_ or dk_live_

Path Parameters

​
document_id
string<uuid>
required

UUID of the document

Response

Current extraction status with timestamps and processing details

Response for job status queries (GET /v1/documents/{job_id}).

​
job_id
string<uuid>
required

Unique identifier for the ingestion job

​
status
enum<string>
required

Current job status

Available options:
pending,
processing,
completed,
failed
​
vault_uri
string
required

GCS path to the document in Cold Vault

​
created_at
string<date-time>
required

Job creation timestamp (ISO 8601)

​
processing_started_at
string<date-time> | null

Processing start timestamp (ISO 8601, null if not started)

​
processing_completed_at
string<date-time> | null

Processing completion timestamp (ISO 8601, null if not completed)

​
processing_time_seconds
number | null

Total processing duration in seconds (null if not completed)

​
page_count
integer | null

Number of pages in the document (null if not processed)

​
error_message
string | null

Error details (only present if status is 'failed')