/chatbotkit-bots | Type: Application | PCID required: Yes
Tools
chatbotkit_bots_clone_bot
Clone bot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
botId | string | Yes | — | Bot Id |
body | object | Yes | — | Request body |
chatbotkit_bots_create_bot
Create bot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alias | string | No | — | The unique alias for the instance |
backstory | string | No | — | The backstory this configuration is using |
blueprintId | string | No | — | The ID of the blueprint |
datasetId | string | No | — | The id of the dataset this configuration is using |
description | string | No | — | The associated description |
meta | object | No | — | Meta data information |
model | string | No | — | A model definition |
moderation | boolean | No | — | The moderation flag for this configuration |
name | string | No | — | The associated name |
privacy | boolean | No | — | The privacy flag for this configuration |
skillsetId | string | No | — | The id of the skillset this configuration is using |
visibility | string | No | — | The bot visibility |
chatbotkit_bots_create_bot_session
Create bot session Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
botId | string | Yes | — | The ID of the bot for this session |
durationInSeconds | number | No | — | The maximum amount of time this session will stay open |
messages | any[] | No | — | An array of messages to be included in the conversation |
meta | object | No | — | Meta data information |
chatbotkit_bots_create_skillset
Create skillset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alias | string | No | — | The unique alias for the instance |
blueprintId | string | No | — | The ID of the blueprint |
description | string | No | — | The associated description |
meta | object | No | — | Meta data information |
name | string | No | — | The associated name |
visibility | string | No | — | The skillset visibility |
chatbotkit_bots_create_skillset_ability
Create ability Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | Skillset Id |
blueprintId | string | No | — | The ID of the blueprint |
botId | string | No | — | The ID of the bot associated with the ability |
description | string | No | — | The associated description |
fileId | string | No | — | The ID of the file associated with the ability |
instruction | string | No | — | The instruction of the ability |
meta | object | No | — | Meta data information |
name | string | No | — | The associated name |
secretId | string | No | — | The ID of the secret associated with the ability |
spaceId | string | No | — | The ID of the space associated with the ability |
chatbotkit_bots_delete_bot
Delete a bot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
botId | string | Yes | — | The ID of the bot to delete |
chatbotkit_bots_delete_skillset
Delete a skillset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | The ID of the skillset to delete |
chatbotkit_bots_delete_skillset_ability
Delete a ability from a skillset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | The ID of the skillset |
abilityId | string | Yes | — | The ID of the ability to delete |
chatbotkit_bots_execute_skillset_ability
Execute a skillset ability Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | The ID of the skillset containing the ability |
abilityId | string | Yes | — | The ID of the ability to execute |
contactId | string | No | — | The ID of the contact to associate with the execution |
input | string | No | — | The input to process with the ability. This can be structured text such as JSON or YAML for precise parameter control, or unstructured natural language text. When unstructured text is provided, the system will automatically detect and extract the relevant parameters from the input. |
chatbotkit_bots_export_skillset_abilities
Export skillset abilities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | The ID of the skillset to export |
cursor | string | No | — | The cursor to use for pagination |
order | string | No | — | The order of the paginated items |
take | integer | No | — | The number of items to retrieve |
chatbotkit_bots_fetch_bot
Fetch a bot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
botId | string | Yes | — | The ID of the bot to retrieve |
chatbotkit_bots_fetch_skillset
Fetch a skillset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | The ID of the skillset to retrieve |
chatbotkit_bots_fetch_skillset_ability
Fetch a ability from a skillset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | The ID of the skillset |
abilityId | string | Yes | — | The ID of the ability to retrieve |
chatbotkit_bots_list_bots
Retrieve a list of bots Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | The cursor to use for pagination |
order | string | No | — | The order of the paginated items |
take | integer | No | — | The number of items to retrieve |
meta | object | No | — | Key-value pairs to filter the partner users by metadata |
chatbotkit_bots_list_skillset_abilities
Retrieve a list of skillset abilities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | The ID of the skillset |
cursor | string | No | — | The cursor to use for pagination |
order | string | No | — | The order of the paginated items |
take | integer | No | — | The number of items to retrieve |
chatbotkit_bots_list_skillsets
Retrieve a list of skillsets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | The cursor to use for pagination |
order | string | No | — | The order of the paginated items |
take | integer | No | — | The number of items to retrieve |
meta | object | No | — | Key-value pairs to filter the partner users by metadata |
chatbotkit_bots_search_bot_memory
Search memories for a specific bot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
botId | string | Yes | — | The ID of the bot to search memories for |
search | string | Yes | — | The keyword/phrase to search for |
chatbotkit_bots_update_bot
Update bot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
botId | string | Yes | — | Bot Id |
alias | string | No | — | The unique alias for the instance |
backstory | string | No | — | The backstory this configuration is using |
blueprintId | string | No | — | The ID of the blueprint |
datasetId | string | No | — | The id of the dataset this configuration is using |
description | string | No | — | The associated description |
meta | object | No | — | Meta data information |
model | string | No | — | A model definition |
moderation | boolean | No | — | The moderation flag for this configuration |
name | string | No | — | The associated name |
privacy | boolean | No | — | The privacy flag for this configuration |
skillsetId | string | No | — | The id of the skillset this configuration is using |
visibility | string | No | — | The bot visibility |
chatbotkit_bots_update_skillset
Update skillset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | Skillset Id |
alias | string | No | — | The unique alias for the instance |
blueprintId | string | No | — | The ID of the blueprint |
description | string | No | — | The associated description |
meta | object | No | — | Meta data information |
name | string | No | — | The associated name |
visibility | string | No | — | The skillset visibility |
chatbotkit_bots_update_skillset_ability
Update a skillset ability Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillsetId | string | Yes | — | Skillset Id |
abilityId | string | Yes | — | Ability Id |
blueprintId | string | No | — | The ID of the blueprint |
botId | string | No | — | The ID of the bot associated with the ability |
description | string | No | — | The associated description |
fileId | string | No | — | The ID of the file associated with the ability |
instruction | string | No | — | The text to update the ability with |
meta | object | No | — | Meta data information |
name | string | No | — | The associated name |
secretId | string | No | — | The ID of the secret associated with the ability |
spaceId | string | No | — | The ID of the space associated with the ability |

