Get Index Status

Retrieves the current status of an indexed document.

Endpoint

GET /index_status/{document_id}

Path Parameters

Parameter	Type	Description
document_id	string	The unique identifier of the document.

Usage

Example URL:

GET /index_status/article_ai_trends_2024

The document_id in the URL path specifies the unique identifier of the document for which you want to retrieve the status.

Response

Field	Type	Description
document_id	string	The ID of the document.
status	string	The current status of the indexed document.

Possible status values

Status	Description
queued	Document is in the indexing queue
processing	Document is being processed
indexed	Document has been successfully indexed
failed	Indexing process failed

Example Response

{
  "document_id": "article_ai_trends_2024",
  "status": "processing"
}

Error Responses

• 404 Not Found: Document not found
  • This occurs when the specified document_id is not found in the index queue or database.

Status Transition Flow

The typical status transition flow for a document is as follows:

1. queued: Initial status when a document is submitted for indexing
2. processing: The document is being analyzed and indexed
3. indexed: The document has been successfully added to the search index

If an error occurs during the indexing process, the status may change to failed.

Handling Failed Indexing

If a document's status is failed, you may want to:

1. Check your document for any issues (e.g., invalid format, corrupted data)
2. Verify that the document meets all requirements (e.g., size limits, allowed types)
3. Resubmit the document using the Index Document endpoint

If the problem persists, contact the API support team for further assistance.