Knowledge Bases
Create a knowledge base
Creates a knowledge base in a project. The flow and flow_ui describe the ingestion workflow (how uploaded documents are chunked, embedded, and indexed) and its editor layout. On creation the knowledge base is provisioned with its own hostname for document search and uploads.
Authorization
personalAccessToken AuthorizationBearer <token>
Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Body for POST /v1/knowledgebases.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/knowledgebases" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9", "flow": {}, "flow_ui": {} }'{
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe",
"workflow_version_id": "60bab57e-9f59-448d-bef4-a6fd602db8a4",
"runtime_id": "cb6c5dda-251e-4b64-ab75-e6c8247ffa87",
"hostname": "string",
"vector_store_id": "fde8ce2d-425a-4f9f-ac16-b00440677b44",
"runtime": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"label": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
},
"updated_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
}
}
}{
"error": {
"code": "bad_request",
"message": "Bad Request",
"details": {
"input": "cannot be blank"
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"error": {
"code": "not_found",
"message": "Not Found"
}
}