Skip to main content
POST
/
knowledge-bases
Creates a Knowledge Base.
curl --request POST \
  --url https://api.totoy.ai/v1/knowledge-bases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Totoy Customer Support Assistant",
  "instructions": "You are a customer support assistant for the customers of the company Totoy.",
  "project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9"
}'
{
  "knowledge_base_id": "kb_feMfJbeqbAEj4u8K5HqmKpUbY",
  "name": "Totoy Customer Support Assistant",
  "instructions": "You are a customer support assistant for the customers of the company Totoy.",
  "project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9",
  "created_at": "2023-07-05T12:00:00Z",
  "updated_at": "2023-07-05T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string

The name for the Knowledge Base

Maximum length: 256
Example:

"Totoy Customer Support Assistant"

​
instructions
string

The instructions for the Knowledge Base.

Maximum length: 4096
Example:

"You are a customer support assistant for the customers of the company Totoy."

​
project_id
string

The unique identifier for the Project that the Knowledge Base will be assigned to. If no project_id is provided, the Knowledge Base will be assigned to the default Project.

Maximum length: 28
Example:

"pj_avX7imfLaPcQnv5ckvGlOEBA9"

Response

OK

​
knowledge_base_id
string
required

The unique identifier for the Knowledge Base.

Maximum length: 28
Example:

"kb_feMfJbeqbAEj4u8K5HqmKpUbY"

​
name
string
required

The name for the Knowledge Base.

Maximum length: 256
Example:

"Totoy Customer Support Assistant"

​
created_at
string<date-time>
required

The date-time of when the Knowledge Base was created, in ISO 8601 format.

Example:

"2023-07-05T12:00:00Z"

​
updated_at
string<date-time>
required

The date-time of when the Knowledge Base was last modified, in ISO 8601 format.

Example:

"2023-07-05T12:00:00Z"

​
instructions
string
required

The instructions for the Knowledge Base.

Maximum length: 4096
Example:

"You are a customer support assistant for the customers of the company Totoy."

​
project_id
string
required

The unique identifier for the Project that the Knowledge Base is assigned to.

Maximum length: 28
Example:

"pj_avX7imfLaPcQnv5ckvGlOEBA9"