Get Knowledge Base
This method allows you to retrieve the configuration of a knowledge base identified by its ID.
The response also contains metadata, such as how many data sources are linked to the knowledge base, or how many agents make use of an index of this knowledge base.
knowledge_base_id
Successful Response
{
"id": "string",
"name": "string",
"description": "string",
"index_refresh_policy": {
"policy_type": "string"
},
"data_origin_type": "string",
"object": "string",
"created_at": 0,
"last_updated_at": 0,
"next_index_refresh_at": 0,
"status": "string",
"num_linked_data_sources": 0,
"num_linked_agents": 0
}ID of the knowledge base.
Name of the knowledge base.
Description of the knowledge base.
Policy defining when to refresh the index of the knowledge base.
data_origin_type
Object type, which is always knowledge_base.
Unix timestamp (in seconds) when the knowledge base was created.
Unix timestamp (in seconds) when the knowledge base was last updated.
Unix timestamp (in seconds) of the next scheduled indexing.
Availability status of a knowledge base.
Number of linked data sources.
Number of agents using this knowledge base.
Invalid knowledge base ID.
Validation Error
{
"detail": [
{
"loc": [
{}
],
"msg": "string",
"type": "string",
"ctx": {}
}
]
}detail
curl -H 'Authorization: <value>' https://{api_host}/api/v1/control/knowledge-bases/{knowledge_base_id}