Skip to main content
GET
Get Document

Authorizations

Authorization
string
header
required

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

Path Parameters

document_id
string
required

Response

Returns the document's full record: document_id, name, filename, type, size, status, categories, uploader, and timestamps.

One document's full record: everything on its status and list rows, plus filename, type, size and uploader found nowhere else.

document_id
string
required

Unique identifier for the document

Examples:

"document_01k4x9m2p7q3r5s8"

"document_01k4x9m2p7q3r5s9"

filename
string
required

Original filename of the uploaded document

Examples:

"product_catalog.docx"

"training_manual.txt"

type
string
required

MIME type of the document

Example:

"text/plain"

size
integer
required

File size in bytes

Required range: x >= 0
Examples:

2548736

1024000

512000

status
enum<string>
required

Current processing status of the document (PROCESSING, READY, FAILED)

Available options:
PROCESSING,
READY,
FAILED
categories
string[]
required

List of category tags assigned to the document for organization and retrieval

Examples:
uploader
string
required

Email/username of the user who uploaded the document

Examples:

"user@example.com"

"admin@example.com"

document_name
string | null

Display name of the document. Defaults to the document id if not set at upload.

Example:

"Customer Support Guide"

created_at
string | null

Timestamp when the document was created

completed_at
string | null

Timestamp when processing completed; null while still running

updated_at
string | null

Timestamp of the last status change

progress
number | null

Completion progress, 0.0 to 100.0. Not wired up yet, always null.

eta_seconds
integer | null

Estimated time remaining in seconds. Not wired up yet, always null.