Skip to main content
GET
Get Document Status

Authorizations

capout-api-key
string
header
required

Organization-scoped CapOut API key

Path Parameters

document_id
string
required

Response

Successful Response

Response body for GET /status/{document_id}.

document_id
string
required

Public document ID for status polling, realtime subscriptions, and ESX downloads.

status
string
required
terminal
boolean
default:false
progress
DocumentProgress · object | null
workflow_complete
boolean
default:false
file_name
string | null
error
string | null
export
DocumentExportResponse · object | null

Export state attached to a document status response.

completed_at
string<date-time> | null
updated_at
string<date-time> | null