List documents

GET /api/v1/knowledge-base/documents — request parameters and responses from the Menace Voice API schema.

2 min read

get/api/v1/knowledge-base/documents

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/knowledge-base/documents \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "documents": [
    {
      "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
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

get/api/v1/knowledge-base/documents

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

Query parameters

statusstring · null#

Filter by processing status

limitinteger#

Default: 100

Range: 1–100

offsetinteger#

Default: 0

Range: >= 0

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

documentsobject[]required#

Show child attributes

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#

totalintegerrequired#

limitintegerrequired#

offsetintegerrequired#

Trigger document processing Get document details