List Indexes
This method allows you to list all indexes of a knowledge base.
For each index in the list, 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
after
before
limit
offset
order
set_num_objects
name
Successful Response
{
"object": "string",
"has_more": false,
"num_objects": 0,
"data": [
{
"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"
]
}
],
"first_id": "string",
"last_id": "string"
}
Object type, which is always list
.
True, if the server may have more objects than returned in the response.
Total number of objects that match the request. Note that this field is populated only if requested by the user (see set_num_objects
request parameter).
List of indexes.
ID of the first element in the list (if any)
ID of the last element in the list (if any)
Invalid knowledge base ID was provided.
An invalid ID was passed for paginating results.
Validation Error
"HTTPValidationError Object"
detail
curl -H 'Authorization: <value>' https://{api_host}/api/v1/control/knowledge-bases/{knowledge_base_id}/indexes