Get Index
This method allows you to retrieve the configuration of an index identified by its ID.
The response also contains metadata, such as how many documents have been added to
the index, or what is the status of the index. The status of an index is determined
by the status of the embedding model; if the model becomes unavailable, the status of
the index is updated. The details are reflected in the status_errors.
knowledge_base_id
index_id
Successful Response
{
"id": "string",
"name": "string",
"description": "string",
"embeddings_model_endpoint": "string",
"text_splitting": "string",
"chunk_size": 0,
"chunk_overlap": 0,
"knowledge_base_id": "string",
"object": "string",
"created_at": 0,
"last_indexed_at": 0,
"last_indexed_by_id": "string",
"num_documents": 0,
"status": "string",
"status_errors": [
"string"
]
}ID of the index.
Name of the index.
Description of the index.
ID of the model to be used by the index for generating embeddings.
Method for chunking text for embedding
Maximum size (in tokens) of the text chunks. This must be at least 100 to accomodate for content metadata embedded alongside each chunk of text.
Size of the chunk overlap (in tokens) when splitting text.
ID of the knowledge base of the index.
Object type, which is always index.
Unix timestamp (in seconds) when the index was created.
Unix timestamp (in seconds) when the index contents were last indexed.
ID of the most recent indexing job that affected this index.
Total number of documents in the index.
Availability status of the index.
Details of the index error status, if the index is not available.
Invalid or mismatched knowledge base or index ID.
Validation Error
"HTTPValidationError Object"detail
curl -H 'Authorization: <value>' https://{api_host}/api/v1/control/knowledge-bases/{knowledge_base_id}/indexes/{index_id}