Get Knowledge Base
Description
Gets the details of a knowledge base.
Details
This API can be used to get information about a single knowledge base by ID. To use this API, pass in the knowledge_base_id that was returned from your Create Knowledge Base API call as a path parameter.
This API will return the details of a knowledge base including its ID, name, the embedding model it uses, any metadata associated with the knowledge base, and the timestamps for its creation, last-updated time.
Backwards Compatibility
V2 and V1 Knowledge Bases are entirely separate and not backwards compatible. Users who have existing V1 knowledge bases will need to migrate their data to V2 knowledge bases.
Authorizations
Path Parameters
Query Parameters
Optional query parameter to include a count of artifacts by status
Connections, ArtifactCount Response
The unique ID of the knowledge base
(Legacy) The unique ID of the underlying vector store. This is to allow for backwards compatibility with the V1 Vector Store APIs. This will be removed in the near future.
The name of the knowledge base
The embedding configuration
Metadata associated with the knowledge base
The timestamp at which the knowledge base was created
The timestamp at which the knowledge base was last updated
The data source connections associated with the knowledge base. Only returned with the view=Connections query parameter.
Number of artifacts in each of the various states, such as completed and failed for this knowledge base. This includes all data sources.
The total number of artifacts in the knowledge base. Only returned with the view=ArtifactCount query parameter.
Whether the knowledge base has been clustered.