Skip to main content
GET
/
datasets
/
{dataset_id}
/
documents
/
{batch}
/
indexing-status
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "indexing_status": "<string>",
      "processing_started_at": 123,
      "parsing_completed_at": 123,
      "cleaning_completed_at": 123,
      "splitting_completed_at": 123,
      "completed_at": 123,
      "paused_at": 123,
      "error": "<string>",
      "stopped_at": 123,
      "completed_segments": 123,
      "total_segments": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with 'Bearer '. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

​
dataset_id
string<uuid>
required

The ID of the knowledge base.

​
batch
string
required

The batch number returned from the document creation endpoint.

Response

200 - application/json

Indexing status of the documents in the batch.

​
data
object[]