Skip to main content
POST
Process a document
Requires Editor, Admin, or Owner. Use the document_uuid and s3_key returned by the upload operation; a key outside the workspace upload location returns 403. Choose chunked for retrieval through semantic search, or full_document for full-document use. Chunked processing requires a configured embedding provider. The response is 200 with pending processing state, not a completed document. Poll Get a document until processing completes or fails.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Body

application/json
document_uuid
string
required
s3_key
string
required
retrieval_mode
string
default:chunked

Response

Successful Response

created_at
string<date-time>
required
created_by
integer
required
custom_metadata
Custom Metadata · object
required
docling_metadata
Docling Metadata · object
required
document_uuid
string
required
file_hash
string
required
file_size_bytes
integer
required
filename
string
required
id
integer
required
is_active
boolean
required
mime_type
string
required
organization_id
integer
required
processing_status
string
required
total_chunks
integer
required
updated_at
string<date-time>
required
processing_error
string | null
retrieval_mode
string
default:chunked
source_url
string | null