Batch-query indexing status of one or more documents

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

{
  "items": [
    {
      "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
    }
  ]
}

knowledge_bases

Batch-query indexing status of one or more documents

Return the current lifecycle state of a batch of documents.

Designed for the front-end’s status polling loop: the page sends every in-flight document id at once so per-document round-trips do not multiply with concurrency.

Args: knowledge_base_id (str): The target knowledge base id. ids (str): Comma-separated document ids. user_id (str): Injected authenticated user ID. service (KnowledgeBaseService): Injected knowledge base service.

Returns: ListKnowledgeDocumentStatusResponse: Views for the matched documents.

GET

knowledge_bases

{knowledge_base_id}

documents

status

Batch-query indexing status of one or more documents

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

{
  "items": [
    {
      "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
    }
  ]
}

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.

Query Parameters

ids

string

required

Comma-separated list of document ids to query. Missing ids are silently omitted from the response.

Response

Successful Response

Response body for batch document-status polling.

items

KnowledgeDocumentView · object[]

required

Subset of the requested documents that still exist. Missing ids are silently omitted — clients may legitimately ask about a document that was deleted between two polls.

Show child attributes

Upload a document into a knowledge base Delete a document from a knowledge base