Delete Knowledge Base

Delete Knowledge Base

This method allows you to delete a previously created knowledge base using its ID.

You can obtain the ID of the knowledge base to delete either from the API response when you created the knowledge base, or by listing the available knowledge bases.

Note that knowledge bases that are in use by an agent cannot be deleted. If you attempt to do so, the API will raise an error. In this case, you have to unlink the knowledge base from all agents before being able to delete it.

Request
URI
DELETE
https://{api_host}/api/v1/control/knowledge-bases/{knowledge_base_id}
COPY
Path Parameters
string
knowledge_base_id
Required

knowledge_base_id

Authentication
This operation uses the following authentication methods.
Responses
200

Successful Response

Returns DeletionStatusResponse of type(s) application/json 
{
    "id": "string",
    "object": "string",
    "deleted": false
}
string As uuid As uuid
id
Required

id

string
object
Required

object

boolean
deleted
Required

deleted


404

Invalid knowledge base ID.

Operation doesn't return any data structure

409

The knowledge base is not in a state where it can be deleted.

Operation doesn't return any data structure

422

Validation Error

Returns HTTPValidationError of type(s) application/json 
"HTTPValidationError Object"
array of object
detail
Optional

detail


Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/api/v1/control/knowledge-bases/{knowledge_base_id}
On This Page
Knowledge Bases Operations
GET
Get Knowledge Base
PATCH
Update Knowledge Base
DELETE
Delete Knowledge Base
GET
List Knowledge Bases
POST
Create Knowledge Base
GET
Get Knowledge Base Data Source Link
DELETE
Delete Knowledge Base Data Source Link
GET
List Knowledge Base Data Source Links
POST
Create Knowledge Base Data Source Link
POST
Cancel Delete Knowledge Base Data Source Link
POST
Batch Create Knowledge Base Data Source Links
POST
Batch Delete Knowledge Base Data Source Links
POST
Batch Cancel Delete Knowledge Base Data Source Links