Create a new knowledge base

curl --request POST \
  --url https://api.example.com/knowledge_bases/ \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "name": "<string>",
  "embedding_model_config": {
    "type": "<string>",
    "credential_id": "<string>",
    "model": "<string>",
    "dimensions": 123,
    "parameters": {}
  },
  "description": ""
}
'

{
  "knowledge_base_id": "<string>"
}

knowledge_bases

Create a new knowledge base

Create a new knowledge base for the authenticated user.

Allocates a fresh vector store collection sized to the embedding model’s output dimension and persists the knowledge base record.

Args: body (CreateKnowledgeBaseRequest): Knowledge base name, description, and embedding model configuration. user_id (str): Injected authenticated user ID. service (KnowledgeBaseService): Injected knowledge base service.

Returns: CreateKnowledgeBaseResponse: The server-assigned knowledge base identifier.

POST

knowledge_bases

Create a new knowledge base

curl --request POST \
  --url https://api.example.com/knowledge_bases/ \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "name": "<string>",
  "embedding_model_config": {
    "type": "<string>",
    "credential_id": "<string>",
    "model": "<string>",
    "dimensions": 123,
    "parameters": {}
  },
  "description": ""
}
'

{
  "knowledge_base_id": "<string>"
}

Headers

x-user-id

string

required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Body

application/json

Request body for creating a new knowledge base.

name

string

required

Display name of the knowledge base.

embedding_model_config

EmbeddingModelConfig · object

required

Embedding model used both at indexing and at query time. Cannot be changed after creation — switching would invalidate every previously inserted vector.

Show child attributes

description

string

default:""

Free-form description shown in the UI.

Response

Successful Response

Response body after creating a knowledge base.

knowledge_base_id

string

required

Server-assigned knowledge base identifier.

List the caller's knowledge bases Delete a knowledge base