List documents registered in a knowledge base

curl --request GET \
  --url https://api.example.com/knowledge_bases/{knowledge_base_id}/documents \
  --header 'x-user-id: <x-user-id>'

{
  "documents": [
    {
      "id": "<string>",
      "filename": "<string>",
      "size": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "content_type": "<string>",
      "error": "<string>",
      "chunk_count": 0
    }
  ],
  "total": 123
}

knowledge_bases

List documents registered in a knowledge base

List every document registered against a knowledge base.

Reads from the storage backend (service-mode source of truth), so documents in any lifecycle state — including pending / parsing / error — are returned alongside ready ones.

Args: knowledge_base_id (str): The target knowledge base id. user_id (str): Injected authenticated user ID. service (KnowledgeBaseService): Injected knowledge base service.

Returns: ListKnowledgeDocumentsResponse: One view per registered document.

GET

knowledge_bases

{knowledge_base_id}

documents

List documents registered in a knowledge base

curl --request GET \
  --url https://api.example.com/knowledge_bases/{knowledge_base_id}/documents \
  --header 'x-user-id: <x-user-id>'

{
  "documents": [
    {
      "id": "<string>",
      "filename": "<string>",
      "size": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "content_type": "<string>",
      "error": "<string>",
      "chunk_count": 0
    }
  ],
  "total": 123
}

Headers

x-user-id

string

required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Path Parameters

knowledge_base_id

string

required

The knowledge base id.

Response

Successful Response

Response body for listing documents inside a knowledge base.

documents

KnowledgeDocumentView · object[]

required

One view per registered document.

Show child attributes

total

integer

required

Total number of returned items.

Update mutable fields on a knowledge base Upload a document into a knowledge base