Knowledge Base
The Knowledge Base model
Key | Type | Description |
---|---|---|
id | String | The unique identifier for the knowledge base which is given by Tiledesk. |
name | String | The knowledge base name. |
id_project | String | The unique identifier of the project |
preview_settings | Object | The settings for the knowledge base preview |
default | Boolean | Specify if the knowledge base is the default one |
Get all knowledge bases
GET
https://api.tiledesk.com/v3/:project_id/kb/namespace/all
Allows to list all the knowledge bases of a project. Returns at least the default knowledge base.
Path Parameters
Name | Type | Description |
---|---|---|
project_id | string | The Project Id is a unique code assigned to your project when you create it in Tiledesk. |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization token. Basic Auth or JWT |
Example
Create new knowledge base
POST
https://api.tiledesk.com/v3/:project_id/kb/namespace
Allows to create a new knowledge base for a project.
Path Parameters
Name | Type | Description |
---|---|---|
project_id | string | The Project Id is a unique code assigned to your project when you create it in Tiledesk. |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization token. Basic Auth or JWT |
Request Body
Name | Type | Description |
---|---|---|
name | string | The name of the knowledge base. |
Example
Update a knowledge base
PUT
https://api.tiledesk.com/v3/:project_id/kb/namespace/:id
Allows to update a knowledge base info and preview settings.
Path Parameters
Name | Type | Description |
---|---|---|
project_id | string | The Project Id is a unique code assigned to your project when you create it in Tiledesk. |
id | string | The unique identifier for the knowledge base |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization token. Basic Auth or JWT |
Request Body
Name | Type | Description |
---|---|---|
name | string | The name of the knowledge base. |
preview_settings | object | The AI settings for the knowledge base settings. |
Example
Delete a knowledge base
DELETE
https://api.tiledesk.com/v3/:project_id/kb/namespace/:id
Allows to delete the whole knowledge base or it's contents only.
Path Parameters
Name | Type | Description |
---|---|---|
project_id | string | The Project Id is a unique code assigned to your project when you create it in Tiledesk. |
id | string | The unique identifier for the knowledge base |
Query Parameters
Name | Type | Description |
---|---|---|
contents_only | boolean | (Optional) if TRUE will be deleted only the contents |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization token. Basic Auth or JWT |
Example
Last updated