See Stacksync in action with a solution architect. Book a demo ↗
Knowledge basesDocuments

Knowledge base documents

List knowledge base documents

GET
/v1/workspaces/{workspace_id}/knowledge-bases/{knowledge_base_id}/documents

The documents of a knowledge base, newest first, with their processing status.

Authorization

Authorizationstringheaderrequired

Bearer <key>, where <key> is a workspace API key or a user API key. See Authentication.

Path Parameters

workspace_id*integer

The workspace. List the ones your key can reach with GET /v1/workspaces.

knowledge_base_id*string

The knowledge base.

Formatuuid

Query Parameters

limit?Limit

Maximum number of items returned, at most 200

Range1 <= value <= 200
Default50
offset?Offset

Number of items skipped before the first one returned

Range0 <= value
Default0
region*Regions

Region of the knowledge base: besg (Europe) or usnv (United States)

Value in"besg""usnv"

Response Body

OK

application/json
  1. response
data*array<>
has_more*Has More

Whether more items follow this page: request the next one with offset + limit

limit*Limit
offset*Offset
List knowledge base documents
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/knowledge-bases/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents?region=besg'
{  "data": [    {      "document_id": "<document_id>",      "knowledge_base_id": "<knowledge_base_id>",      "title": "<title>",      "mime_type": "<mime_type>",      "file_id": "<file_id>",      "processing_status": "<processing_status>",      "processing_error": "<processing_error>",      "chunk_count": 0,      "created_time": "2027-01-15T09:00:00Z"    }  ],  "has_more": false,  "limit": 0,  "offset": 0}