Skip to main content
GET
/
v1
/
knowledge
/
{kb_id}
Get Knowledge Base Details
curl --request GET \
  --url https://api.xpander.ai/v1/knowledge/{kb_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "organization_id": "<string>",
  "description": "<string>",
  "agent_id": "<string>",
  "total_documents": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.xpander.ai/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve detailed information about a specific knowledge base including its configuration, document count, and metadata.

​
Path Parameters

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

​
Response

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

​
Example Request

curl -X GET -H "x-api-key: <your-api-key>" \
  https://api.xpander.ai/v1/knowledge/<kb-id>

​
Example Response

{
  "id": "73dc30ca-bdbf-42f7-a39f-93aff4f8522e",
  "name": "Product Catalog",
  "description": "Complete product information and specifications",
  "type": "managed",
  "organization_id": "<org-id>",
  "agent_id": null,
  "total_documents": 12
}

​
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