Poll Knowledge Base Status

Retrieves the indexing status for one or more knowledge base sources by their IDs. Use this endpoint to monitor the progress of file uploads, text entries, or website crawls being indexed.

Batch support: Accepts multiple IDs in a single request to efficiently check status across sources.

POST /ai-agents/agent-builder/knowledge-base/status/poll

Poll Knowledge Base Status

cURL

curl --request POST \
  --url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/status/poll \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "uniqueId": [
    "fb45bb1e-bc81-45a8-85be-36b2aa4f289e",
    "c2847dcd-636c-4e7a-9217-593ccf2a7bb1"
  ]
}
'

200

{
  "success": true,
  "data": {
    "id1": "indexing",
    "id2": "indexed"
  }
}

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json

Array of unique IDs to query

uniqueId · string[] · required

Array of unique IDs to query

Example:

[
  "fb45bb1e-bc81-45a8-85be-36b2aa4f289e",
  "c2847dcd-636c-4e7a-9217-593ccf2a7bb1"
]

Response

200 - application/json

Status for requested unique IDs

The response is of type object.