Skip to main content
POST
Create Knowledge Base
Create a new knowledge base in your organization to store and manage documents.

Request Body

string
required
Display name for the knowledge base
string
Optional description of the knowledge base purpose

Response

string
Unique identifier for the knowledge base (UUID)
string
Display name of the knowledge base
string
Description of the knowledge base (nullable)
string
Knowledge base type: managed
string
UUID of the organization that owns this knowledge base
string
Associated agent ID (nullable)
integer
Number of documents in the knowledge base (initially 0)

Example Request

Example Response

Notes

  • New knowledge bases start with zero documents
  • Use the returned id to add documents via the Add Documents endpoint

Authorizations

x-api-key
string
header
required

API Key for authentication

Body

application/json
name
string
required

KB name specified by the user

description
string | null

KB description specified by the user

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