IndexListResponse

IndexListResponse
IndexListResponse

List of indexes.

JSON Example
{
    "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"
}
string
object
Optional
Constraints: default: list

Object type, which is always list.

boolean
has_more
Optional

True, if the server may have more objects than returned in the response.

integer
num_objects
Required

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).

array of Index
data
Required

List of indexes.

string As uuid As uuid
first_id
Required

ID of the first element in the list (if any)

string As uuid As uuid
last_id
Required

ID of the last element in the list (if any)

Returned By