Skip to main content
GET
Get document details

Authorizations

X-API-KEY
string
header
required

Headers

X-End-User-ID
string | null

Path Parameters

document_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required

The unique identifier for the document.

name
string
required

The display name of the document.

status
string
required

The current processing status of the document.

created_at
string<date-time>
required

The timestamp when the document was created.

updated_at
string<date-time>
required

The timestamp when the document was last updated.

file_type
string | null

The MIME type of the document file.

processing_pipeline
string | null

The name of the processing pipeline used for this document.

error_message
string | null

If processing failed, this field will contain the error message.

api_metadata
Api Metadata · object | null

Custom API metadata resolved for the current user. Useful for retrieving stored external references (e.g. {'internal_app_ref': 'REF-123'}). Note: This value is resolved based on the request's external_user_id. A document shared globally but also scoped to a specific user may return different metadata depending on who is asking.

file_name
string | null

The original file name of the document.

markdown_content
string | null

The full content of the document converted to Markdown format.