See Stacksync in action with a solution architect. Book a demo ↗
StacksyncDocs
StacksyncCommunityBook a demoContact Support
HomeTwo-way syncAgentic WorkflowsGeniesEnterprise OSMCPEDIConnectorsSecurity and Other ResourcesChangelogDevelopersAPI Reference
Knowledge basesDocuments

Knowledge base documents

Get a knowledge base document

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

A document of a knowledge base, with its 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
knowledge_base_document_id*string

The document of the knowledge base.

Formatuuid

Query Parameters

region*Regions

Region of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them

Value in"besg""usnv"

Response Body

OK

application/json
  1. response

A document of a knowledge base, and how far its processing got

document_id*Document Id
knowledge_base_id*Knowledge Base Id
title*Title
mime_type*Mime Type
file_id*File Id
processing_status*string|null
processing_error*string|null
chunk_count*integer|null
created_time*Created Time
Formatdate-time
Get a knowledge base document
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/knowledge-bases/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08?region=besg'
{  "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"}

GETList knowledge base documents

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

POSTAdd a knowledge base document

Adds a file of the workspace (uploaded with the files API) to a knowledge base as a document, and processes it. The file must be a document Stacksync can read (PDF, Word, Excel, CSV, JSON, Markdown or plain text) and not already a document of the knowledge base. With validate_only, the checks run and 204 answers, nothing is added.