Skip to main content

Create a knowledge base

POST 

/v1/knowledge_bases

Free of charge but subject to the knowledge-base count limit (free trial: 402 trial_exhausted with details.meter = knowledge_bases; platform limit: 409 resource_limit_reached). Only portal admins and owners and API keys with access to all knowledge bases (kb_allowlist = null) may create a knowledge base: a key limited to a list of knowledge bases (or to none) gets 403 kb_not_in_allowlist and nothing is created.

embedding_model picks the knowledge base's embedding model: the id of an entry of GET /v1/knowledge_embedding_models. Leave it out (or send null) to use the recommended model. The model is fixed for the life of the knowledge base; to use another model, create a new knowledge base. Every model in that list can be used by your organization, whether or not you also use it for inference. A refusal is 422 validation_failed with param = embedding_model: an unknown or no longer offered id (no details.reason), details.reason = model_unknown (the model was removed from the platform) or details.reason = unpriced (the model has no processing price for your organization right now). If the model cannot be checked right now, the call is a retryable 503 knowledge_unavailable and no knowledge base is created.

Access: API key scope knowledge:write; portal users: organization admins and owners; a key limited to a list of knowledge bases (or to none) is refused with 403 kb_not_in_allowlist; refused with 403 module_disabled while knowledge bases are switched off on the platform.

Request​

Responses​

Created