Skip to main content
GET
Get Knowledge Base Details
Retrieve detailed information about a specific knowledge base including its configuration, document count, and metadata.

Path Parameters

string
required
Unique identifier of the knowledge base (UUID format)

Response

string
Unique identifier for the knowledge base (UUID)
string
Display name of the knowledge base
string
Optional description of the knowledge base purpose (can be null)
string
Knowledge base type: managed
string
UUID of the organization that owns this knowledge base
string
UUID of the agent this knowledge base is attached to (can be null)
integer
Total number of documents in the knowledge base

Example Request

Example Response

Notes

  • Returns 404 if the knowledge base is not found or doesn’t belong to your organization
  • Use this endpoint to verify knowledge base existence before adding documents

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

kb_id
string
required

Response

Successful Response

Represents a Knowledge Base item.

Attributes: id (str): KB unique identifier. name (str): KB name specified by the user. description (str): KB description specified by the user. type (KnowledgeBaseType): KB type, either managed or external. organization_id (str): Organization ID associated with the KB. total_documents (int): Total count of embedded documents. Defaults to 0.

id
string
required

KB unique identifier

name
string
required

KB name specified by the user

type
enum<string>
required

KB type, managed / external

Available options:
managed,
external
organization_id
string
required

Organization ID

description
string | null

KB description specified by the user

agent_id
string | null

Agent ID

total_documents
integer
default:0

Total count of embedded documents