Trigger document processing

POST /api/v1/knowledge-base/process-document — request parameters and responses from the Menace Voice API schema.

2 min read

post/api/v1/knowledge-base/process-document

Request example

curl --request POST \
  --url https://voice.menaceui.com/api/v1/knowledge-base/process-document \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "document_uuid": "<string>",
  "s3_key": "<string>",
  "retrieval_mode": "chunked"
}'

Response

{
  "id": 1,
  "document_uuid": "<string>",
  "filename": "<string>",
  "file_size_bytes": 1,
  "file_hash": "<string>",
  "mime_type": "<string>",
  "processing_status": "<string>",
  "processing_error": "<string>",
  "total_chunks": 1,
  "retrieval_mode": "chunked",
  "custom_metadata": {},
  "docling_metadata": {},
  "source_url": "<string>",
  "content": "<string>",
  "created_at": "2026-08-10T12:00:00Z",
  "updated_at": "2026-08-10T12:00:00Z",
  "organization_id": 1,
  "created_by": 1,
  "is_active": true
}

post/api/v1/knowledge-base/process-document

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

document_uuidstringrequired#

Document UUID to process

s3_keystringrequired#

S3 key of the uploaded file

retrieval_modestring#

Retrieval mode: 'chunked' for vector search or 'full_document' for full text retrieval

Default: "chunked"

Responses

application/json

Successful Response

idintegerrequired#

document_uuidstringrequired#

filenamestringrequired#

file_size_bytesintegerrequired#

file_hashstringrequired#

mime_typestringrequired#

processing_statusstringrequired#

processing_errorstring · null#

Show child attributes

Any of

total_chunksintegerrequired#

retrieval_modestring#

Default: "chunked"

custom_metadataobjectrequired#

docling_metadataobjectrequired#

source_urlstring · null#

Show child attributes

Any of

contentstring · null#

Extracted document content for preview when processing is complete

Show child attributes

Any of

created_atstringrequired#

updated_atstringrequired#

organization_idintegerrequired#

created_byintegerrequired#

is_activebooleanrequired#

Get presigned URL for document upload List documents