# Chatbotkit

ChatBotKit is a platform that enables developers to build and manage AI-powered chatbots, offering comprehensive APIs and SDKs for seamless integration into applications.

- **Category:** ai chatbots
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 288
- **Triggers:** 0
- **Slug:** `CHATBOTKIT`
- **Version:** 20260307_00

## Tools

### Attach Dataset File

**Slug:** `CHATBOTKIT_ATTACH_DATASET_FILE`

Tool to attach a file to a dataset as a source. Use when you need to link a specific file to a dataset to provide knowledge content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("source") | Yes | The type of attachment. Must be 'source' to indicate the file is a source for the dataset. |
| `fileId` | string | Yes | The unique identifier of the file to attach to the dataset. |
| `datasetId` | string | Yes | The unique identifier of the dataset to attach the file to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Authenticate Secret

**Slug:** `CHATBOTKIT_AUTHENTICATE_SECRET`

Tool to authenticate a secret by its ID. Use when you need to generate an authentication URL for a specific secret.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secretId` | string | Yes | The ID of the secret to authenticate |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Blueprint

**Slug:** `CHATBOTKIT_CLONE_BLUEPRINT`

Tool to clone an existing blueprint. Use when you need to create a duplicate of a blueprint with all its associated resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blueprintId` | string | Yes | The unique identifier of the blueprint to clone. Use the List Blueprints action to find available blueprint IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Bot

**Slug:** `CHATBOTKIT_CLONE_BOT`

Tool to clone an existing bot. Use when you need to create a duplicate copy of a bot with all its settings and configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | Yes | The unique identifier of the bot to clone. Use the List Bots action to find available bot IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Platform Example

**Slug:** `CHATBOTKIT_CLONE_PLATFORM_EXAMPLE`

Tool to clone a platform example. Use when you need to create instances of all resources defined in a platform example template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `exampleId` | string | Yes | The ID (slug) of the platform example to clone. Use the List Platform Examples action to find available example IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Widget Integration

**Slug:** `CHATBOTKIT_CLONE_WIDGET_INTEGRATION`

Tool to clone an existing widget integration. Use when you need to duplicate a widget integration while preserving its tested configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `widgetIntegrationId` | string | Yes | The unique identifier of the widget integration to clone. Use the List Integrations action to find available widget integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Complete Conversation

**Slug:** `CHATBOTKIT_COMPLETE_CONVERSATION`

Send a message to a ChatBotKit conversation and receive the bot's AI-generated reply. This is the primary action for interacting with a chatbot. It sends user text to an existing conversation and returns the bot's response along with token usage statistics. Prerequisites: - A valid conversation_id (obtain from list_conversations or create_conversation action) - The conversation should have a bot assigned for meaningful responses Returns the AI's reply text, message ID, token usage, and completion reason.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The user's input message to send to the bot. This is the text the AI will respond to. |
| `accept` | string ("application/json" | "application/jsonl") | No | Response format. Leave empty (default) for standard JSON response. Set to 'application/jsonl' for streaming responses with real-time token updates. |
| `conversation_id` | string | Yes | The unique identifier of the conversation to send a message to. Obtain this ID from the list_conversations action or when creating a new conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Blueprint

**Slug:** `CHATBOTKIT_CREATE_BLUEPRINT`

Tool to create a new blueprint in ChatBotKit. Use when you need to create a reusable template or configuration blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the blueprint as key-value pairs. Can contain any flexible properties. |
| `name` | string | No | The associated name for the blueprint. This is the display name that identifies the blueprint. |
| `alias` | string | No | The unique alias for the blueprint instance. Use this to reference the blueprint by a human-readable identifier. |
| `visibility` | string ("private" | "protected" | "public") | No | Visibility options for blueprints. |
| `description` | string | No | The associated description explaining the purpose or contents of this blueprint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Blueprint (GraphQL)

**Slug:** `CHATBOTKIT_CREATE_BLUEPRINT_GRAPHQL`

Tool to create a new blueprint template via GraphQL mutation. Use when you need to create a reusable bot configuration template via the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the blueprint as key-value pairs. Can contain any flexible properties. |
| `name` | string | Yes | The display name for the blueprint. This identifies the blueprint template. |
| `alias` | string | No | A unique human-readable identifier for the blueprint. Use this to reference the blueprint by a memorable alias. |
| `visibility` | string ("private" | "protected" | "public") | No | Visibility options for blueprints. |
| `description` | string | No | Description explaining the purpose or contents of this blueprint template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Bot

**Slug:** `CHATBOTKIT_CREATE_BOT`

Tool to create a new AI bot with configurable settings. Use when you need to create a new chatbot with specific name, personality, model, and connected resources like datasets or skillsets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name for the bot. This is the display name that identifies the bot. |
| `model` | string | No | Language model to use for the bot (e.g., 'gpt-4-turbo', 'gpt-3.5-turbo'). Determines the AI engine powering the bot's responses. |
| `backstory` | string | No | Background context and personality for the bot. This defines the bot's character, knowledge, and how it should behave in conversations. |
| `datasetId` | string | No | ID of the dataset for knowledge retrieval. Connect the bot to a dataset to enable it to answer questions based on specific knowledge. |
| `skillsetId` | string | No | ID of the skillset for abilities. Attach a skillset to provide the bot with specific capabilities or tools. |
| `description` | string | No | Description of the bot. Explains the purpose or role of this bot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Bot (GraphQL)

**Slug:** `CHATBOTKIT_CREATE_BOT_GRAPHQL`

Tool to create a new bot using GraphQL mutation. Use when you need to create a bot with specified name, description, and other configuration via the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name for the bot. This is the display name that identifies the bot. |
| `model` | string | No | Language model to use for the bot (e.g., 'gpt-4-turbo', 'gpt-3.5-turbo'). Determines the AI engine powering the bot's responses. |
| `backstory` | string | No | Background context and personality for the bot. This defines the bot's character, knowledge, and how it should behave in conversations. |
| `datasetId` | string | No | ID of the dataset for knowledge retrieval. Connect the bot to a dataset to enable it to answer questions based on specific knowledge. |
| `skillsetId` | string | No | ID of the skillset for abilities. Attach a skillset to provide the bot with specific capabilities or tools. |
| `description` | string | No | Description of the bot. Explains the purpose or role of this bot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Bot Session

**Slug:** `CHATBOTKIT_CREATE_BOT_SESSION`

Creates a new bot session with an associated conversation and authentication token. Use this when you need to start a new chat session with a bot, optionally with pre-populated messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional metadata key-value pairs for organizing or tagging the session. |
| `botId` | string | Yes | The unique identifier of the bot for this session. Use the List Bots action to find available bot IDs. |
| `messages` | array | No | Optional array of messages to pre-populate the conversation. Each message must have a 'type' and 'text' field. |
| `durationInSeconds` | number | No | The maximum amount of time (in seconds) this session will stay open. Leave empty for default duration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact

**Slug:** `CHATBOTKIT_CREATE_CONTACT`

Tool to create a new contact. Use when you need to track users interacting with bots. Contacts can have associated memories, secrets, and conversations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Custom metadata for the contact. Key-value pairs for storing additional context or tags. |
| `name` | string | No | Name for the contact. A human-readable identifier for the user interacting with your bot. |
| `nick` | string | No | Nickname for the contact. |
| `email` | string | No | Email address of the contact. |
| `phone` | string | No | Phone number of the contact. |
| `verifiedAt` | integer | No | Timestamp (ms) when the contact was verified. |
| `description` | string | No | Description of the contact. Additional information about the contact or their role. |
| `fingerprint` | string | Yes | Unique identifier for the contact. Required field. |
| `preferences` | string | No | Contact preferences. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Conversation

**Slug:** `CHATBOTKIT_CREATE_CONVERSATION`

Tool to create a new conversation. Use when you need to start a new chat session with a bot. Conversations store message history between users and bots. You can either reference an existing bot by ID or configure a new bot inline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the conversation as key-value pairs. |
| `name` | string | No | Name of the conversation for identification and organization purposes. |
| `botId` | string | No | ID of an existing bot to use for this conversation. Use this OR inline bot configuration (model, backstory, etc.), not both. |
| `model` | string | No | Model definition for inline bot configuration. Specify the AI model to use (e.g., 'gpt-3.5-turbo', 'gpt-4'). Only used if botId is not provided. |
| `taskId` | string | No | ID of a task to associate with this conversation. |
| `privacy` | boolean | No | Privacy flag. Set to true to enable privacy mode for this conversation. |
| `spaceId` | string | No | ID of a space to associate with this conversation for organization. |
| `messages` | array | No | Initial messages to seed the conversation with. Each message must have a type and text. |
| `backstory` | string | No | Bot backstory for inline bot configuration. Sets the bot's personality and context. Only used if botId is not provided. |
| `contactId` | string | No | ID of a contact to associate with this conversation. |
| `datasetId` | string | No | ID of a dataset to associate with the conversation for knowledge retrieval. |
| `moderation` | boolean | No | Moderation flag. Set to true to enable content moderation for this conversation. |
| `skillsetId` | string | No | ID of a skillset to associate with the conversation for enhanced capabilities. |
| `description` | string | No | A description explaining the purpose or context of this conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create conversation message

**Slug:** `CHATBOTKIT_CREATE_CONVERSATION_MESSAGE`

Tool to create a new message in an existing conversation. Use this to add user messages, bot messages, or other message types to a conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional metadata object for storing additional custom information about this message. |
| `name` | string | No | Optional name associated with this message. |
| `text` | string | Yes | The text content of the message to create. |
| `type` | string ("user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity") | Yes | The type of message to create. 'user' for user messages, 'bot' for bot responses, 'context' for contextual information, 'instruction' for instructions, 'backstory' for background information, 'reasoning' for reasoning steps, 'activity' for activity logs. |
| `entities` | array | No | Optional array of known entities to associate with this message. Entities are structured data extracted from the message text. |
| `description` | string | No | Optional description for this message. |
| `conversationId` | string | Yes | The unique identifier of the conversation to add the message to. Obtain this from list_conversations or when creating a new conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create conversation message batch

**Slug:** `CHATBOTKIT_CREATE_CONVERSATION_MESSAGE_BATCH`

Tool to create multiple messages in a conversation in a single batch operation. Use this when you need to add multiple messages at once, which is more efficient than creating them individually.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Array of message items to create in batch. Each item must have a type and text field. |
| `conversationId` | string | Yes | The unique identifier of the conversation to add the messages to. Obtain this from list_conversations or when creating a new conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Conversation Session

**Slug:** `CHATBOTKIT_CREATE_CONVERSATION_SESSION`

Tool to create a new conversation session with an authentication token. Use when you need to generate a temporary access token for a conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversationId` | string | Yes | The unique identifier of the conversation. Use the Create Conversation or List Conversations action to find conversation IDs. |
| `durationInSeconds` | number | No | The maximum amount of time (in seconds) this session will stay open. Leave empty for default duration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dataset (GraphQL)

**Slug:** `CHATBOTKIT_CREATE_DATASET_GRAPHQL`

Tool to create a new dataset using GraphQL mutation. Use when you need to create a dataset to store knowledge and information for bots.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Custom metadata to associate with the dataset as key-value pairs. |
| `name` | string | No | Name of the dataset. This is the display name that identifies the dataset. |
| `alias` | string | No | Unique alias identifier for the dataset. Used for programmatic access. |
| `store` | string | No | The storage backend to use for the dataset (e.g., 'ada-loom'). |
| `reranker` | string | No | The reranker model to use for search results (e.g., 'bge-v2-m3'). |
| `separators` | string | No | Separators used for chunking text in the dataset. |
| `visibility` | string | No | Visibility setting for the dataset. Controls access permissions. |
| `blueprintId` | string | No | ID of the blueprint to associate with this dataset. |
| `description` | string | No | Description of the dataset's purpose and contents. |
| `searchMinScore` | number | No | Minimum similarity score threshold for search results (0.0 to 1.0). |
| `recordMaxTokens` | integer | No | Maximum number of tokens per record in the dataset. |
| `searchMaxTokens` | integer | No | Maximum number of tokens to return in search results. |
| `matchInstruction` | string | No | Instruction to display or apply when a match is found in the dataset. |
| `searchMaxRecords` | integer | No | Maximum number of records to return in search results. |
| `mismatchInstruction` | string | No | Instruction to display or apply when no match is found in the dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dataset Record

**Slug:** `CHATBOTKIT_CREATE_DATASET_RECORD`

Tool to create a new record in a dataset. Use when you need to add text data to an existing dataset for knowledge retrieval by bots.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional metadata object for storing additional custom information about this record. |
| `text` | string | Yes | The text content of the record to create. This is the main data that will be stored in the dataset. |
| `source` | string | No | Optional source identifier for the record. Use to track where the record originated from. |
| `datasetId` | string | Yes | The unique identifier of the dataset to add the record to. Obtain this from list_datasets or when creating a dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discord Integration

**Slug:** `CHATBOTKIT_CREATE_DISCORD_INTEGRATION`

Tool to create a Discord integration for a ChatBotKit bot. Use when you need to connect a bot to Discord by providing Discord Application ID, Bot Token, and Public Key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | Discord Application ID from Discord Developer Portal General Information section. |
| `botId` | string | Yes | Reference to an existing bot ID - must be a valid bot that exists in the account. Use the List Bots action to find available bot IDs. |
| `handle` | string | No | Optional slash command handle for the bot (default is /discord). |
| `botToken` | string | Yes | Discord Bot Token obtained from Bot section in Discord Developer Portal. |
| `publicKey` | string | Yes | Discord Public Key from Discord Developer Portal General Information section. |
| `sessionDuration` | integer | No | Optional session duration in seconds. |
| `contactCollection` | boolean | No | Optional flag to enable contact collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Integration

**Slug:** `CHATBOTKIT_CREATE_EMAIL_INTEGRATION`

Tool to create a new email integration for a ChatBotKit bot. Email integrations enable your bot to receive and respond to emails, making it accessible through email communication channels. Use when you need to connect a bot to handle email-based conversations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the email integration. A human-readable identifier for this integration. |
| `botId` | string | Yes | The ID of the bot to associate with this email integration. Use the List Bots action to find available bot IDs. |
| `attachments` | boolean | No | Whether to enable attachments for the email integration. When enabled, the bot can receive and process email attachments. |
| `blueprintId` | string | No | The ID of the blueprint to use for this email integration. Blueprints provide template configurations. |
| `description` | string | No | Description of the email integration. Explains the purpose or function of this integration. |
| `sessionDuration` | integer | No | Session duration in seconds. Defines how long a conversation session remains active before timing out. |
| `contactCollection` | boolean | No | Whether to enable contact collection. When enabled, the integration will collect and store contact information from email interactions. |
| `allowedSenderEmails` | string | No | Allowed sender emails for the integration. Comma-separated list of email addresses that are permitted to send emails to this integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Extract Integration

**Slug:** `CHATBOTKIT_CREATE_EXTRACT_INTEGRATION`

Tool to create a new Extract integration for a ChatBotKit bot. Extract integrations enable your chatbot to automatically pull and extract structured data from conversations based on a predefined JSON schema. Use when you need to capture specific information from user interactions and optionally send it to a webhook endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | A human-readable name for the Extract integration. |
| `botId` | string | Yes | The unique identifier of the bot to attach this Extract integration to. Use the List Bots action to find available bot IDs. |
| `model` | string | No | Optional AI model to use for data extraction. If not specified, uses the default model. |
| `schema` | object | Yes | A JSON schema object defining the structure of data to extract from conversations. Each key is a field name, with 'type' and 'description' properties defining that field. |
| `request` | string | No | Optional webhook URL or request configuration where extracted data will be sent. Can be a simple URL string or a detailed request configuration. |
| `blueprintId` | string | No | Optional ID of the blueprint to associate with this integration. |
| `description` | string | No | Optional description explaining the purpose of this Extract integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create File

**Slug:** `CHATBOTKIT_CREATE_FILE`

Tool to create a new file resource in ChatBotKit. Use when you need to create a file that can be attached to datasets for processing and indexing. Note: This creates the file record; use the upload action to add actual file content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Custom metadata object for storing additional file-specific information as key-value pairs. |
| `name` | string | No | A descriptive name for the file. This helps identify the file in listings. |
| `visibility` | string | No | Access control setting for the file. Use 'private' for restricted access (default) or 'public' for publicly accessible files. |
| `blueprintId` | string | No | Associate the file with a blueprint resource. Provide the blueprint ID to link this file. |
| `description` | string | No | Detailed information about the file's purpose and contents. Use this to document what the file is for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Instagram Integration

**Slug:** `CHATBOTKIT_CREATE_INSTAGRAM_INTEGRATION`

Tool to create an Instagram integration for a ChatBotKit bot. Use when you need to connect a bot to Instagram by providing an Instagram access token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional additional metadata as key-value pairs for organizing or tagging the integration. |
| `name` | string | No | Optional human-readable name for the Instagram integration. |
| `botId` | string | Yes | The ID of the bot this integration is using. Use the List Bots action to find available bot IDs. |
| `accessToken` | string | Yes | Instagram access token for authentication. This token is used to authenticate with Instagram's API. |
| `attachments` | boolean | No | Optional flag to enable attachments support in Instagram conversations. |
| `blueprintId` | string | No | Optional ID of the blueprint to use for this integration. |
| `description` | string | No | Optional description explaining the purpose of this integration. |
| `sessionDuration` | integer | No | Optional session duration in seconds. Defines how long a conversation session remains active. |
| `contactCollection` | boolean | No | Optional flag to enable contact collection from Instagram conversations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Support Integration

**Slug:** `CHATBOTKIT_CREATE_INTEGRATION`

Creates a new support integration for a ChatBotKit bot. Support integrations enable your chatbot to handle customer support inquiries and optionally forward conversation summaries to a specified email address. Use this when you need to connect a bot to your customer support workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | Yes | A human-readable name for the support integration. |
| `botId` | string | Yes | The unique identifier of the bot to attach this support integration to. Use the List Bots action to find available bot IDs. |
| `email` | string | No | Optional email address where conversation summaries and customer inquiries will be forwarded (e.g., your support team's inbox). |
| `description` | string | No | Optional description explaining the purpose of this integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create MCP Server Integration

**Slug:** `CHATBOTKIT_CREATE_MCPSERVER_INTEGRATION`

Tool to create a new MCP Server integration for ChatBotKit. Use when you need to set up an MCP (Model Context Protocol) Server integration to extend bot capabilities with custom server-side functionality.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional metadata for the integration. Key-value pairs for organizing or tagging the integration. |
| `name` | string | Yes | The name of the MCP Server integration. A human-readable identifier for this integration. |
| `skillsetId` | string | No | Optional skillset ID to associate with the integration. Use the List Skillsets action to find available skillset IDs. |
| `blueprintId` | string | No | Optional blueprint ID to associate with the integration. Blueprints provide template configurations. |
| `description` | string | No | A description of the MCP Server integration. Explains the purpose or function of this integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Memory

**Slug:** `CHATBOTKIT_CREATE_MEMORY`

Tool to create a new memory entry. Use when you need to store information for later retrieval, such as user preferences, conversation context, or important facts associated with a bot or contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Custom metadata for the memory. Key-value pairs for storing additional context or tags. |
| `name` | string | No | Name for the memory. A human-readable identifier for this memory entry. |
| `text` | string | No | The text content of the memory. This is the main content that will be stored and recalled later. |
| `botId` | string | No | ID of the bot to associate this memory with. If provided, the memory will be specific to this bot. |
| `contactId` | string | No | ID of the contact to associate this memory with. If provided, the memory will be specific to this contact. |
| `description` | string | No | Description of the memory. Additional context or categorization for the memory. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Messenger Integration

**Slug:** `CHATBOTKIT_CREATE_MESSENGER_INTEGRATION`

Tool to create a Facebook Messenger integration for a ChatBotKit bot. Use when you need to connect a bot to Facebook Messenger by providing a Facebook Page Access Token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional additional metadata as key-value pairs for organizing or tagging the integration. |
| `name` | string | No | Optional human-readable name for the Messenger integration. |
| `botId` | string | Yes | Reference to an existing bot ID - must be a valid bot that exists in the account. Use the List Bots action to find available bot IDs. |
| `accessToken` | string | Yes | Facebook Page Access Token from Facebook Developer Portal. Required for authenticating with Facebook Messenger API. |
| `attachments` | boolean | No | Optional flag to enable support for attachments in Messenger conversations. |
| `blueprintId` | string | No | Optional ID of the blueprint to use for this integration. |
| `description` | string | No | Optional description explaining the purpose of this integration. |
| `sessionDuration` | integer | No | Optional session duration in milliseconds. Defines how long a conversation session remains active (default: 24 hours or 86400000 milliseconds). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notion Integration

**Slug:** `CHATBOTKIT_CREATE_NOTION_INTEGRATION`

Tool to create a Notion integration for a ChatBotKit dataset. Use when you need to connect a dataset to Notion for syncing content between Notion pages and ChatBotKit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | The Notion API token for authentication. Obtain this from Notion's integration settings. |
| `datasetId` | string | Yes | The dataset ID to connect the Notion integration to. Use the List Datasets action to find available dataset IDs. |
| `expiresIn` | integer | No | Optional record expiration time in milliseconds. Records will be automatically deleted after this duration. |
| `description` | string | No | Optional description for the integration to help identify its purpose. |
| `syncSchedule` | string ("never" | "daily" | "weekly" | "monthly") | No | Sync frequency options for Notion integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Rating

**Slug:** `CHATBOTKIT_CREATE_RATING`

Tool to create a rating in ChatBotKit. Use when you need to submit a numeric rating value for tracking purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | integer | Yes | The rating value (numeric). Represents the rating score to be created. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Secret

**Slug:** `CHATBOTKIT_CREATE_SECRET`

Tool to create a new secret in ChatBotKit. Secrets store credentials that bots use to access external services via skillset abilities. Use when you need to securely store API keys, tokens, or other authentication credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string ("shared" | "personal") | Yes | Storage type: 'shared' means platform-stored (accessible across the organization), 'personal' means user-stored (accessible only to the user who created it). |
| `name` | string | Yes | Identifier for the secret. This is the display name that identifies the secret. |
| `type` | string ("plain" | "basic" | "bearer" | "oauth" | "template") | Yes | Authentication method type: 'plain' for plain text, 'basic' for HTTP basic auth, 'bearer' for bearer tokens, 'oauth' for OAuth credentials, or 'template' for custom templates. |
| `value` | string | No | The actual credential data (e.g., API key, token, password). Required for 'shared' secrets (will be encrypted at rest). Must NOT be provided for 'personal' secrets (user provides at runtime). |
| `visibility` | string ("private" | "public") | No | Access control level for the secret |
| `description` | string | No | Description of the secret. Explains what this secret is used for or which service it authenticates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Secret (GraphQL)

**Slug:** `CHATBOTKIT_CREATE_SECRET_GRAPHQL`

Tool to create a new secret via GraphQL mutation. Use when you need to securely store credentials, API keys, or authentication tokens via the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string ("shared" | "personal") | Yes | Whether the secret is shared across the organization or personal to the user: 'shared' means platform-stored (accessible across the organization), 'personal' means user-stored (accessible only to the user who created it). |
| `name` | string | Yes | A reference identifier for the secret. This is the display name that identifies the secret. |
| `type` | string ("plain" | "basic" | "bearer" | "oauth" | "template") | Yes | The authentication mechanism for this secret: 'plain' for plain text, 'basic' for HTTP basic auth, 'bearer' for bearer tokens, 'oauth' for OAuth credentials, or 'template' for custom templates. |
| `value` | string | No | The actual credential data (e.g., API key, token, password). Required for 'shared' secrets, must be omitted for 'personal' secrets (user provides at runtime). This will be encrypted at rest by ChatBotKit. |
| `visibility` | string ("private" | "public") | Yes | Access control level for the secret: 'private' restricts access to the owner, 'public' allows broader access within the organization. |
| `description` | string | No | Optional description for the secret. Explains the purpose or usage of this credential. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Sitemap Integration

**Slug:** `CHATBOTKIT_CREATE_SITEMAP_INTEGRATION`

Tool to create a sitemap integration for a ChatBotKit dataset. Sitemap integrations automatically crawl and index website content from a sitemap.xml file, keeping your dataset synchronized with your website content. Use when you need to import or sync website content into a dataset for bot knowledge.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The sitemap URL to integrate. Must be a valid sitemap.xml URL that the system can crawl to extract pages for the dataset. |
| `glob` | string | No | Pattern for filtering URLs from the sitemap. Use glob patterns to include or exclude specific URL patterns (e.g., '/blog/**' to only include blog pages). |
| `name` | string | No | Name of the sitemap integration. A human-readable identifier for this integration. |
| `datasetId` | string | Yes | The ID of the dataset to associate with this sitemap integration. Use the List Datasets action to find available dataset IDs. |
| `expiresIn` | integer | No | Expiration time in seconds. Defines how long the integration remains active before expiring. |
| `selectors` | string | No | CSS selectors for content extraction. Specify which parts of the page to extract (e.g., 'article', '.content', '#main'). Leave empty to extract all content. |
| `javascript` | boolean | No | Whether to enable JavaScript rendering when crawling pages. Enable this if the website content is dynamically loaded via JavaScript. |
| `description` | string | No | Description of the sitemap integration. Explains the purpose or function of this integration. |
| `syncSchedule` | string | No | Schedule for syncing the sitemap. Defines how frequently the system should re-crawl the sitemap to update the dataset with new or changed content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Skillset

**Slug:** `CHATBOTKIT_CREATE_SKILLSET`

Tool to create a new skillset. Use when you need to group multiple skills into a single reusable unit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the skillset as key-value pairs. |
| `name` | string | Yes | Name of the skillset. This is the display name that identifies the skillset. |
| `visibility` | string | No | Visibility setting for the skillset. Controls who can access this skillset. |
| `description` | string | No | A description explaining the purpose or contents of this skillset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Slack Integration

**Slug:** `CHATBOTKIT_CREATE_SLACK_INTEGRATION`

Tool to create a Slack integration for a ChatBotKit bot. Use when you need to connect a bot to Slack by providing signing secret and bot token from Slack Developer Portal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | Optional name for the Slack integration. |
| `botId` | string | No | Reference to an existing bot ID - must be a valid bot that exists in the account. Use the List Bots action to find available bot IDs. |
| `ratings` | boolean | No | Whether to enable ratings feature allowing users to rate bot responses. |
| `botToken` | string | No | The Slack Bot User OAuth Token from OAuth & Permissions page. Required for bot functionality. |
| `userToken` | string | No | Slack user token for additional permissions beyond bot token capabilities. |
| `references` | boolean | No | Whether to enable references feature for providing source citations. |
| `autoRespond` | string | No | Auto-respond configuration for the Slack integration. Determines when the bot responds to messages. |
| `description` | string | No | Optional description explaining the purpose of this integration. |
| `signingSecret` | string | No | The Slack signing secret from your Slack App's Basic Information section. Used to verify requests from Slack. |
| `sessionDuration` | integer | No | Session duration in seconds. Defines how long a conversation session remains active. |
| `visibleMessages` | integer | No | Number of visible messages to display in the conversation history. Maximum value is 10. |
| `contactCollection` | boolean | No | Whether to enable contact collection for tracking user interactions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Space

**Slug:** `CHATBOTKIT_CREATE_SPACE`

Tool to create a new space in ChatBotKit. Use when you need to create a workspace or organizational container for related resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the space. This is the display name that identifies the space. |
| `contactId` | string | No | Optional contact ID to associate with the space. Links the space to a specific contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Task

**Slug:** `CHATBOTKIT_CREATE_TASK`

Tool to create a new background task that can be triggered to perform automated operations. Use when you need to set up scheduled or on-demand tasks with configurable bot and contact associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name for the task. This is the display name that identifies the task. |
| `botId` | string | No | Bot ID to associate with this task. The bot will execute the task when triggered. |
| `maxTime` | number | No | Maximum time allowed for this task execution (in seconds or milliseconds). Prevents tasks from running indefinitely. |
| `schedule` | string | No | Schedule for the task using cron expression format (e.g., '0 9 * * *' for 9 AM daily). Defines when the task should run automatically. |
| `contactId` | string | No | Contact ID to associate with this task. Links the task to a specific contact. |
| `description` | string | No | Description of the task. Explains the purpose or what the task will do. |
| `maxIterations` | number | No | Maximum number of iterations allowed for this task execution. Controls how many times the task can loop or retry. |
| `sessionDuration` | number | No | Session duration for the task (in seconds). Defines how long the task session should remain active. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Telegram Integration

**Slug:** `CHATBOTKIT_CREATE_TELEGRAM_INTEGRATION`

Tool to create a Telegram integration for a ChatBotKit bot. Use when you need to connect a bot to Telegram by providing a Telegram bot token from BotFather.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional human-readable name for the Telegram integration. |
| `botId` | string | Yes | Reference to an existing bot ID - must be a valid bot that exists in the account. Use the List Bots action to find available bot IDs. |
| `botToken` | string | Yes | The Telegram bot token obtained from BotFather. Required for authenticating with Telegram Bot API. |
| `attachments` | boolean | No | Optional flag to enable support for attachments in Telegram conversations. |
| `description` | string | No | Optional description explaining the purpose of this integration. |
| `sessionDuration` | integer | No | Optional session duration in milliseconds. Defines how long a conversation session remains active (default: 24 hours or 86400000 milliseconds). |
| `contactCollection` | boolean | No | Optional flag to enable contact information collection from Telegram users. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Trigger Integration

**Slug:** `CHATBOTKIT_CREATE_TRIGGER_INTEGRATION`

Tool to create a Trigger integration for a ChatBotKit bot. Use when you need to set up automated triggers that can process events and execute bot actions on a schedule or based on specific conditions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | A descriptive name for the trigger integration. |
| `botId` | string | Yes | The identifier of the bot that will process the trigger events. Use the List Bots action to find available bot IDs. |
| `maxTime` | integer | No | Maximum time for execution in milliseconds. |
| `description` | string | No | A description of what the trigger handles. |
| `authenticate` | boolean | No | Boolean to enable/disable authentication. |
| `maxIterations` | integer | No | Maximum number of iterations. |
| `sessionDuration` | integer | No | The duration for sessions in milliseconds. |
| `triggerSchedule` | object | No | Schedule configuration for the trigger. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Twilio Integration

**Slug:** `CHATBOTKIT_CREATE_TWILIO_INTEGRATION`

Tool to create a Twilio integration for a ChatBotKit bot. Use when you need to connect a bot to Twilio for SMS or messaging capabilities. All parameters are optional.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | No | Reference to an existing bot ID. Use the List Bots action to find available bot IDs. Optional: if not provided, a default bot configuration will be used. |
| `sessionDuration` | integer | No | Optional session duration in seconds. Defines how long a conversation session remains active before timing out. |
| `contactCollection` | boolean | No | Optional flag to enable contact collection. When enabled, the integration will collect and store contact information from Twilio interactions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create WhatsApp Integration

**Slug:** `CHATBOTKIT_CREATE_WHATS_APP_INTEGRATION`

Creates a new WhatsApp integration for a ChatBotKit bot. WhatsApp integrations enable your chatbot to communicate with users through WhatsApp messaging. Use this when you need to connect a bot to WhatsApp Business API for customer engagement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | Yes | A human-readable name for the WhatsApp integration. |
| `botId` | string | No | Optional unique identifier of the bot to attach this WhatsApp integration to. Use the List Bots action to find available bot IDs. |
| `accessToken` | string | No | WhatsApp access token for authenticating API requests to Meta's WhatsApp Business API. |
| `attachments` | boolean | No | Enable support for sending and receiving attachments (images, documents, etc.) through WhatsApp. |
| `blueprintId` | string | No | Optional unique identifier of the blueprint to use for this integration. |
| `description` | string | No | Optional description explaining the purpose of this integration. |
| `phoneNumberId` | string | No | WhatsApp phone number ID assigned by Meta for your WhatsApp Business account. |
| `sessionDuration` | number | No | Duration in seconds for which a conversation session remains active. After this period, a new session will be created. |
| `contactCollection` | boolean | No | Enable collection of contact information from WhatsApp users during conversations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Widget Integration

**Slug:** `CHATBOTKIT_CREATE_WIDGET_INTEGRATION`

Tool to create a Widget integration for a ChatBotKit bot. Use when you need to create a web widget that can be embedded on websites to enable conversations with a bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form` | boolean | No | Enable form functionality in the widget. |
| `math` | boolean | No | Enable mathematical notation rendering in the widget. |
| `botId` | string | Yes | The unique identifier of the bot to associate with this widget integration. Use the List Bots action to find available bot IDs. |
| `intro` | string | No | Introduction text to display in the widget. |
| `theme` | string | No | Theme for the widget appearance. |
| `title` | string | No | Title to display in the widget header. |
| `tools` | boolean | No | Enable tools functionality in the widget. |
| `layout` | string | No | Layout style for the widget. |
| `origin` | string | No | Origin URL where the widget is allowed to be embedded. |
| `stream` | boolean | No | Enable streaming responses in the widget. |
| `unfurl` | boolean | No | Enable link unfurling in messages. |
| `initial` | string | No | Initial message to display when the widget loads. |
| `plugins` | string | No | Plugins configuration for the widget. |
| `verbose` | boolean | No | Enable verbose mode for detailed logging. |
| `voiceIn` | boolean | No | Enable voice input in the widget. |
| `carousel` | boolean | No | Enable carousel display for messages in the widget. |
| `language` | string | No | Language code for the widget interface. |
| `maximize` | boolean | No | Start the widget in maximized mode. |
| `voiceOut` | boolean | No | Enable voice output in the widget. |
| `poweredBy` | boolean | No | Display 'Powered by ChatBotKit' branding in the widget. |
| `autoScroll` | boolean | No | Enable auto-scrolling to the latest message in the widget. |
| `startFirst` | boolean | No | Start the conversation immediately when the widget loads. |
| `attachments` | boolean | No | Enable file attachments in the widget. |
| `messagePeek` | boolean | No | Enable message peek functionality. |
| `placeholder` | string | No | Placeholder text for the message input field. |
| `sessionDuration` | number | No | Session duration in seconds. |
| `contactCollection` | boolean | No | Enable collection of contact information from users. |
| `exportConversation` | boolean | No | Enable users to export their conversation history. |
| `restartConversation` | boolean | No | Enable users to restart the conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Widget Integration Session

**Slug:** `CHATBOTKIT_CREATE_WIDGET_INTEGRATION_SESSION`

Creates a new widget integration session for interactive chat. Use this when you need to initialize a widget chat session with optional contact information, initial messages, and custom session duration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Custom metadata key-value pairs for tracking and analytics purposes |
| `contact` | object | No | Contact information for a widget session user. |
| `messages` | array | No | Array of initial user messages to seed the conversation (only 'user' type messages allowed) |
| `durationInSeconds` | integer | No | Session validity duration in seconds. Must be between 1,800 and 86,400 seconds. Defaults to widget's configured duration if not specified. |
| `widget_integration_id` | string | Yes | The ID of the widget integration. Use the List Widget Integrations action to find available widget integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Blueprint

**Slug:** `CHATBOTKIT_DELETE_BLUEPRINT`

Tool to permanently delete a blueprint from ChatBotKit. Use when you need to remove a blueprint and optionally its associated resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blueprintId` | string | Yes | The unique identifier of the blueprint to delete. This is the ID of the blueprint you want to remove. |
| `deleteResources` | boolean | No | If true, deletes all resources associated with the blueprint. If false or omitted, only the blueprint itself is deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Blueprint (GraphQL)

**Slug:** `CHATBOTKIT_DELETE_BLUEPRINT_GRAPHQL`

Tool to permanently delete a blueprint template via GraphQL mutation. Use when you need to remove a blueprint from the platform using the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blueprintId` | string | Yes | The unique identifier of the blueprint to delete. This is the ID of the blueprint template you want to permanently remove from the platform. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Bot

**Slug:** `CHATBOTKIT_DELETE_BOT`

Tool to delete a bot. Use when you need to permanently remove a bot from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | Yes | The ID of the bot to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Bot (GraphQL)

**Slug:** `CHATBOTKIT_DELETE_BOT_GRAPHQL`

Tool to delete a bot via GraphQL mutation. Use when you need to permanently remove a bot from the system using the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | Yes | The ID of the bot to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact

**Slug:** `CHATBOTKIT_DELETE_CONTACT`

Tool to permanently delete a contact from ChatBotKit. Use when you need to remove a contact from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | string | Yes | The unique identifier of the contact to delete. Obtain this ID from the list_contacts action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Conversation

**Slug:** `CHATBOTKIT_DELETE_CONVERSATION`

Tool to permanently delete a conversation from ChatBotKit. Use when you need to remove a conversation and all its associated messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversationId` | string | Yes | The unique identifier of the conversation to delete. Obtain this ID from the list_conversations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Conversation Message

**Slug:** `CHATBOTKIT_DELETE_CONVERSATION_MESSAGE`

Tool to permanently delete a message from a conversation in ChatBotKit. Use when you need to remove a specific message from a conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messageId` | string | Yes | The unique identifier of the message to delete. Obtain this from list_conversation_messages. |
| `conversationId` | string | Yes | The unique identifier of the conversation containing the message. Obtain this from list_conversations or when creating a conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Dataset

**Slug:** `CHATBOTKIT_DELETE_DATASET`

Tool to permanently delete a dataset from ChatBotKit. Use when you need to remove a dataset and all its associated data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `datasetId` | string | Yes | The unique identifier of the dataset to delete. Obtain this ID from the list_datasets action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Dataset (GraphQL)

**Slug:** `CHATBOTKIT_DELETE_DATASET_GRAPHQL`

Tool to delete a dataset via GraphQL mutation. Use when you need to permanently remove a dataset and all its associated records using the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `datasetId` | string | Yes | The ID of the dataset to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Dataset Record

**Slug:** `CHATBOTKIT_DELETE_DATASET_RECORD`

Tool to permanently delete a record from a dataset. Use when you need to remove a specific record from a ChatBotKit dataset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `recordId` | string | Yes | The unique identifier of the record to delete from the dataset. |
| `datasetId` | string | Yes | The unique identifier of the dataset containing the record. Obtain this ID from the list_datasets action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Discord Integration

**Slug:** `CHATBOTKIT_DELETE_DISCORD_INTEGRATION`

Tool to delete a Discord integration. Use when you need to permanently remove a Discord integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discordIntegrationId` | string | Yes | The ID of the Discord integration to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email Integration

**Slug:** `CHATBOTKIT_DELETE_EMAIL_INTEGRATION`

Tool to permanently delete an Email integration from ChatBotKit. Use when you need to remove an Email integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emailIntegrationId` | string | Yes | The unique identifier of the Email integration to delete. Obtain this ID from the list_integrations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Extract Integration

**Slug:** `CHATBOTKIT_DELETE_EXTRACT_INTEGRATION`

Tool to delete an Extract integration. Use when you need to permanently remove an Extract integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extractIntegrationId` | string | Yes | The ID of the Extract integration to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete File

**Slug:** `CHATBOTKIT_DELETE_FILE`

Tool to permanently delete a file from ChatBotKit. Use when you need to remove a file from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileId` | string | Yes | The unique identifier of the file to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Instagram Integration

**Slug:** `CHATBOTKIT_DELETE_INSTAGRAM_INTEGRATION`

Tool to permanently delete an Instagram integration from ChatBotKit. Use when you need to remove an Instagram integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `instagramIntegrationId` | string | Yes | The unique identifier of the Instagram integration to delete. Obtain this ID from the list_integrations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Integration (GraphQL)

**Slug:** `CHATBOTKIT_DELETE_INTEGRATION_GRAPHQL`

Tool to delete an integration via GraphQL mutation. Use when you need to permanently remove an integration from the system using the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `integration_id` | string | Yes | The unique identifier of the integration to delete. Obtain this ID from the list_integrations action. |
| `integration_type` | string ("email" | "slack" | "discord" | "notion" | "twilio" | "messenger" | "telegram" | "whatsapp" | "instagram" | "sitemap" | "trigger" | "extract" | "mcpserver") | Yes | The type of integration to delete (e.g., email, slack, discord, notion, twilio, messenger, telegram, whatsapp, instagram, sitemap, trigger, extract, mcpserver) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete MCP Server Integration

**Slug:** `CHATBOTKIT_DELETE_MCP_SERVER_INTEGRATION`

Tool to delete an MCP Server integration. Use when you need to permanently remove an MCP Server integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mcpserverIntegrationId` | string | Yes | The ID of the MCP Server integration to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Memory

**Slug:** `CHATBOTKIT_DELETE_MEMORY`

Tool to permanently delete a memory from ChatBotKit. Use when you need to remove a memory from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `memoryId` | string | Yes | The unique identifier of the memory to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Messenger Integration

**Slug:** `CHATBOTKIT_DELETE_MESSENGER_INTEGRATION`

Tool to permanently delete a Messenger integration from ChatBotKit. Use when you need to remove a Messenger integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messengerIntegrationId` | string | Yes | The unique identifier of the Messenger integration to delete. Obtain this ID from the list_integrations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Notion Integration

**Slug:** `CHATBOTKIT_DELETE_NOTION_INTEGRATION`

Tool to permanently delete a Notion integration from ChatBotKit. Use when you need to remove a Notion integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notionIntegrationId` | string | Yes | The unique identifier of the Notion integration to delete. Obtain this ID from the list_integrations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Partner User

**Slug:** `CHATBOTKIT_DELETE_PARTNER_USER`

Tool to permanently delete a partner user account. Use when you need to clean up test or inactive accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `userId` | string | Yes | The unique identifier of the partner user to delete. This permanently removes the user account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Rating

**Slug:** `CHATBOTKIT_DELETE_RATING`

Tool to permanently delete a rating from ChatBotKit. Use when you need to remove a rating from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ratingId` | string | Yes | The unique identifier of the rating to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Secret

**Slug:** `CHATBOTKIT_DELETE_SECRET`

Tool to permanently delete a secret from ChatBotKit. Use when you need to remove a secret from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secretId` | string | Yes | The unique identifier of the secret to delete. This ID can be obtained from secret-related actions like listing secrets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Sitemap Integration

**Slug:** `CHATBOTKIT_DELETE_SITEMAP_INTEGRATION`

Tool to permanently delete a Sitemap integration from ChatBotKit. Use when you need to remove a Sitemap integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sitemapIntegrationId` | string | Yes | The unique identifier of the Sitemap integration to delete. Obtain this ID from the list_integrations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Skillset

**Slug:** `CHATBOTKIT_DELETE_SKILLSET`

Tool to delete a skillset. Use when you need to permanently remove a skillset from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skillsetId` | string | Yes | The ID of the skillset to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Skillset Ability

**Slug:** `CHATBOTKIT_DELETE_SKILLSET_ABILITY`

Tool to delete an ability from a skillset. Use when you need to remove a specific ability from a skillset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `abilityId` | string | Yes | The ID of the ability to delete from the skillset |
| `skillsetId` | string | Yes | The ID of the skillset containing the ability to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Slack Integration

**Slug:** `CHATBOTKIT_DELETE_SLACK_INTEGRATION`

Tool to delete a Slack integration. Use when you need to permanently remove a Slack integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `slackIntegrationId` | string | Yes | The ID of the Slack integration to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Space

**Slug:** `CHATBOTKIT_DELETE_SPACE`

Tool to permanently delete a space from ChatBotKit. Use when you need to remove a space from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `spaceId` | string | Yes | The ID of the space to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Support Integration

**Slug:** `CHATBOTKIT_DELETE_SUPPORT_INTEGRATION`

Tool to delete a Support integration. Use when you need to permanently remove a Support integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `supportIntegrationId` | string | Yes | The ID of the Support integration to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Task

**Slug:** `CHATBOTKIT_DELETE_TASK`

Tool to permanently delete a task from ChatBotKit. Use when you need to remove a task from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | string | Yes | The unique identifier of the task to delete. Obtain this ID from the list_tasks action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Telegram Integration

**Slug:** `CHATBOTKIT_DELETE_TELEGRAM_INTEGRATION`

Tool to permanently delete a Telegram integration from ChatBotKit. Use when you need to remove a Telegram integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `telegramIntegrationId` | string | Yes | The unique identifier of the Telegram integration to delete. Obtain this ID from the list_integrations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Trigger Integration

**Slug:** `CHATBOTKIT_DELETE_TRIGGER_INTEGRATION`

Tool to permanently delete a Trigger integration from ChatBotKit. Use when you need to remove a Trigger integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `triggerIntegrationId` | string | Yes | The ID of the Trigger integration to delete. Obtain this ID from the list_integrations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Twilio Integration

**Slug:** `CHATBOTKIT_DELETE_TWILIO_INTEGRATION`

Tool to delete a Twilio integration. Use when you need to permanently remove a Twilio integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `twilioIntegrationId` | string | Yes | The ID of the Twilio integration to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete WhatsApp Integration

**Slug:** `CHATBOTKIT_DELETE_WHATS_APP_INTEGRATION`

Tool to permanently delete a WhatsApp integration from ChatBotKit. Use when you need to remove a WhatsApp integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `whatsappIntegrationId` | string | Yes | The unique identifier of the WhatsApp integration to delete. Obtain this ID from the list_integrations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Widget Integration

**Slug:** `CHATBOTKIT_DELETE_WIDGET_INTEGRATION`

Tool to delete a Widget integration. Use when you need to permanently remove a Widget integration from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `widgetIntegrationId` | string | Yes | The ID of the Widget integration to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach Dataset File

**Slug:** `CHATBOTKIT_DETACH_DATASET_FILE`

Tool to detach a file from a dataset. Use when you need to remove a file's association with a dataset, optionally deleting its records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileId` | string | Yes | The ID of the file to detach from the dataset |
| `datasetId` | string | Yes | The ID of the dataset from which to detach the file |
| `deleteRecords` | boolean | No | Delete records associated with the file. When true, all records created from this file will be removed from the dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download File

**Slug:** `CHATBOTKIT_DOWNLOAD_FILE`

Tool to download a file by its ID. Use when you need to retrieve a file's content from ChatBotKit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileId` | string | Yes | The ID of the file to download |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Downvote Bot

**Slug:** `CHATBOTKIT_DOWNVOTE_BOT`

Tool to downvote a bot in ChatBotKit. Use when you need to register negative feedback on a bot's performance or quality.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | Yes | The unique identifier of the bot to downvote. Obtain this ID from the list_bots action. |
| `value` | integer | No | The value of the downvote. Must be between -100 and -1 (inclusive). Defaults to -100 if not specified. |
| `reason` | string | No | The reason for the downvote. Provides context for why the bot is being downvoted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Downvote Conversation

**Slug:** `CHATBOTKIT_DOWNVOTE_CONVERSATION`

Tool to downvote a conversation in ChatBotKit. Use when you need to register negative feedback on a conversation's quality or outcome.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | integer | No | The value of the downvote. Must be between -100 and -1 (inclusive). Defaults to -100 if not specified. |
| `reason` | string | No | The reason for the downvote. Provides context for why the conversation is being downvoted. |
| `conversationId` | string | Yes | The unique identifier of the conversation to downvote. Obtain this from list_conversations or when creating a conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Downvote Conversation Message

**Slug:** `CHATBOTKIT_DOWNVOTE_CONVERSATION_MESSAGE`

Tool to downvote a conversation message in ChatBotKit. Use when you need to register negative feedback on a message's quality or appropriateness.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | integer | No | The value of the downvote. Must be between -100 and -1 (inclusive). Defaults to -100 if not specified. |
| `reason` | string | No | The reason for the downvote. Provides context for why the message is being downvoted. |
| `messageId` | string | Yes | The unique identifier of the message to downvote. Obtain this from list_conversation_messages or when creating a message. |
| `conversationId` | string | Yes | The unique identifier of the conversation containing the message. Obtain this from list_conversations or when creating a conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Ensure Contact

**Slug:** `CHATBOTKIT_ENSURE_CONTACT`

Tool to ensure a contact exists or create a new one. Use when you need to create or retrieve a contact by fingerprint, ensuring idempotent contact management.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `nick` | string | No | Optional nickname or display name for the contact. |
| `email` | string | No | Optional email address for the contact. |
| `phone` | string | No | Optional phone number for the contact. |
| `verifiedAt` | integer | No | Optional Unix timestamp (in milliseconds) indicating when the contact was verified. |
| `fingerprint` | string | Yes | Unique identifier or fingerprint for the contact. This is used to identify and retrieve existing contacts or create new ones if they don't exist. |
| `preferences` | string | No | Optional JSON string containing user preferences and settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute GraphQL Query

**Slug:** `CHATBOTKIT_EXECUTE_GRAPHQL_QUERY`

Tool to execute a GraphQL query or mutation against the ChatBotKit API. Use when you need to run custom GraphQL queries to retrieve or modify data in flexible ways not covered by other actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | The GraphQL query or mutation string to execute. Must be a valid GraphQL syntax. |
| `variables` | object | No | Variables for the GraphQL operation. Provide key-value pairs where keys match variable names in the query. |
| `operationName` | string | No | The name of the operation to execute. Required only if the query contains multiple operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Contacts

**Slug:** `CHATBOTKIT_EXPORT_CONTACTS`

Tool to export contacts with pagination support. Use when you need to retrieve or export contact information from ChatBotKit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter contacts by metadata. Only contacts matching all specified metadata key-value pairs will be returned. |
| `take` | integer | No | Maximum number of contacts to return per page. |
| `order` | string ("asc" | "desc") | No | Order type for pagination. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Conversations

**Slug:** `CHATBOTKIT_EXPORT_CONVERSATIONS`

Tool to export conversations with pagination support. Use when you need to retrieve and export conversation data in bulk for analysis, backup, or migration purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter conversations by metadata. Only conversations matching all specified metadata fields will be returned. |
| `take` | integer | No | Number of items to retrieve per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order of returned items. 'desc' returns newest first (default), 'asc' returns oldest first. |
| `cursor` | string | No | Pagination cursor for fetching the next page of results. Pass the cursor value from the previous response to continue pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Dataset Records

**Slug:** `CHATBOTKIT_EXPORT_DATASET_RECORDS`

Tool to export dataset records with pagination support. Use when you need to retrieve or export record data from a specific ChatBotKit dataset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Maximum number of records to return per page. |
| `order` | string ("asc" | "desc") | No | Order type for pagination. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page of results. |
| `datasetId` | string | Yes | The unique identifier of the dataset to export records from. Obtain this from list_datasets or when creating a dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Event Logs

**Slug:** `CHATBOTKIT_EXPORT_EVENT_LOGS`

Tool to export event logs with pagination support. Use when you need to retrieve and export event log data for monitoring, auditing, or analysis purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter event logs by metadata. Only event logs matching all specified metadata fields will be returned. |
| `take` | integer | No | Number of items to retrieve per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order for pagination. |
| `cursor` | string | No | Pagination cursor for fetching the next page of results. Pass the cursor value from the previous response to continue pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Memories

**Slug:** `CHATBOTKIT_EXPORT_MEMORIES`

Tool to export memories with pagination support. Use when you need to retrieve or export memory information from ChatBotKit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter memories by metadata. Only memories matching all specified metadata key-value pairs will be returned. |
| `take` | integer | No | Maximum number of memories to return per page. |
| `order` | string ("asc" | "desc") | No | Order type for pagination. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Skillset Abilities

**Slug:** `CHATBOTKIT_EXPORT_SKILLSET_ABILITIES`

Tool to export all abilities from a specific skillset with pagination support. Use when you need to retrieve the complete list of abilities within a skillset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | The number of items to retrieve per page |
| `order` | string ("asc" | "desc") | No | Order enum for pagination |
| `cursor` | string | No | Cursor for pagination. Use the cursor value from a previous response to fetch the next page. |
| `skillset_id` | string | Yes | The ID of the skillset to export abilities from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Spaces

**Slug:** `CHATBOTKIT_EXPORT_SPACES`

Tool to export spaces with pagination support. Use when you need to retrieve or export space data in bulk for analysis, backup, or migration purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter spaces by metadata. Only spaces matching all specified metadata key-value pairs will be returned. |
| `take` | integer | No | Maximum number of spaces to return per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Order type for pagination. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Tasks

**Slug:** `CHATBOTKIT_EXPORT_TASKS`

Tool to export tasks with pagination support. Use when you need to retrieve and export task data in bulk for analysis, backup, or migration purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter tasks by metadata. Only tasks matching all specified metadata fields will be returned. |
| `take` | integer | No | Number of task items to retrieve per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order for paginated items. |
| `cursor` | string | No | Pagination cursor to retrieve the next page of results. Pass the cursor value from the previous response to continue pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Blueprint

**Slug:** `CHATBOTKIT_FETCH_BLUEPRINT`

Tool to fetch a blueprint by ID. Use when you need to retrieve detailed information about a specific blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blueprintId` | string | Yes | The ID of the blueprint to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Blueprint (GraphQL)

**Slug:** `CHATBOTKIT_FETCH_BLUEPRINT_GRAPHQL`

Tool to fetch a single blueprint by ID using GraphQL. Returns detailed blueprint information including template configuration. Use when you need structured GraphQL response format with complete blueprint metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blueprint_id` | string | Yes | The unique identifier of the blueprint to retrieve. Use this to fetch detailed blueprint information via GraphQL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Bot

**Slug:** `CHATBOTKIT_FETCH_BOT`

Tool to fetch a specific bot by its ID. Use when you need detailed information about a particular bot including configuration, model, dataset, and skillset associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | Yes | The ID of the bot to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Bot (GraphQL)

**Slug:** `CHATBOTKIT_FETCH_BOT_GRAPHQL`

Tool to fetch a single bot by ID using GraphQL query. Use when you need to retrieve bot configuration, backstory, model, and other details via the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | Yes | The ID of the bot to retrieve. This is the unique identifier for the bot you want to fetch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Bot Usage

**Slug:** `CHATBOTKIT_FETCH_BOT_USAGE`

Tool to fetch bot usage statistics for a specific bot. Use when you need to retrieve metrics like conversations, messages, and token usage for a given time period.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The ID of the bot to retrieve usage statistics for |
| `to_date` | string | No | End date for the period in ISO 8601 format (e.g., '2024-12-31T23:59:59Z'). If not specified, usage up to the current time will be included. |
| `from_date` | string | No | Start date for the period in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). If not specified, usage from the beginning will be included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Contact

**Slug:** `CHATBOTKIT_FETCH_CONTACT`

Tool to retrieve detailed information about a specific contact by ID. Use when you need to access contact details including email, phone, fingerprint, and preferences.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | string | Yes | Unique identifier of the contact to retrieve. This ID can be obtained from contact listing or creation operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Conversation

**Slug:** `CHATBOTKIT_FETCH_CONVERSATION`

Tool to retrieve full details of a specific conversation by its ID. Use when you need complete information about a conversation including its configuration, metadata, and associated resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | The unique identifier of the conversation to retrieve. Obtain this ID from the list_conversations action or when creating a new conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Conversation Message

**Slug:** `CHATBOTKIT_FETCH_CONVERSATION_MESSAGE`

Tool to retrieve full details of a specific message within a conversation. Use when you need complete information about a particular message including its content, type, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | The unique identifier of the message to retrieve. Obtain this ID from the list_conversation_messages action or when creating a new message. |
| `conversation_id` | string | Yes | The unique identifier of the conversation containing the message. Obtain this ID from the list_conversations action or when creating a new conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Conversation Usage

**Slug:** `CHATBOTKIT_FETCH_CONVERSATION_USAGE`

Tool to fetch usage statistics for a specific conversation. Use when you need to retrieve token and message counts for billing, monitoring, or analytics purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | End date for the usage period in ISO 8601 format (e.g., '2024-12-31T23:59:59Z'). If not provided, fetches usage up to the current time. |
| `from` | string | No | Start date for the usage period in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). If not provided, fetches usage from the beginning of the conversation. |
| `conversationId` | string | Yes | The unique identifier of the conversation to fetch usage statistics for. Obtain this ID from the list_conversations action or when creating a new conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Conversation With Messages (GraphQL)

**Slug:** `CHATBOTKIT_FETCH_CONVERSATION_WITH_MESSAGES_GRAPHQL`

Tool to fetch a single conversation by ID with messages and metadata using GraphQL. Returns detailed conversation information including all messages, associated bot, contact, space, and task. Use when you need complete conversation history with messages in a structured GraphQL response format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | The unique identifier of the conversation to retrieve. Use this to fetch detailed conversation information including all messages via GraphQL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Dataset

**Slug:** `CHATBOTKIT_FETCH_DATASET`

Tool to fetch a specific dataset by its ID. Use when you need detailed information about a particular dataset including configuration, storage, search settings, and content instructions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `datasetId` | string | Yes | The ID of the dataset to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Dataset via GraphQL

**Slug:** `CHATBOTKIT_FETCH_DATASET_GRAPHQL`

Tool to fetch a single dataset by ID using GraphQL. Use when you need to retrieve dataset details (name, description, timestamps) via the GraphQL endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dataset_id` | string | Yes | The unique identifier of the dataset to fetch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Dataset Record

**Slug:** `CHATBOTKIT_FETCH_DATASET_RECORD`

Tool to fetch a specific record from a dataset by its ID. Use when you need to retrieve detailed information about a particular dataset record including its text content, source, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `recordId` | string | Yes | The unique identifier of the record to retrieve from the dataset. |
| `datasetId` | string | Yes | The unique identifier of the dataset containing the record. Obtain this from list_datasets or when creating a dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Discord Integration

**Slug:** `CHATBOTKIT_FETCH_DISCORD_INTEGRATION`

Tool to fetch a specific Discord integration by its ID. Use when you need detailed information about a particular Discord integration including configuration, bot association, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discordIntegrationId` | string | Yes | The ID of the Discord integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Email Integration

**Slug:** `CHATBOTKIT_FETCH_EMAIL_INTEGRATION`

Tool to fetch a specific Email integration by its ID. Use when you need detailed information about a particular Email integration including configuration, bot association, and settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emailIntegrationId` | string | Yes | The ID of the Email integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Extract Integration

**Slug:** `CHATBOTKIT_FETCH_EXTRACT_INTEGRATION`

Tool to fetch a specific Extract integration by its ID. Use when you need detailed information about a particular Extract integration including configuration, bot association, request template, and extraction schema.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extractIntegrationId` | string | Yes | The ID of the Extract integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch File

**Slug:** `CHATBOTKIT_FETCH_FILE`

Tool to retrieve detailed metadata about a specific file by its ID. Use when you need file information including name, type, size, and visibility settings. Note: This returns file metadata, not the actual file content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileId` | string | Yes | The unique identifier of the file to retrieve. This ID can be obtained from file listing or creation operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch File (GraphQL)

**Slug:** `CHATBOTKIT_FETCH_FILE_GRAPHQL`

Tool to fetch a single file by ID using GraphQL. Returns detailed file information including name, description, timestamps, and metadata. Use when you need structured GraphQL response format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | string | Yes | The unique identifier of the file to retrieve. Use this to fetch detailed file information via GraphQL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Instagram Integration

**Slug:** `CHATBOTKIT_FETCH_INSTAGRAM_INTEGRATION`

Tool to fetch a specific Instagram integration by its ID. Use when you need detailed information about a particular Instagram integration including access token, configuration, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `instagramIntegrationId` | string | Yes | The ID of the Instagram integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch MCP Server Integration

**Slug:** `CHATBOTKIT_FETCH_MCPSERVER_INTEGRATION`

Tool to fetch a specific MCP Server integration by its ID. Use when you need detailed information about a particular MCP Server integration including configuration, skillset, and blueprint associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mcpserverIntegrationId` | string | Yes | The ID of the MCP Server integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Memory

**Slug:** `CHATBOTKIT_FETCH_MEMORY`

Tool to retrieve detailed information about a specific memory by ID. Use when you need to access the content and metadata of a particular memory entry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `memoryId` | string | Yes | The ID of the memory to retrieve. This ID can be obtained from memory listing operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Messenger Integration

**Slug:** `CHATBOTKIT_FETCH_MESSENGER_INTEGRATION`

Tool to fetch a specific Messenger integration by its ID. Use when you need detailed information about a particular Messenger integration including configuration, bot association, and settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messengerIntegrationId` | string | Yes | The ID of the Messenger integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Notion Integration

**Slug:** `CHATBOTKIT_FETCH_NOTION_INTEGRATION`

Tool to fetch a specific Notion integration by its ID. Use when you need detailed information about a particular Notion integration including dataset association, sync status, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notionIntegrationId` | string | Yes | The ID of the Notion integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Platform Doc

**Slug:** `CHATBOTKIT_FETCH_PLATFORM_DOC`

Tool to fetch a specific platform documentation by its ID. Use when you need to retrieve documentation content for ChatBotKit platform features.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `docId` | string | Yes | The ID of the documentation to retrieve (e.g., 'datasets', 'skillsets', 'bots') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Platform Example

**Slug:** `CHATBOTKIT_FETCH_PLATFORM_EXAMPLE`

Tool to fetch a specific platform example with full configuration details by its ID. Use when you need to retrieve complete information about a ChatBotKit example including its type, config, and associated metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `exampleId` | string | Yes | The ID (slug) of the example to retrieve (e.g., 'liquid-glass', 'customer-support') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Platform Manual

**Slug:** `CHATBOTKIT_FETCH_PLATFORM_MANUAL`

Tool to fetch a specific platform manual by its ID. Use when you need documentation or help content for a particular platform feature or resource type (e.g., datasets, skillsets, bots).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `manualId` | string | Yes | The ID of the manual to fetch (e.g., 'datasets', 'skillsets', 'bots', 'conversations') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Platform Manuals (GraphQL)

**Slug:** `CHATBOTKIT_FETCH_PLATFORM_MANUALS_GRAPHQL`

Tool to fetch platform manuals using GraphQL query by search query or specific IDs. Use when you need to retrieve documentation manuals for ChatBotKit platform features via GraphQL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of results to return. Limits the response size. |
| `search` | string | No | Search query to find relevant manuals. Leave empty to fetch all manuals. |
| `platformManualIds` | array | No | Array of specific manual IDs to fetch. If provided, returns only these manuals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Platform Tutorial

**Slug:** `CHATBOTKIT_FETCH_PLATFORM_TUTORIAL`

Tool to fetch a specific platform tutorial by its ID. Use when you need to retrieve tutorial content for ChatBotKit platform features.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tutorialId` | string | Yes | The ID of the tutorial to fetch (e.g., 'how-to-get-started-with-chatbotkit') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Platform Tutorials

**Slug:** `CHATBOTKIT_FETCH_PLATFORM_TUTORIALS`

Tool to fetch platform tutorials by search query or IDs. Use when you need to search for tutorials or retrieve specific tutorials to help with ChatBotKit platform features.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of results to return. Limits the number of tutorial results. |
| `search` | string | No | Search query to find relevant tutorials. Filters tutorials by title, content, or related keywords. |
| `platformTutorialIds` | array | No | Array of specific tutorial IDs to fetch. Use to retrieve particular tutorials by their IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Rating

**Slug:** `CHATBOTKIT_FETCH_RATING`

Tool to retrieve detailed information about a specific rating by ID. Use when you need to access rating details including value, reason, and associated entities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the rating to fetch. This ID can be obtained from rating listing or creation operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Secret

**Slug:** `CHATBOTKIT_FETCH_SECRET`

Tool to fetch a secret by ID. Use when you need to retrieve detailed information about a specific secret.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secretId` | string | Yes | The ID of the secret to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Sitemap Integration

**Slug:** `CHATBOTKIT_FETCH_SITEMAP_INTEGRATION`

Tool to fetch a specific Sitemap integration by its ID. Use when you need detailed information about a particular Sitemap integration including configuration, dataset association, URL patterns, and synchronization settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sitemapIntegrationId` | string | Yes | The ID of the Sitemap integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Skillset

**Slug:** `CHATBOTKIT_FETCH_SKILLSET`

Tool to fetch a specific skillset by its ID. Use when you need detailed information about a particular skillset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skillsetId` | string | Yes | The ID of the skillset to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Skillset Ability

**Slug:** `CHATBOTKIT_FETCH_SKILLSET_ABILITY`

Tool to fetch detailed information about a specific ability from a skillset. Use when you need to retrieve ability configuration, instructions, and associated resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `abilityId` | string | Yes | The ID of the ability to retrieve |
| `skillsetId` | string | Yes | The ID of the skillset containing the ability |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Skillset (GraphQL)

**Slug:** `CHATBOTKIT_FETCH_SKILLSET_GRAPHQL`

Tool to fetch a single skillset by ID using GraphQL. Use when you need to retrieve skillset details via the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skillsetId` | string | Yes | The ID of the skillset to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Slack Integration

**Slug:** `CHATBOTKIT_FETCH_SLACK_INTEGRATION`

Tool to fetch a specific Slack integration by its ID. Use when you need detailed information about a particular Slack integration including configuration, bot association, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `slackIntegrationId` | string | Yes | The ID of the Slack integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Space

**Slug:** `CHATBOTKIT_FETCH_SPACE`

Tool to retrieve detailed information about a specific space by ID. Use when you need to access space details including name, description, blueprint, and associated contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `spaceId` | string | Yes | The ID of the space to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Support Integration

**Slug:** `CHATBOTKIT_FETCH_SUPPORT_INTEGRATION`

Tool to fetch a specific Support integration by its ID. Use when you need detailed information about a particular Support integration including configuration, bot association, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `supportIntegrationId` | string | Yes | The ID of the Support integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Task

**Slug:** `CHATBOTKIT_FETCH_TASK`

Tool to retrieve details of a specific task by its ID. Use when you need to check the status, outcome, or configuration of a particular task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | string | Yes | The unique identifier of the task to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Telegram Integration

**Slug:** `CHATBOTKIT_FETCH_TELEGRAM_INTEGRATION`

Tool to fetch a specific Telegram integration by its ID. Use when you need detailed information about a particular Telegram integration including configuration, bot association, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `telegramIntegrationId` | string | Yes | The ID of the Telegram integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Trigger Integration

**Slug:** `CHATBOTKIT_FETCH_TRIGGER_INTEGRATION`

Tool to fetch a specific trigger integration by its ID. Use when you need detailed information about a particular trigger integration including configuration, schedule, authentication, and associated bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `triggerIntegrationId` | string | Yes | The ID of the Trigger integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Twilio Integration

**Slug:** `CHATBOTKIT_FETCH_TWILIO_INTEGRATION`

Tool to fetch a specific Twilio integration by its ID. Use when you need detailed information about a particular Twilio integration including configuration, bot association, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `twilioIntegrationId` | string | Yes | The ID of the Twilio integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Usage

**Slug:** `CHATBOTKIT_FETCH_USAGE`

Tool to fetch account-wide usage statistics including tokens, conversations, messages, and database resources. Use when you need overall usage metrics for billing, monitoring, or analytics purposes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Usage Series

**Slug:** `CHATBOTKIT_FETCH_USAGE_SERIES`

Tool to fetch usage series data for the last 90 days. Use when you need to analyze token usage, conversation counts, or message counts over time.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch WhatsApp Integration

**Slug:** `CHATBOTKIT_FETCH_WHATSAPP_INTEGRATION`

Tool to fetch a specific WhatsApp integration by its ID. Use when you need detailed information about a particular WhatsApp integration including configuration, bot association, and settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `whatsappIntegrationId` | string | Yes | The ID of the WhatsApp integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Widget Integration

**Slug:** `CHATBOTKIT_FETCH_WIDGET_INTEGRATION`

Tool to fetch a specific Widget integration by its ID. Use when you need detailed information about a particular Widget integration including configuration, bot association, and widget settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `widgetIntegrationId` | string | Yes | The ID of the Widget integration to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Report

**Slug:** `CHATBOTKIT_GENERATE_REPORT`

Tool to generate a specific report with time-series breakdowns. Use when you need usage statistics, event metrics, or analytics data for a specific time period.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reportId` | string | Yes | The unique identifier of the report type to generate |
| `periodDays` | integer | No | Number of days for the report period. Determines the time range for the report data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Reports

**Slug:** `CHATBOTKIT_GENERATE_REPORTS`

Tool to generate multiple reports simultaneously. Use when you need to retrieve analytics, metrics, or statistical data from ChatBotKit. Report IDs can be obtained from the platform report list endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report_configs` | object | Yes | Map of report IDs to their input parameters. Keys are report IDs (obtained from GET /v1/platform/report/list endpoint), values are objects containing report-specific parameters. Empty objects {} can be used for default parameters. Example: {'clr3m5n8k000008jq7h9e5b1a': {}, 'clr3m5n8k000508jq2j9k0l6f': {}} for Total Ratings Report and Total Conversations Report with default parameters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Audit Log Export

**Slug:** `CHATBOTKIT_GET_AUDIT_LOG_EXPORT`

Tool to export audit log entries showing user actions and system events. Use when you need to retrieve audit records for monitoring, compliance, or security analysis.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of items to retrieve per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order for pagination. |
| `cursor` | string | No | Pagination cursor for fetching the next page of results. Pass the cursor value from the previous response to continue pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event Metric Series

**Slug:** `CHATBOTKIT_GET_EVENT_METRIC_SERIES`

Tool to fetch event metric time series data for a specific metric type. Use when you need to retrieve historical metric data points for analytics, monitoring, or reporting purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | The type of event metric to fetch (e.g., 'conversation'). Specifies which metric category to retrieve time series data for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rating Export

**Slug:** `CHATBOTKIT_GET_RATING_EXPORT`

Tool to export ratings with pagination support. Use when you need to retrieve and export rating data in bulk for analysis, backup, or migration purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter ratings by metadata. Only ratings matching all specified metadata fields will be returned. |
| `take` | integer | No | Number of items to retrieve per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Order type for pagination. |
| `cursor` | string | No | Pagination cursor for fetching the next page of results. Pass the cursor value from the previous response to continue pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rating List

**Slug:** `CHATBOTKIT_GET_RATING_LIST`

Tool to retrieve a paginated list of ratings. Use when you need to browse, filter, or analyze ratings data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter ratings by metadata. Only ratings matching all specified metadata pairs will be returned. |
| `take` | integer | No | Maximum number of ratings to return per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order of returned items: 'asc' for ascending or 'desc' for descending. Defaults to 'desc'. |
| `cursor` | string | No | Pagination cursor (rating ID). Pass the ID of the last rating from the previous page to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Invoke Trigger Integration

**Slug:** `CHATBOTKIT_INVOKE_TRIGGER_INTEGRATION`

Tool to invoke a trigger integration in ChatBotKit. Use when you need to manually trigger a specific trigger integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `triggerIntegrationId` | string | Yes | The ID of the Trigger integration to invoke. Use the List Integrations action to find available trigger integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audit Logs

**Slug:** `CHATBOTKIT_LIST_AUDIT_LOGS`

Tool to retrieve a paginated list of audit logs. Use when you need to review system activity, security events, or compliance tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of audit log entries to return per page. Must be at least 1. |
| `cursor` | string | No | Pagination cursor. Corresponds to the ID of the last resource from the previous list. Pass this to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blueprint Resources

**Slug:** `CHATBOTKIT_LIST_BLUEPRINT_RESOURCES`

Tool to list the resources of a blueprint. Use when you need to retrieve all resources associated with a specific blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blueprintId` | string | Yes | The ID of the blueprint whose resources should be listed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blueprints

**Slug:** `CHATBOTKIT_LIST_BLUEPRINTS`

Tool to retrieve a list of blueprints. Use when you need to browse or paginate through available blueprint templates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter blueprints by metadata. |
| `take` | integer | No | Number of blueprints to retrieve per request. |
| `order` | string ("asc" | "desc") | No | Sort order of returned items: 'asc' for ascending or 'desc' for descending. |
| `cursor` | string | No | Cursor for pagination. Pass the ID of the last blueprint from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blueprints via GraphQL

**Slug:** `CHATBOTKIT_LIST_BLUEPRINTS_GRAPHQL`

Tool to list all blueprints using GraphQL with cursor-based pagination. Use when you need to browse blueprint templates via GraphQL endpoint with edges/node connection pattern.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `last` | integer | No | Number of blueprints to retrieve (backward pagination). Use with 'before' cursor. |
| `after` | string | No | Cursor for forward pagination. Pass the endCursor from pageInfo to get the next page. |
| `first` | integer | No | Number of blueprints to retrieve (forward pagination). Use with 'after' cursor. |
| `before` | string | No | Cursor for backward pagination. Pass the startCursor from pageInfo to get the previous page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bots

**Slug:** `CHATBOTKIT_LIST_BOTS`

Tool to retrieve a paginated list of all bots. Use when you need to browse or manage multiple bots, and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Maximum number of bots to return per page. Defaults to all bots if not specified. |
| `cursor` | string | No | Pagination cursor (bot ID). Pass the ID of the last bot from the previous page to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bots (GraphQL)

**Slug:** `CHATBOTKIT_LIST_BOTS_GRAPHQL`

Tool to query bots via GraphQL with pagination support. Use when you need to retrieve a list of bots using the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `first` | integer | No | Number of bots to retrieve from the beginning of the list. Use for forward pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Conversations

**Slug:** `CHATBOTKIT_LIST_CONTACT_CONVERSATIONS`

Tool to retrieve a paginated list of conversations for a specific contact. Use when you need to view all conversations associated with a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of items to retrieve per page; must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order of returned items: 'asc' for ascending or 'desc' for descending. Default is 'desc'. |
| `cursor` | string | No | Pagination cursor to retrieve the next page of results. Use the cursor from a previous response to paginate. |
| `contactId` | string | Yes | The unique identifier of the contact whose conversations are to be listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Memories

**Slug:** `CHATBOTKIT_LIST_CONTACT_MEMORIES`

Tool to retrieve a paginated list of memories for a specific contact. Use when you need to browse or access memory entries associated with a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of memory items to retrieve; must be at least 1. |
| `order` | string ("asc" | "desc") | No | Order for pagination |
| `cursor` | string | No | Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate. |
| `contactId` | string | Yes | Unique identifier of the contact whose memories are to be listed. The contact ID can be obtained from contact-related actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Ratings

**Slug:** `CHATBOTKIT_LIST_CONTACT_RATINGS`

Tool to retrieve ratings submitted by a specific contact. Use when you need to monitor conversation quality, identify areas for improvement, and track user satisfaction with AI-generated responses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Filter ratings by metadata. Provide key-value pairs to match against rating metadata. |
| `take` | integer | No | Number of items to return per request. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort direction: 'asc' for ascending or 'desc' for descending by creation date |
| `cursor` | string | No | Pagination cursor from previous response. Pass to get the next page of results. |
| `contact_id` | string | Yes | The contact ID to retrieve ratings for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `CHATBOTKIT_LIST_CONTACTS`

Tool to retrieve a paginated list of contacts. Contacts represent users interacting with bots. Use when you need to browse, filter, or manage multiple contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter contacts by metadata. Only contacts matching all specified metadata pairs will be returned. |
| `take` | integer | No | Maximum number of contacts to return per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order of returned items: 'asc' for ascending or 'desc' for descending. |
| `cursor` | string | No | Pagination cursor (contact ID). Pass the ID of the last contact from the previous page to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Secrets

**Slug:** `CHATBOTKIT_LIST_CONTACT_SECRETS`

Tool to retrieve a paginated list of secrets for a specific contact. Use when you need to browse or access secret entries associated with a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of secret items to retrieve per page; must be at least 1. |
| `order` | string ("asc" | "desc") | No | Order for pagination |
| `cursor` | string | No | Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate. |
| `contactId` | string | Yes | Unique identifier of the contact whose secrets are to be listed. The contact ID can be obtained from contact-related actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Spaces

**Slug:** `CHATBOTKIT_LIST_CONTACT_SPACES`

Tool to retrieve a paginated list of spaces for a specific contact. Use when you need to fetch all spaces associated with a particular contact ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of items to retrieve per page; must be at least 1. |
| `order` | string ("asc" | "desc") | No | Enum for sort order of returned items. |
| `cursor` | string | No | Pagination cursor for fetching the next page of results. Pass the cursor value from a previous response to get the next page. |
| `contactId` | string | Yes | The ID of the contact to list spaces for. This is the unique identifier of the contact whose spaces you want to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts with Pagination

**Slug:** `CHATBOTKIT_LIST_CONTACTS_WITH_PAGINATION`

Tool to list contacts with full pagination support using GraphQL. Returns contact information including ID, name, email, metadata, and timestamps, along with pagination details. Use when you need to retrieve contacts with cursor-based pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Cursor for pagination. Returns contacts after this cursor. Use endCursor from previous response. |
| `first` | integer | No | Number of contacts to return. Use for forward pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Tasks

**Slug:** `CHATBOTKIT_LIST_CONTACT_TASKS`

Tool to retrieve a paginated list of tasks for a specific contact. Use when you need to view all tasks associated with a particular contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of task items to retrieve per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order for paginated items. |
| `cursor` | string | No | Pagination cursor to retrieve the next page of results. Use the cursor value from the previous response to paginate through tasks. |
| `contactId` | string | Yes | The unique identifier of the contact to list tasks for. Can be obtained from the list contacts action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List conversation messages

**Slug:** `CHATBOTKIT_LIST_CONVERSATION_MESSAGES`

Tool to list messages in a conversation with pagination. Use after obtaining a conversation ID to fetch messages page by page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of messages to retrieve; must be at least 1 |
| `order` | string ("asc" | "desc") | No | Sort order of returned messages: 'asc' or 'desc'. |
| `cursor` | string | No | Pagination cursor (message ID) to retrieve the next page of results. Use a message ID from a previous response to paginate. |
| `conversationId` | string | Yes | Unique identifier of the conversation whose messages are to be listed. Can be obtained from the list conversations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Conversations

**Slug:** `CHATBOTKIT_LIST_CONVERSATIONS`

Tool to retrieve a paginated list of conversations. Use when you need to page through conversation history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of items to retrieve; must be ≥ 1. |
| `order` | string ("asc" | "desc") | No | Sort order of returned items: 'asc' or 'desc'. |
| `accept` | string ("application/json" | "application/jsonl") | No | Response format header; set to 'application/jsonl' for streaming JSON Lines. |
| `cursor` | string | No | Pagination cursor; the ID of the last item from the previous page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Conversations (GraphQL)

**Slug:** `CHATBOTKIT_LIST_CONVERSATIONS_GRAPHQL`

Tool to retrieve conversations using GraphQL with cursor-based pagination. Use when you need to list all conversations with Relay-style pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Cursor for pagination. Pass the endCursor from the previous page's pageInfo to fetch the next page. |
| `first` | integer | No | Number of conversations to return per page. Defaults to 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dataset Files

**Slug:** `CHATBOTKIT_LIST_DATASET_FILES`

Tool to retrieve a list of files in a dataset. Use when you need to browse or paginate through dataset files.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of files to retrieve per request. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order for pagination |
| `cursor` | string | No | Cursor for pagination. Pass the ID of the last file from the previous response to get the next page. |
| `datasetId` | string | Yes | The unique identifier of the dataset whose files are to be listed. Can be obtained from the list datasets action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dataset Records

**Slug:** `CHATBOTKIT_LIST_DATASET_RECORDS`

Tool to list records in a dataset with pagination. Use after obtaining a dataset ID to retrieve all records or paginate through them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of records to retrieve per request. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Order direction for paginated results. |
| `cursor` | string | No | Cursor for pagination. Pass the cursor from the previous response to get the next page. |
| `datasetId` | string | Yes | The unique identifier of the dataset whose records are to be listed. Can be obtained from the list datasets action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Datasets

**Slug:** `CHATBOTKIT_LIST_DATASETS`

Tool to list datasets. Use when you need to browse or paginate through available datasets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of datasets to retrieve per request. |
| `order` | string | No | Order of results. 'desc' returns newest first, 'asc' returns oldest first. |
| `cursor` | string | No | Cursor for pagination. Pass the ID of the last dataset from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Datasets via GraphQL

**Slug:** `CHATBOTKIT_LIST_DATASETS_GRAPHQL`

Tool to list all datasets using GraphQL with cursor-based pagination. Use when you need to browse datasets via GraphQL endpoint. Supports forward pagination with 'first' and 'after', or backward pagination with 'last' and 'before'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `last` | integer | No | Number of datasets to retrieve (backward pagination). Use with 'before' cursor. |
| `after` | string | No | Cursor for forward pagination. Pass the endCursor from pageInfo to get the next page. |
| `first` | integer | No | Number of datasets to retrieve (forward pagination). Use with 'after' cursor. |
| `before` | string | No | Cursor for backward pagination. Pass the startCursor from pageInfo to get the previous page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discord Integrations

**Slug:** `CHATBOTKIT_LIST_DISCORD_INTEGRATIONS`

Tool to retrieve a list of Discord integrations. Use when you need to browse or manage configured Discord integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the Discord integrations by metadata. |
| `take` | integer | No | Number of Discord integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Integrations

**Slug:** `CHATBOTKIT_LIST_EMAIL_INTEGRATIONS`

Tool to retrieve a list of email integrations. Use when you need to browse or manage configured email integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter email integrations by metadata. Only integrations matching all specified metadata pairs will be returned. |
| `take` | integer | No | Number of email integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order of the returned items ('asc' for ascending or 'desc' for descending). Defaults to 'desc'. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Event Logs

**Slug:** `CHATBOTKIT_LIST_EVENT_LOGS`

Tool to retrieve a paginated list of event logs. Use when you need to browse system events, audit activity, or analyze event history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter event logs by metadata. Only event logs matching all specified metadata pairs will be returned. |
| `take` | integer | No | Maximum number of event logs to return per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order for pagination. |
| `cursor` | string | No | Pagination cursor. Pass the cursor value from the previous response to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Event Metrics

**Slug:** `CHATBOTKIT_LIST_EVENT_METRICS`

Tool to list event metrics for the authenticated account. Use when you need to retrieve analytics and monitoring data about platform events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of event metrics to retrieve per request. |
| `order` | string | No | Order of results. 'desc' returns newest first, 'asc' returns oldest first. |
| `cursor` | string | No | Pagination cursor. Pass the ID of the last metric from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Extract Integrations

**Slug:** `CHATBOTKIT_LIST_EXTRACT_INTEGRATIONS`

Tool to retrieve a list of Extract integrations. Use when you need to browse or manage configured Extract integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the Extract integrations by metadata. |
| `take` | integer | No | Number of Extract integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Files

**Slug:** `CHATBOTKIT_LIST_FILES`

Tool to retrieve a list of files. Use when you need to browse or paginate through available files that can be attached to datasets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of files to retrieve per request. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order for pagination |
| `cursor` | string | No | Cursor for pagination. Pass the ID of the last file from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Files (GraphQL)

**Slug:** `CHATBOTKIT_LIST_FILES_GRAPHQL`

Tool to list files using GraphQL query with connection-based pagination. Use when you need to retrieve files via GraphQL endpoint with edges/nodes structure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `last` | integer | No | Number of files to retrieve from the end. Used with 'before' cursor for backward pagination. |
| `after` | string | No | Cursor to paginate forward. Returns files after this cursor. |
| `first` | integer | No | Number of files to retrieve. Limit the result set size. |
| `before` | string | No | Cursor to paginate backward. Returns files before this cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Instagram Integrations

**Slug:** `CHATBOTKIT_LIST_INSTAGRAM_INTEGRATIONS`

Tool to retrieve a list of Instagram integrations. Use when you need to browse or manage configured Instagram integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the Instagram integrations by metadata. |
| `take` | integer | No | Number of Instagram integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Integrations (GraphQL)

**Slug:** `CHATBOTKIT_LIST_INTEGRATIONS_GRAPHQL`

Tool to list integrations with pagination using GraphQL query. Use when you need to retrieve multiple integration records with cursor-based pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Cursor for pagination (ID type). Use to fetch the next page of results after a previous query. |
| `first` | integer | No | Number of integrations to return. Controls page size for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Magic Prompts

**Slug:** `CHATBOTKIT_LIST_MAGIC_PROMPTS`

Tool to retrieve a list of magic prompts. Use when you need to browse or enumerate available magic prompts in the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter magic prompts by metadata. |
| `take` | integer | No | Number of magic prompts to retrieve per request. |
| `order` | string ("asc" | "desc") | No | Order direction for pagination. |
| `cursor` | string | No | Cursor for pagination. Pass the cursor value from a previous response to fetch the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List MCP Server Integrations

**Slug:** `CHATBOTKIT_LIST_MCP_SERVER_INTEGRATIONS`

Tool to retrieve a list of MCP Server integrations. Use when you need to browse or manage configured MCP Server integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the MCP Server integrations by metadata. |
| `take` | integer | No | Number of MCP Server integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Memories

**Slug:** `CHATBOTKIT_LIST_MEMORIES`

Tool to retrieve a paginated list of memories. Use when you need to browse or access memory entries across the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter memories by metadata. Only memories matching all specified metadata pairs will be returned. |
| `take` | integer | No | Number of memory items to retrieve; must be at least 1. |
| `order` | string ("asc" | "desc") | No | Order for pagination |
| `cursor` | string | No | Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List messages (GraphQL)

**Slug:** `CHATBOTKIT_LIST_MESSAGES_GRAPHQL`

Tool to list messages for one or more conversations using GraphQL. Returns messages in GraphQL connection pattern with edges/node structure. Use when you need to fetch messages across multiple conversations simultaneously.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversationIds` | array | Yes | Array of conversation IDs to fetch messages for. Each ID uniquely identifies a conversation. Obtain IDs from the list conversations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Messenger Integrations

**Slug:** `CHATBOTKIT_LIST_MESSENGER_INTEGRATIONS`

Tool to retrieve a list of Messenger integrations. Use when you need to browse or manage configured Messenger integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the Messenger integrations by metadata. Only integrations matching all specified metadata pairs will be returned. |
| `take` | integer | No | Number of Messenger integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notion Integrations

**Slug:** `CHATBOTKIT_LIST_NOTION_INTEGRATIONS`

Tool to retrieve a list of Notion integrations. Use when you need to browse or manage configured Notion integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the Notion integrations by metadata. |
| `take` | integer | No | Number of Notion integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Partners

**Slug:** `CHATBOTKIT_LIST_PARTNERS`

Tool to retrieve a list of all partner accounts associated with the main account. Use when you need to view or manage all sub-accounts under your partner umbrella.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Maximum number of partner accounts to return per page. |
| `order` | string | No | Sort order for the results. Use 'desc' for descending (newest first) or 'asc' for ascending (oldest first). |
| `cursor` | string | No | Cursor for pagination. Use the ID of the last partner from the previous page to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Abilities

**Slug:** `CHATBOTKIT_LIST_PLATFORM_ABILITIES`

Tool to retrieve a list of platform abilities. Use when you need to browse available abilities or capabilities provided by the platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter platform abilities by metadata. |
| `take` | integer | No | Maximum number of abilities to return per page. |
| `order` | string ("asc" | "desc") | No | Order for pagination results. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Actions

**Slug:** `CHATBOTKIT_LIST_PLATFORM_ACTIONS`

Tool to retrieve a paginated list of platform actions. Use when you need to browse available actions or discover what actions are supported by the platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter platform actions by metadata. Only actions matching all specified metadata pairs will be returned. |
| `take` | integer | No | Maximum number of platform actions to return per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Order of paginated items. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous page to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Docs

**Slug:** `CHATBOTKIT_LIST_PLATFORM_DOCS`

Tool to retrieve a list of platform documentation items. Use when you need to browse available documentation or discover what documentation is available for the ChatBotKit platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the documentation items by metadata. |
| `take` | integer | No | Maximum number of documentation items to return per page. |
| `order` | string ("asc" | "desc") | No | Order for pagination results. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Examples

**Slug:** `CHATBOTKIT_LIST_PLATFORM_EXAMPLES`

Tool to retrieve a list of platform examples from ChatBotKit. Use when you need to browse available example templates and resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter platform examples by metadata. |
| `take` | integer | No | Number of platform examples to retrieve per request. |
| `order` | string ("asc" | "desc") | No | Sort order for platform examples. |
| `cursor` | string | No | Cursor for pagination. Pass the cursor from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Guides

**Slug:** `CHATBOTKIT_LIST_PLATFORM_GUIDES`

Tool to retrieve a list of platform guides. Use when you need to browse available guides or tutorials for the platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter platform guides by metadata. |
| `take` | integer | No | Number of platform guides to retrieve per request. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Manuals

**Slug:** `CHATBOTKIT_LIST_PLATFORM_MANUALS`

Tool to retrieve a list of platform manuals. Use when you need to browse available documentation and help resources for the ChatBotKit platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter platform manuals by metadata. |
| `take` | integer | No | Number of platform manuals to retrieve per request. |
| `order` | string ("asc" | "desc") | No | Sort order for listing platform manuals. |
| `cursor` | string | No | Cursor for pagination. Pass the cursor from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Models

**Slug:** `CHATBOTKIT_LIST_PLATFORM_MODELS`

Tool to retrieve a list of available platform models. Use when you need to browse AI models available on the platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter platform models by metadata. |
| `take` | integer | No | Maximum number of models to return per page. |
| `order` | string ("asc" | "desc") | No | Order for pagination results. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Reports

**Slug:** `CHATBOTKIT_LIST_PLATFORM_REPORTS`

Tool to retrieve a list of available platform reports. Use when you need to view or analyze system-generated reports.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of reports to retrieve per request. |
| `order` | string ("asc" | "desc") | No | Order of paginated items. |
| `cursor` | string | No | Cursor for pagination. Pass the ID of the last report from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Secrets

**Slug:** `CHATBOTKIT_LIST_PLATFORM_SECRETS`

Tool to retrieve a paginated list of platform secrets. Use when you need to browse or access secret entries at the platform level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter platform secrets by metadata. Only secrets matching all specified metadata pairs will be returned. |
| `take` | integer | No | Number of secret items to retrieve per page; must be at least 1. |
| `order` | string ("asc" | "desc") | No | Order for pagination |
| `cursor` | string | No | Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Platform Tutorials

**Slug:** `CHATBOTKIT_LIST_PLATFORM_TUTORIALS`

Tool to retrieve a list of platform tutorials. Use when you need to browse or discover available tutorials for learning how to use the ChatBotKit platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter tutorials by metadata. |
| `take` | integer | No | Number of tutorials to retrieve per request. |
| `order` | string ("asc" | "desc") | No | Sort order for paginated results. |
| `cursor` | string | No | Cursor for pagination. Pass the cursor from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Policies

**Slug:** `CHATBOTKIT_LIST_POLICIES`

Tool to retrieve a list of policies. Use when you need to browse available policies or filter by metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter policies by metadata. Only policies matching all specified metadata fields will be returned. |
| `take` | integer | No | Number of policies to return per page |
| `order` | string ("asc" | "desc") | No | Order direction for pagination. |
| `cursor` | string | No | Cursor for pagination. Use the cursor value from a previous response to fetch the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Portals

**Slug:** `CHATBOTKIT_LIST_PORTALS`

Tool to retrieve a list of portals. Use when you need to browse or paginate through available portals.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter portals by metadata. Only portals matching all specified metadata pairs will be returned. |
| `take` | integer | No | Number of portals to retrieve per request. |
| `order` | string ("asc" | "desc") | No | Sort order of returned items: 'asc' for ascending or 'desc' for descending. Defaults to 'desc'. |
| `cursor` | string | No | Cursor for pagination. Pass the cursor value from the previous response to get the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Portals (GraphQL)

**Slug:** `CHATBOTKIT_LIST_PORTALS_GRAPHQL`

Tool to retrieve a paginated list of portals using GraphQL. Use when you need to query portals via GraphQL with cursor-based pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Cursor for forward pagination. Pass the endCursor from the previous response to get the next page. |
| `first` | integer | No | Number of portals to retrieve (forward pagination). Defaults to 10 if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Secrets

**Slug:** `CHATBOTKIT_LIST_SECRETS`

Tool to retrieve a list of secrets. Use when you need to browse or access credentials for external service integrations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of secret items to retrieve per page; must be at least 1. |
| `order` | string ("asc" | "desc") | No | Order for pagination |
| `cursor` | string | No | Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Secrets via GraphQL

**Slug:** `CHATBOTKIT_LIST_SECRETS_GRAPHQL`

Tool to list all secrets using GraphQL with cursor-based pagination. Use when you need to retrieve secrets stored in ChatBotKit. Supports forward pagination with 'first' and 'after', or backward pagination with 'last' and 'before'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `last` | integer | No | Number of secrets to retrieve (backward pagination). Use with 'before' cursor. |
| `after` | string | No | Cursor for forward pagination. Pass the endCursor from pageInfo to get the next page. |
| `first` | integer | No | Number of secrets to retrieve (forward pagination). Use with 'after' cursor. |
| `before` | string | No | Cursor for backward pagination. Pass the startCursor from pageInfo to get the previous page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sitemap Integrations

**Slug:** `CHATBOTKIT_LIST_SITEMAP_INTEGRATIONS`

Tool to retrieve a list of Sitemap integrations. Use when you need to browse or manage configured Sitemap integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the Sitemap integrations by metadata. |
| `take` | integer | No | Number of Sitemap integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Skillset Abilities

**Slug:** `CHATBOTKIT_LIST_SKILLSET_ABILITIES`

Tool to retrieve a list of abilities within a specific skillset. Use when you need to enumerate abilities for a given skillset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of abilities to return per page |
| `order` | string ("asc" | "desc") | No | Order of paginated items. |
| `cursor` | string | No | Cursor for pagination. Use the cursor value from a previous response to fetch the next page. |
| `skillsetId` | string | Yes | The ID of the skillset to retrieve abilities from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Skillsets

**Slug:** `CHATBOTKIT_LIST_SKILLSETS`

Tool to retrieve a list of all skillsets available in the system. Use when you need to enumerate existing skillsets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of skillsets to return per page (default is typically 25) |
| `cursor` | string | No | Cursor for pagination. Use the cursor value from a previous response to fetch the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Skillsets (GraphQL)

**Slug:** `CHATBOTKIT_LIST_SKILLSETS_GRAPHQL`

Tool to list skillsets using GraphQL query with connection-based pagination. Use when you need to retrieve skillsets via GraphQL endpoint with edges/nodes structure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `last` | integer | No | Number of skillsets to retrieve from the end. Used with 'before' cursor for backward pagination. |
| `after` | string | No | Cursor to paginate forward. Returns skillsets after this cursor. |
| `first` | integer | No | Number of skillsets to retrieve. Limit the result set size. |
| `before` | string | No | Cursor to paginate backward. Returns skillsets before this cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Slack Integrations

**Slug:** `CHATBOTKIT_LIST_SLACK_INTEGRATIONS`

Tool to retrieve a list of Slack integrations. Use when you need to browse or manage configured Slack integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the Slack integrations by metadata. |
| `take` | integer | No | Number of Slack integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Spaces

**Slug:** `CHATBOTKIT_LIST_SPACES`

Tool to retrieve a paginated list of spaces. Spaces are containers for organizing bot resources. Use when you need to browse or manage multiple spaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter spaces by metadata. Only spaces matching all specified metadata pairs will be returned. |
| `take` | integer | No | Maximum number of spaces to return per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order for pagination. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Support Integrations

**Slug:** `CHATBOTKIT_LIST_SUPPORT_INTEGRATIONS`

Tool to retrieve a list of support integrations. Use when you need to browse or manage configured support integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the support integrations by metadata. |
| `take` | integer | No | The number of items to retrieve per page. |
| `order` | string ("asc" | "desc") | No | Order of the paginated items. |
| `cursor` | string | No | The cursor to use for pagination. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tasks

**Slug:** `CHATBOTKIT_LIST_TASKS`

Tool to retrieve a paginated list of tasks. Use when you need to view all tasks, optionally filtered by bot, contact, status, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter tasks by metadata. Only tasks matching all specified metadata pairs will be returned. |
| `take` | integer | No | Number of task items to retrieve per page. Must be at least 1. |
| `botId` | string | No | Filter tasks by associated bot ID. Only tasks associated with this bot will be returned. |
| `order` | string ("asc" | "desc") | No | Sort order for paginated items. |
| `cursor` | string | No | Pagination cursor to retrieve the next page of results. Use the cursor value from the previous response to paginate through tasks. |
| `status` | string ("idle" | "running") | No | Status of a task. |
| `contactId` | string | No | Filter tasks by associated contact ID. Only tasks associated with this contact will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `CHATBOTKIT_LIST_TEAMS`

Tool to retrieve a paginated list of teams. Use when you need to browse or manage multiple teams.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter teams by metadata. Only teams matching all specified metadata pairs will be returned. |
| `take` | integer | No | Maximum number of teams to return per page. Must be at least 1. |
| `order` | string ("asc" | "desc") | No | Sort order for pagination. |
| `cursor` | string | No | Pagination cursor. Pass the cursor from the previous response to get the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Telegram Integrations

**Slug:** `CHATBOTKIT_LIST_TELEGRAM_INTEGRATIONS`

Tool to retrieve a list of Telegram integrations. Use when you need to browse or manage configured Telegram integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the Telegram integrations by metadata. |
| `take` | integer | No | Number of Telegram integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tokens

**Slug:** `CHATBOTKIT_LIST_TOKENS`

Tool to retrieve a list of all API tokens. Use when you need to audit or manage existing tokens.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Twilio Integrations

**Slug:** `CHATBOTKIT_LIST_TWILIO_INTEGRATIONS`

Tool to retrieve a list of Twilio integrations. Use when you need to browse or manage configured Twilio integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the Twilio integrations by metadata. Only integrations matching all specified metadata pairs will be returned. |
| `take` | integer | No | Number of Twilio integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Integrations

**Slug:** `CHATBOTKIT_LIST_WHATS_APP_INTEGRATIONS`

Tool to retrieve a list of WhatsApp integrations. Use when you need to browse or manage configured WhatsApp integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the WhatsApp integrations by metadata. |
| `take` | integer | No | Number of WhatsApp integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order enum for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Widget Integrations

**Slug:** `CHATBOTKIT_LIST_WIDGET_INTEGRATIONS`

Tool to retrieve a list of widget integrations. Use when you need to browse or manage configured widget integrations and iterate pages via cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Key-value pairs to filter the widget integrations by metadata. |
| `take` | integer | No | Number of widget integrations to return in one page. |
| `order` | string ("asc" | "desc") | No | Order direction for pagination. |
| `cursor` | string | No | Pagination cursor. Provide to retrieve the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Publish Channel Message

**Slug:** `CHATBOTKIT_PUBLISH_CHANNEL_MESSAGE`

Publish a message to a ChatBotKit channel. Use this action when you need to send messages to a specific channel identified by its channel ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | object | Yes | The message object to publish to the channel. Contains the message type and text content. |
| `channel_id` | string | Yes | The unique identifier of the channel to publish the message to. Must be at least 16 characters long. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Bot Memory

**Slug:** `CHATBOTKIT_SEARCH_BOT_MEMORY`

Tool to search memories for a specific bot. Use when you need to retrieve stored memories that match a keyword or phrase.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | Yes | The ID of the bot to search memories for |
| `search` | string | Yes | The keyword or phrase to search for in bot memories |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Contact Memory

**Slug:** `CHATBOTKIT_SEARCH_CONTACT_MEMORY`

Tool to search memories for a specific contact by keyword or phrase. Use when you need to find specific information stored in a contact's memory.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | Yes | The keyword or phrase to search for within the contact's memories. Returns memories containing this text. |
| `contactId` | string | Yes | Unique identifier of the contact whose memories to search. The contact ID can be obtained from contact-related actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Dataset

**Slug:** `CHATBOTKIT_SEARCH_DATASET`

Tool to search a dataset for records matching a given search query. Uses semantic search for finding relevant records. Use when you need to retrieve stored data from a dataset based on a keyword or phrase.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | object | No | Optional filter object to narrow results by field values. Supports operators like $eq, $ne, $gt, $gte, $lt, $lte. |
| `search` | string | Yes | The keyword or phrase to search for in the dataset. Uses semantic search to find relevant records. |
| `datasetId` | string | Yes | The ID of the dataset to search. Obtain this from list_datasets or when creating a dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Memory

**Slug:** `CHATBOTKIT_SEARCH_MEMORY`

Tool to search memories for records matching a given search query. Use when you need to find specific memories, optionally filtered by bot or contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | No | The ID of the bot to filter memories by. If provided, only memories associated with this bot will be searched. |
| `search` | string | Yes | The keyword or phrase to search for in memories |
| `contactId` | string | No | The ID of the contact to filter memories by. If provided, only memories associated with this contact will be searched. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Platform Abilities

**Slug:** `CHATBOTKIT_SEARCH_PLATFORM_ABILITIES`

Tool to search platform abilities using semantic similarity. Use when you need to find relevant abilities or tools based on a query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | The maximum number of search results to return (1-100). Defaults to 10. |
| `search` | string | Yes | The search query to find relevant abilities using semantic similarity |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Platform Docs

**Slug:** `CHATBOTKIT_SEARCH_PLATFORM_DOCS`

Tool to search platform documentation using semantic similarity. Use when you need to find relevant documentation, guides, or help articles based on a query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | The maximum number of search results to return (1-100). Defaults to 10. |
| `search` | string | Yes | The search query to find relevant documentation using semantic similarity |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Platform Docs (GraphQL)

**Slug:** `CHATBOTKIT_SEARCH_PLATFORM_DOCS_GRAPHQL`

Tool to search platform documentation by search query via GraphQL and retrieve docs with id, name, excerpt, and link. Use when you need to find relevant ChatBotKit documentation using the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | Number of results to return. Limits the response size. |
| `search` | string | No | Search query to find relevant documentation. If not provided, returns all documentation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Platform Examples

**Slug:** `CHATBOTKIT_SEARCH_PLATFORM_EXAMPLES`

Tool to search platform examples using semantic similarity. Use when you need to find relevant examples, templates, or code snippets from the platform's example library.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | The maximum number of results to return (1-100, default 10) |
| `search` | string | Yes | The search query to find relevant examples using semantic similarity |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Platform Guides

**Slug:** `CHATBOTKIT_SEARCH_PLATFORM_GUIDES`

Tool to search platform guides using semantic similarity. Use when you need to find relevant documentation, tutorials, or guides based on a search query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | The maximum number of results to return. Defaults to 10 if not specified. |
| `search` | string | Yes | The search query to find relevant guides using semantic similarity |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Platform Manuals

**Slug:** `CHATBOTKIT_SEARCH_PLATFORM_MANUALS`

Tool to search platform manuals using semantic similarity. Use when you need to find documentation, guides, or help resources related to a specific topic or question.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | The maximum number of results to return. Defaults to 10 if not specified. |
| `search` | string | Yes | The search query to find relevant manuals using semantic similarity. This searches through documentation, guides, and help resources. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Platform Secrets

**Slug:** `CHATBOTKIT_SEARCH_PLATFORM_SECRETS`

Tool to search platform secrets using semantic similarity. Use when you need to find secrets that match a particular topic or keyword using intelligent matching.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | The maximum number of results to return. Must be between 1 and 100. Defaults to 10 if not specified. |
| `search` | string | Yes | The search query to find relevant secrets. The system uses semantic similarity matching to find secrets related to this query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Platform Tutorials

**Slug:** `CHATBOTKIT_SEARCH_PLATFORM_TUTORIALS`

Tool to search platform tutorials using semantic similarity. Use when you need to find relevant tutorials, documentation, or guides on specific topics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `take` | integer | No | The maximum number of results to return. Must be between 1 and 100. Defaults to 10 if not specified. |
| `search` | string | Yes | The search query to find relevant tutorials. The search uses semantic similarity to match your query against tutorial content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Setup Email Integration

**Slug:** `CHATBOTKIT_SET_UP_EMAIL_INTEGRATION`

Tool to setup an email integration in ChatBotKit. Use when you need to activate or configure an existing email integration for use with a bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emailIntegrationId` | string | Yes | The ID of the email integration to setup. Use the List Integrations action to find available email integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Setup Trigger Integration

**Slug:** `CHATBOTKIT_SET_UP_TRIGGER_INTEGRATION`

Tool to setup a trigger integration in ChatBotKit. Use when you need to activate or configure an existing trigger integration for use with a bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `triggerIntegrationId` | string | Yes | The ID of the trigger integration to setup. Use the List Integrations action to find available trigger integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Setup Twilio Integration

**Slug:** `CHATBOTKIT_SET_UP_TWILIO_INTEGRATION`

Tool to setup a Twilio integration in ChatBotKit. Use when you need to activate or configure an existing Twilio integration for use with a bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `twilioIntegrationId` | string | Yes | The ID of the Twilio integration to setup. Use the List Integrations action to find available Twilio integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Setup WhatsApp Integration

**Slug:** `CHATBOTKIT_SET_UP_WHATS_APP_INTEGRATION`

Tool to setup a WhatsApp integration in ChatBotKit. Use when you need to activate or configure an existing WhatsApp integration for use with a bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `whatsappIntegrationId` | string | Yes | The ID of the WhatsApp integration to setup. Use the List Integrations action to find available WhatsApp integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Setup Widget Integration

**Slug:** `CHATBOTKIT_SET_UP_WIDGET_INTEGRATION`

Tool to setup a Widget integration in ChatBotKit. Use when you need to activate or configure an existing Widget integration for use with a bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `widgetIntegrationId` | string | Yes | The ID of the Widget integration to setup. Use the List Integrations action to find available Widget integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Subscribe to Channel

**Slug:** `CHATBOTKIT_SUBSCRIBE_CHANNEL`

Tool to subscribe to messages from a ChatBotKit channel. Use this when you need to monitor and receive messages from a specific channel. The subscription works by first replaying historical messages (if historyLength is specified) and then streaming live messages as they are published. This is a streaming endpoint that returns application/jsonl format with multiple message events. Prerequisites: - A valid channel_id (at least 16 characters) - The channel must exist and be active Returns a list of message events, each containing the message type and data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | The unique identifier of the channel to subscribe to. Must be at least 16 characters long. |
| `history_length` | integer | No | Number of historical messages to replay from the channel before subscribing to live updates. When provided, the subscriber will first receive up to this many recent messages that were published before the subscription started. This is useful for catching up on messages that may have been published during connection setup. Valid range: 0-10000. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync Dataset File

**Slug:** `CHATBOTKIT_SYNC_DATASET_FILE`

Tool to sync a dataset file. Use when you need to synchronize a file within a dataset to ensure its content is up-to-date and available for use by the bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileId` | string | Yes | The ID of the file to sync |
| `datasetId` | string | Yes | The ID of the dataset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync File

**Slug:** `CHATBOTKIT_SYNC_FILE`

Tool to sync a file. Use when you need to synchronize a file to ensure its content is up-to-date and available for use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileId` | string | Yes | The ID of the file to sync |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync Notion Integration

**Slug:** `CHATBOTKIT_SYNC_NOTION_INTEGRATION`

Tool to sync a Notion integration with ChatBotKit. Use when you need to manually trigger synchronization of content between Notion pages and the associated ChatBotKit dataset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notionIntegrationId` | string | Yes | The unique identifier of the Notion integration to sync. Obtain this ID from the list_integrations or create_notion_integration actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync Sitemap Integration

**Slug:** `CHATBOTKIT_SYNC_SITEMAP_INTEGRATION`

Tool to sync a sitemap integration. Use when you need to trigger an immediate sync of a sitemap integration to refresh the dataset with the latest content from the website.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sitemapIntegrationId` | string | Yes | The ID of the sitemap integration to sync |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Synthesize conversation message

**Slug:** `CHATBOTKIT_SYNTHESIZE_CONVERSATION_MESSAGE`

Tool to convert a conversation message into speech audio. Use when you need to synthesize text from a message into audio format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messageId` | string | Yes | The unique identifier of the message to synthesize into speech. Obtain this from list_conversation_messages. |
| `conversationId` | string | Yes | The unique identifier of the conversation containing the message. Obtain this from list_conversations or when creating a conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trigger Extract Integration

**Slug:** `CHATBOTKIT_TRIGGER_EXTRACT_INTEGRATION`

Tool to trigger an extract integration on historic conversations in ChatBotKit. Use when you need to process past conversations with an extract integration, either by specifying a sample size or specific conversation IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sample` | integer | No | Number of recent conversations to process (default 20, min 1, max 100). Use this to limit processing to the N most recent conversations. |
| `conversationIds` | array | No | Array of specific conversation IDs to process. If provided, only these conversations will be processed instead of using the sample parameter. |
| `extractIntegrationId` | string | Yes | The ID of the extract integration to trigger. Use the List Integrations action to find available extract integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trigger Support Integration

**Slug:** `CHATBOTKIT_TRIGGER_SUPPORT_INTEGRATION`

Tool to trigger a support integration on historic conversations in ChatBotKit. Use when you need to process past conversations with a support integration, either by specifying a sample size or specific conversation IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sample` | integer | No | Number of recent conversations to process (default 20, min 1, max 1000). Use this to limit processing to the N most recent conversations. |
| `conversationIds` | array | No | Array of specific conversation IDs to process. If provided, only these conversations will be processed instead of using the sample parameter. |
| `supportIntegrationId` | string | Yes | The ID of the support integration to trigger. Use the List Integrations action to find available support integration IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trigger Task

**Slug:** `CHATBOTKIT_TRIGGER_TASK`

Tool to trigger execution of a background task. Use when you need to manually start or restart a task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | string | Yes | The unique identifier of the task to trigger |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Blueprint

**Slug:** `CHATBOTKIT_UPDATE_BLUEPRINT`

Tool to update an existing blueprint. Use when you need to modify blueprint properties such as name, description, visibility, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the blueprint as key-value pairs. |
| `name` | string | No | The name of the blueprint. This is the display name that identifies the blueprint. |
| `alias` | string | No | The unique alias for the blueprint. This provides a human-readable identifier. |
| `visibility` | string | No | Visibility setting for the blueprint. Controls who can access this blueprint. |
| `blueprintId` | string | Yes | The unique identifier of the blueprint to update. Use the List Blueprints action to find available blueprint IDs. |
| `description` | string | No | A description explaining the purpose or functionality of this blueprint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Blueprint (GraphQL)

**Slug:** `CHATBOTKIT_UPDATE_BLUEPRINT_GRAPHQL`

Tool to update an existing blueprint using GraphQL mutation. Use when you need to modify a blueprint's properties via the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | object | Yes | Input object containing the fields to update for the blueprint. |
| `blueprintId` | string | Yes | The unique identifier of the blueprint to update. This is a required parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Bot

**Slug:** `CHATBOTKIT_UPDATE_BOT`

Tool to update an existing bot's configuration and properties. Use when you need to modify a bot's name, description, model, backstory, associated datasets/skillsets, or other settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the bot as key-value pairs. |
| `name` | string | No | Updated name for the bot. Provide a clear, descriptive name. |
| `alias` | string | No | A unique alias identifier for the bot that can be used instead of the bot ID. |
| `botId` | string | Yes | The unique identifier of the bot to update. This is a required path parameter. |
| `model` | string | No | The AI model to use for the bot. Format: model_name or model_name/param=value. |
| `privacy` | boolean | No | Privacy flag for the bot configuration. When true, enables privacy features. |
| `backstory` | string | No | The system prompt or backstory that defines the bot's personality and behavior instructions. |
| `datasetId` | string | No | The ID of the dataset to associate with this bot for knowledge retrieval. |
| `moderation` | boolean | No | Moderation flag for the bot configuration. When true, enables content moderation. |
| `skillsetId` | string | No | The ID of the skillset to associate with this bot for enhanced capabilities. |
| `visibility` | string ("private" | "protected" | "public") | No | Visibility levels for a bot. |
| `blueprintId` | string | No | The ID of the blueprint this bot is based on or should be updated to use. |
| `description` | string | No | Updated description explaining the purpose or functionality of the bot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Bot (GraphQL)

**Slug:** `CHATBOTKIT_UPDATE_BOT_GRAPHQL`

Tool to update an existing bot using GraphQL mutation. Use when you need to modify a bot's properties via the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | Yes | The unique identifier of the bot to update. This is a required parameter. |
| `input` | object | Yes | Input object containing the fields to update for the bot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact

**Slug:** `CHATBOTKIT_UPDATE_CONTACT`

Tool to update an existing contact's information. Use when you need to modify contact details like email, nickname, phone number, or preferences.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `nick` | string | No | Updated nickname or display name for the contact. |
| `email` | string | No | Updated email address for the contact. |
| `phone` | string | No | Updated phone number for the contact. |
| `contact_id` | string | Yes | The unique identifier of the contact to update. This is the ID of an existing contact that you want to modify. |
| `fingerprint` | string | No | Updated fingerprint identifier for the contact. Used to uniquely identify the contact across sessions. |
| `preferences` | string | No | Updated preferences for the contact as a JSON string or serialized data. |
| `verified_at` | integer | No | Unix timestamp (in milliseconds) when the contact was verified. Set this to mark when contact verification occurred. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Conversation

**Slug:** `CHATBOTKIT_UPDATE_CONVERSATION`

Tool to update an existing conversation's properties. Use when you need to modify conversation metadata, bot configuration, or associated resources like contacts, tasks, or spaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Metadata object for storing custom key-value pairs associated with the conversation. Accepts string key-value pairs. |
| `name` | string | No | The name to assign to the conversation. This is the display name that identifies the conversation. |
| `botId` | string | No | The ID of the bot to associate with this conversation. Mutually exclusive with bot configuration fields. |
| `model` | string | No | Language model to use for the conversation (e.g., 'gpt-4-turbo', 'gpt-3.5-turbo'). Part of bot configuration. |
| `taskId` | string | No | The task ID to assign to this conversation. |
| `privacy` | boolean | No | Whether privacy mode is enabled for this conversation. |
| `spaceId` | string | No | The space ID to assign to this conversation. |
| `backstory` | string | No | Background context and personality for the conversation. Defines how the bot should behave in this conversation. |
| `contactId` | string | No | The contact ID to assign to this conversation. |
| `datasetId` | string | No | ID of the dataset for knowledge retrieval in this conversation. |
| `moderation` | boolean | No | Whether moderation is enabled for this conversation. |
| `skillsetId` | string | No | ID of the skillset to provide specific capabilities for this conversation. |
| `description` | string | No | The description of the conversation. Provides additional context about the conversation purpose. |
| `conversationId` | string | Yes | The unique identifier of the conversation to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update conversation message

**Slug:** `CHATBOTKIT_UPDATE_CONVERSATION_MESSAGE`

Tool to update an existing message in a conversation. Use this to modify the text, entities, or type of a previously created message.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | The updated text content of the message. |
| `type` | string ("user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity") | No | The type of message. Options: 'user' for user messages, 'bot' for bot responses, 'context' for contextual information, 'instruction' for instructions, 'backstory' for background information, 'reasoning' for reasoning steps, 'activity' for activity logs. |
| `entities` | array | No | Optional array of entities to associate with this message. Entities are structured data extracted from the message text. |
| `messageId` | string | Yes | The unique identifier of the message to update. Obtain this from list_conversation_messages or when creating a message. |
| `conversationId` | string | Yes | The unique identifier of the conversation containing the message to update. Obtain this from list_conversations or when creating a new conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dataset

**Slug:** `CHATBOTKIT_UPDATE_DATASET`

Tool to update an existing dataset's configuration and properties. Use when you need to modify a dataset's name, description, visibility, search settings, or other configuration options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the dataset as key-value pairs. |
| `name` | string | No | The name of the dataset. This is the display name that identifies the dataset. |
| `alias` | string | No | The unique alias for the dataset. This provides a human-readable identifier. |
| `store` | string | No | The storage class for the dataset. Defines how the dataset data is stored. |
| `reranker` | string | No | The reranker class for the dataset. Used to improve search result relevance. |
| `datasetId` | string | Yes | The unique identifier of the dataset to update. This is a required path parameter. |
| `separators` | string | No | Separator characters to use for splitting dataset content. |
| `visibility` | string ("private" | "protected" | "public") | No | Visibility levels for a dataset. |
| `description` | string | No | A description explaining the purpose or contents of this dataset. |
| `searchMinScore` | number | No | Minimum similarity score threshold for search results. |
| `recordMaxTokens` | number | No | Maximum number of tokens per record in the dataset. |
| `searchMaxTokens` | number | No | Maximum number of tokens to use for search results. |
| `matchInstruction` | string | No | Instructions to apply when a search match is found. |
| `searchMaxRecords` | number | No | Maximum number of records to return in search results. |
| `mismatchInstruction` | string | No | Instructions to apply when no search match is found. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dataset (GraphQL)

**Slug:** `CHATBOTKIT_UPDATE_DATASET_GRAPHQL`

Tool to update an existing dataset using GraphQL mutation. Use when you need to modify a dataset's properties such as name, description, search configuration, visibility, or metadata via the GraphQL API endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | object | Yes | Input object containing the fields to update for the dataset. |
| `datasetId` | string | Yes | The unique identifier of the dataset to update. This is a required parameter for the mutation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dataset Record

**Slug:** `CHATBOTKIT_UPDATE_DATASET_RECORD`

Tool to update an existing record in a dataset. Use when you need to modify text data or metadata in an existing dataset record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Updated metadata object for storing additional custom information about this record. |
| `text` | string | No | Updated text content of the record. This is the main data stored in the dataset record. |
| `source` | string | No | Updated source identifier for the record. Use to track where the record originated from. |
| `recordId` | string | Yes | The unique identifier of the record to update. This is the ID of the specific record within the dataset. |
| `datasetId` | string | Yes | The unique identifier of the dataset containing the record to update. Obtain this from list_datasets or when creating a dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Discord Integration

**Slug:** `CHATBOTKIT_UPDATE_DISCORD_INTEGRATION`

Tool to update an existing Discord integration's configuration. Use when you need to modify Discord integration settings such as bot token, session duration, contact collection, or associated bot/blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | Updated name for the Discord integration. |
| `appId` | string | No | The Discord application ID. |
| `botId` | string | No | The ID of the bot to use for this Discord integration. |
| `handle` | string | No | The handle or username for the Discord integration. |
| `botToken` | string | No | The Discord bot token for authentication. |
| `publicKey` | string | No | The Discord application public key. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this Discord integration. |
| `description` | string | No | Updated description explaining the purpose of this Discord integration. |
| `sessionDuration` | integer | No | Session duration in seconds. Controls how long a conversation session remains active. |
| `contactCollection` | boolean | No | Whether to enable contact collection for this Discord integration. |
| `discordIntegrationId` | string | Yes | The unique identifier of the Discord integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Integration

**Slug:** `CHATBOTKIT_UPDATE_EMAIL_INTEGRATION`

Tool to update an existing Email integration's configuration and properties. Use when you need to modify an Email integration's settings such as allowed sender emails, attachment handling, contact collection, or session duration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the Email integration as key-value pairs. |
| `name` | string | No | The name of the Email integration. This is the display name that identifies the integration. |
| `botId` | string | No | The unique identifier of the bot to associate with this Email integration. |
| `attachments` | boolean | No | Whether to enable attachment handling for emails received through this integration. |
| `blueprintId` | string | No | The ID of the blueprint this Email integration is based on or should be updated to use. |
| `description` | string | No | A description explaining the purpose or configuration of this Email integration. |
| `sessionDuration` | number | No | Duration in seconds for how long an email conversation session should remain active. |
| `contactCollection` | boolean | No | Whether to enable automatic contact collection from email senders. |
| `emailIntegrationId` | string | Yes | The unique identifier of the Email integration to update. This is a required path parameter. |
| `allowedSenderEmails` | string | No | Comma-separated list or pattern of allowed sender email addresses for this integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Extract Integration

**Slug:** `CHATBOTKIT_UPDATE_EXTRACT_INTEGRATION`

Tool to update an existing Extract integration's configuration. Use when you need to modify an Extract integration's model, extraction request, schema, associated bot, or other settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the Extract integration as key-value pairs. |
| `name` | string | No | Updated name for the Extract integration. Provide a clear, descriptive name. |
| `botId` | string | No | The ID of the bot to associate with this Extract integration. |
| `model` | string | No | The AI model to use for extraction. Specify the model name such as 'gpt-4', 'gpt-3.5-turbo', or 'claude-3-opus'. |
| `schema` | object | No | JSON schema defining the structure of the data to extract. This schema specifies the expected output format. |
| `request` | string | No | The extraction request or prompt that defines what information to extract from conversations. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this Extract integration. |
| `description` | string | No | Updated description explaining the purpose of this Extract integration. |
| `extractIntegrationId` | string | Yes | The ID of the Extract integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update File

**Slug:** `CHATBOTKIT_UPDATE_FILE`

Tool to update an existing file's metadata and properties. Use when you need to modify a file's name, description, visibility, or other configuration settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the file as key-value pairs. |
| `name` | string | No | The name of the file. This is the display name that identifies the file. |
| `alias` | string | No | The unique alias for the file. This provides a human-readable identifier. |
| `fileId` | string | Yes | The unique identifier of the file to update. This is a required path parameter. |
| `visibility` | string ("private" | "protected" | "public") | No | Visibility levels for a file. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this file. |
| `description` | string | No | A description explaining the purpose or contents of this file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update File (GraphQL)

**Slug:** `CHATBOTKIT_UPDATE_FILE_GRAPHQL`

Tool to update an existing file using GraphQL mutation. Use when you need to modify a file's name, description, visibility, or other properties via the GraphQL API endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | object | Yes | Input object containing the fields to update for the file. |
| `fileId` | string | Yes | The unique identifier of the file to update. This is a required parameter for the mutation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Instagram Integration

**Slug:** `CHATBOTKIT_UPDATE_INSTAGRAM_INTEGRATION`

Tool to update an existing Instagram integration's configuration. Use when you need to modify Instagram integration settings such as access token, session duration, contact collection, attachments, or associated bot/blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | Updated name for the Instagram integration. |
| `botId` | string | No | The ID of the bot to use for this Instagram integration. |
| `accessToken` | string | No | The Instagram access token for authentication and API access. |
| `attachments` | boolean | No | Whether to enable attachments for this Instagram integration. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this Instagram integration. |
| `description` | string | No | Updated description explaining the purpose of this Instagram integration. |
| `sessionDuration` | integer | No | Session duration in seconds. Controls how long a conversation session remains active. |
| `contactCollection` | boolean | No | Whether to enable contact collection for this Instagram integration. |
| `instagramIntegrationId` | string | Yes | The unique identifier of the Instagram integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Trigger Integration (GraphQL)

**Slug:** `CHATBOTKIT_UPDATE_INTEGRATION_GRAPHQL`

Tool to update trigger integration configuration and settings using GraphQL mutation. Use when you need to modify a trigger integration's properties such as name, description, metadata, authentication settings, or associated bot/blueprint via the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | object | Yes | Input object containing the fields to update for the trigger integration. |
| `triggerIntegrationId` | string | Yes | The unique identifier of the trigger integration to update. This is a required parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update MCP Server Integration

**Slug:** `CHATBOTKIT_UPDATE_MCPSERVER_INTEGRATION`

Tool to update an existing MCP Server integration. Use when you need to modify properties of an MCP (Model Context Protocol) Server integration such as name, description, associated skillset or blueprint, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional metadata for the integration. Key-value pairs for organizing or tagging the integration. |
| `name` | string | No | Updated name for the MCP Server integration. A human-readable identifier for this integration. |
| `skillsetId` | string | No | Optional skillset ID to associate with the integration. Use the List Skillsets action to find available skillset IDs. |
| `blueprintId` | string | No | Optional blueprint ID to associate with the integration. Blueprints provide template configurations. |
| `description` | string | No | Updated description explaining the purpose or function of this MCP Server integration. |
| `mcpserverIntegrationId` | string | Yes | The unique identifier of the MCP Server integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Memory

**Slug:** `CHATBOTKIT_UPDATE_MEMORY`

Tool to update an existing memory's text or associations. Use when you need to modify memory content or change its bot/contact associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | Updated memory text content. This is the main content of the memory that will be stored. |
| `botId` | string | No | The ID of the bot associated with this memory. Use to change bot association. |
| `memoryId` | string | Yes | The unique identifier of the memory to update. This is a required path parameter. |
| `contactId` | string | No | The ID of the contact associated with this memory. Use to change contact association. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Messenger Integration

**Slug:** `CHATBOTKIT_UPDATE_MESSENGER_INTEGRATION`

Tool to update an existing Messenger integration's configuration. Use when you need to modify Messenger integration settings such as access token, session duration, attachments, or associated bot/blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | Updated name for the Messenger integration. |
| `botId` | string | No | The ID of the bot to use for this Messenger integration. |
| `accessToken` | string | No | The Facebook Page Access Token for authentication and API access. |
| `attachments` | boolean | No | Whether to enable attachments for this Messenger integration. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this Messenger integration. |
| `description` | string | No | Updated description explaining the purpose of this Messenger integration. |
| `sessionDuration` | integer | No | Session duration in seconds. Controls how long a conversation session remains active. |
| `messengerIntegrationId` | string | Yes | The unique identifier of the Messenger integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Notion Integration

**Slug:** `CHATBOTKIT_UPDATE_NOTION_INTEGRATION`

Tool to update an existing Notion integration's configuration and properties. Use when you need to modify a Notion integration's settings such as sync schedule, token, dataset association, or expiration settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the Notion integration as key-value pairs. |
| `name` | string | No | The name of the Notion integration. This is the display name that identifies the integration. |
| `token` | string | No | The Notion API token for authentication. Use this to update the integration's access token. |
| `datasetId` | string | No | The unique identifier of the dataset to associate with this Notion integration. |
| `expiresIn` | number | No | Duration in seconds for how long the integration token remains valid before expiring. |
| `blueprintId` | string | No | The ID of the blueprint this Notion integration is based on or should be updated to use. |
| `description` | string | No | A description explaining the purpose or configuration of this Notion integration. |
| `syncSchedule` | string | No | The schedule for automatic synchronization of Notion data. Examples: 'daily', 'weekly', 'monthly'. |
| `notionIntegrationId` | string | Yes | The unique identifier of the Notion integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Partner User

**Slug:** `CHATBOTKIT_UPDATE_PARTNER_USER`

Tool to update an existing partner user's information. Use when you need to modify partner user details like email, profile image, or resource limits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Updated email address for the partner user. |
| `image` | string | No | Updated profile image URL for the partner user. |
| `limits` | object | No | Updated resource limits for the partner user account. Key-value pairs defining usage restrictions or quotas. |
| `userId` | string | Yes | The unique identifier of the partner user to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Rating

**Slug:** `CHATBOTKIT_UPDATE_RATING`

Tool to update an existing rating by ID. Use when you need to modify a rating's value or associated metadata. Ratings track user feedback (upvotes/downvotes) for contacts, bots, conversations, and messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the rating to update. This is a required path parameter. |
| `meta` | object | No | Additional metadata for the rating as key-value pairs. |
| `name` | string | No | Name or title for the rating. |
| `botId` | string | No | The bot ID associated with the rating. |
| `value` | integer ("-1" | "1") | No | Rating value enum for upvotes and downvotes. |
| `reason` | string | No | Reason for the rating. Provides context for the rating value. |
| `contactId` | string | No | The contact ID associated with the rating. |
| `messageId` | string | No | The message ID associated with the rating. |
| `description` | string | No | Description of the rating. |
| `conversationId` | string | No | The conversation ID associated with the rating. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Secret

**Slug:** `CHATBOTKIT_UPDATE_SECRET`

Tool to update an existing secret's configuration and properties. Use when you need to modify a secret's name, description, value, type, or other settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string ("shared" | "personal") | No | Storage type for the secret |
| `meta` | object | No | Additional metadata to associate with the secret as key-value pairs. |
| `name` | string | No | Updated identifier for the secret. This is the display name that identifies the secret. |
| `type` | string ("plain" | "basic" | "bearer" | "oauth" | "template") | No | Authentication method type for the secret |
| `alias` | string | No | The unique alias for the secret. This provides a human-readable identifier. |
| `value` | string | No | Updated credential data (e.g., API key, token, password). This will be encrypted at rest by ChatBotKit. |
| `config` | object | No | Configuration object for the secret. Used for additional settings or parameters. |
| `secretId` | string | Yes | The unique identifier of the secret to update. This is a required path parameter. |
| `visibility` | string ("private" | "public") | No | Access control level for the secret |
| `blueprintId` | string | No | The ID of the blueprint this secret is associated with. |
| `description` | string | No | Updated description of the secret. Explains what this secret is used for or which service it authenticates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Secret (GraphQL)

**Slug:** `CHATBOTKIT_UPDATE_SECRET_GRAPHQL`

Tool to update an existing secret via GraphQL mutation. Use when you need to modify a secret's properties using the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | object | Yes | Input object containing the fields to update for the secret. |
| `secretId` | string | Yes | The unique identifier of the secret to update. This is a required GraphQL variable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Sitemap Integration

**Slug:** `CHATBOTKIT_UPDATE_SITEMAP_INTEGRATION`

Tool to update an existing Sitemap integration's configuration. Use when you need to modify sitemap URL, glob patterns, sync schedule, dataset association, or crawling settings like JavaScript rendering and CSS selectors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | The URL of the sitemap.xml file to crawl and index. |
| `glob` | string | No | Glob pattern to filter which URLs from the sitemap should be processed. Use patterns like '**/*.html' to match specific paths. |
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | Updated name for the Sitemap integration. |
| `datasetId` | string | No | The ID of the dataset to store the crawled sitemap content. |
| `expiresIn` | number | No | Expiration time in seconds for cached sitemap content. Controls how long crawled data remains valid. |
| `selectors` | string | No | CSS selectors to extract specific content from crawled pages. Use comma-separated selectors to target multiple elements. |
| `javascript` | boolean | No | Whether to enable JavaScript rendering when crawling sitemap URLs. Enable this if the target pages use client-side rendering. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this Sitemap integration. |
| `description` | string | No | Updated description explaining the purpose of this Sitemap integration. |
| `syncSchedule` | string | No | Schedule for automatically syncing the sitemap. Common values include 'daily', 'weekly', 'hourly'. |
| `sitemapIntegrationId` | string | Yes | The unique identifier of the Sitemap integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Skillset

**Slug:** `CHATBOTKIT_UPDATE_SKILLSET`

Tool to update an existing skillset's configuration and properties. Use when you need to modify a skillset's name, description, visibility, or other settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the skillset as key-value pairs. |
| `name` | string | No | The name of the skillset. This is the display name that identifies the skillset. |
| `alias` | string | No | The unique alias for the skillset. This provides a human-readable identifier. |
| `skillsetId` | string | Yes | The unique identifier of the skillset to update. This is a required path parameter. |
| `visibility` | string ("private" | "protected" | "public") | No | Visibility levels for a skillset. |
| `description` | string | No | A description explaining the purpose or contents of this skillset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Skillset Ability

**Slug:** `CHATBOTKIT_UPDATE_SKILLSET_ABILITY`

Tool to update an existing ability within a skillset. Use when you need to modify ability properties like name, description, instruction, or associated resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the ability as key-value pairs. |
| `name` | string | No | Updated name for the ability. Provide a clear, descriptive name. |
| `botId` | string | No | The ID of the bot associated with this ability. |
| `fileId` | string | No | The ID of a file resource associated with this ability. |
| `spaceId` | string | No | The ID of the space this ability belongs to. |
| `secretId` | string | No | Updated ID of the secret for authentication. Use when the ability needs to authenticate with external services. |
| `abilityId` | string | Yes | The unique identifier of the ability to update. |
| `skillsetId` | string | Yes | The unique identifier of the skillset containing the ability to update. |
| `blueprintId` | string | No | The ID of the blueprint this ability is based on or should be updated to use. |
| `description` | string | No | Updated description of what the ability does. Explains the purpose and functionality. |
| `instruction` | string | No | Updated instruction including fetch block for external API calls. Defines how the ability should interact with external services or APIs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Skillset (GraphQL)

**Slug:** `CHATBOTKIT_UPDATE_SKILLSET_GRAPHQL`

Tool to update an existing skillset using GraphQL mutation. Use when you need to modify a skillset's properties such as name, description, or abilities via the GraphQL API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | object | Yes | Input object containing the fields to update for the skillset. |
| `skillsetId` | string | Yes | The unique identifier of the skillset to update. This is a required parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Slack Integration

**Slug:** `CHATBOTKIT_UPDATE_SLACK_INTEGRATION`

Tool to update an existing Slack integration's configuration. Use when you need to modify Slack integration settings such as bot token, signing secret, session duration, contact collection, ratings, or associated bot/blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | Updated name for the Slack integration. |
| `botId` | string | No | The ID of the bot to use for this Slack integration. Use the List Bots action to find available bot IDs. |
| `ratings` | boolean | No | Whether to enable ratings feature allowing users to rate bot responses. |
| `botToken` | string | No | The Slack Bot User OAuth Token from OAuth & Permissions page. Required for bot functionality. |
| `userToken` | string | No | Slack user token for additional permissions beyond bot token capabilities. |
| `references` | boolean | No | Whether to enable references feature for providing source citations. |
| `autoRespond` | string | No | Auto-respond configuration for the Slack integration. Determines when the bot responds to messages. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this Slack integration. |
| `description` | string | No | Updated description explaining the purpose of this Slack integration. |
| `signingSecret` | string | No | The Slack signing secret from your Slack App's Basic Information section. Used to verify requests from Slack. |
| `sessionDuration` | integer | No | Session duration in seconds. Defines how long a conversation session remains active. |
| `visibleMessages` | integer | No | Number of visible messages to display in the conversation history. |
| `contactCollection` | boolean | No | Whether to enable contact collection for tracking user interactions. |
| `slackIntegrationId` | string | Yes | The unique identifier of the Slack integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Space

**Slug:** `CHATBOTKIT_UPDATE_SPACE`

Tool to update an existing space's configuration and properties. Use when you need to modify a space's name, description, associated blueprint, contact, or other settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the space as key-value pairs. |
| `name` | string | No | Updated name for the space. Provide a clear, descriptive name. |
| `alias` | string | No | The unique alias for the space. This provides a human-readable identifier. |
| `spaceId` | string | Yes | The unique identifier of the space to update. This is a required path parameter. |
| `contactId` | string | No | The ID of the contact to associate with this space. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this space. |
| `description` | string | No | Updated description explaining the purpose or functionality of the space. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Support Integration

**Slug:** `CHATBOTKIT_UPDATE_SUPPORT_INTEGRATION`

Tool to update an existing Support integration's configuration and properties. Use when you need to modify a Support integration's email, name, description, or associated bot/blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the Support integration as key-value pairs. |
| `name` | string | No | The name of the Support integration. This is the display name that identifies the integration. |
| `botId` | string | No | The unique identifier of the bot to associate with this Support integration. |
| `email` | string | No | The email address associated with this Support integration. Used for receiving and managing support requests. |
| `blueprintId` | string | No | The ID of the blueprint this Support integration is based on or should be updated to use. |
| `description` | string | No | A description explaining the purpose or configuration of this Support integration. |
| `supportIntegrationId` | string | Yes | The unique identifier of the Support integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Task

**Slug:** `CHATBOTKIT_UPDATE_TASK`

Tool to update an existing task's configuration and properties. Use when you need to modify a task's schedule, bot/contact associations, or execution parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | No | Updated bot ID to associate with this task. |
| `taskId` | string | Yes | The unique identifier of the task to update. This is a required path parameter. |
| `maxTime` | number | No | Updated maximum time allowed for this task execution (in seconds or milliseconds). |
| `schedule` | string | No | Updated schedule for the task using cron expression format (e.g., '0 9 * * *' for 9 AM daily). |
| `contactId` | string | No | Updated contact ID to associate with this task. |
| `maxIterations` | number | No | Updated maximum number of iterations allowed for this task. |
| `sessionDuration` | number | No | Updated session duration for the task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Telegram Integration

**Slug:** `CHATBOTKIT_UPDATE_TELEGRAM_INTEGRATION`

Tool to update an existing Telegram integration's configuration and properties. Use when you need to modify a Telegram integration's settings such as bot token, session duration, attachment handling, or associated bot/blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the Telegram integration as key-value pairs. |
| `name` | string | No | The name of the Telegram integration. This is the display name that identifies the integration. |
| `botId` | string | No | The unique identifier of the bot to associate with this Telegram integration. |
| `botToken` | string | No | The Telegram bot token for authentication. Obtained from BotFather when creating a Telegram bot. |
| `attachments` | boolean | No | Whether to enable attachment handling for messages received through this Telegram integration. |
| `blueprintId` | string | No | The ID of the blueprint this Telegram integration is based on or should be updated to use. |
| `description` | string | No | A description explaining the purpose or configuration of this Telegram integration. |
| `sessionDuration` | integer | No | Duration in milliseconds for how long a Telegram conversation session should remain active. |
| `contactCollection` | boolean | No | Whether to enable automatic contact collection from Telegram users. |
| `telegramIntegrationId` | string | Yes | The unique identifier of the Telegram integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Trigger Integration

**Slug:** `CHATBOTKIT_UPDATE_TRIGGER_INTEGRATION`

Tool to update an existing Trigger integration's configuration. Use when you need to modify Trigger integration settings such as name, description, metadata, associated bot/blueprint, or authentication settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Additional metadata to associate with the Trigger integration as key-value pairs. |
| `name` | string | No | The name of the Trigger integration. This is the display name that identifies the integration. |
| `botId` | string | No | The unique identifier of the bot to associate with this Trigger integration. |
| `blueprintId` | string | No | The ID of the blueprint this Trigger integration is based on or should be updated to use. |
| `description` | string | No | A description explaining the purpose or configuration of this Trigger integration. |
| `authenticate` | boolean | No | Whether to enable authentication for this Trigger integration. When true, the trigger will authenticate before executing. |
| `triggerIntegrationId` | string | Yes | The unique identifier of the Trigger integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Twilio Integration

**Slug:** `CHATBOTKIT_UPDATE_TWILIO_INTEGRATION`

Tool to update an existing Twilio integration's configuration. Use when you need to modify Twilio integration settings such as name, description, session duration, contact collection, or associated bot/blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | Updated name for the Twilio integration. |
| `botId` | string | No | The ID of the bot to use for this Twilio integration. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this Twilio integration. |
| `description` | string | No | Updated description explaining the purpose of this Twilio integration. |
| `sessionDuration` | integer | No | Session duration in seconds. Controls how long a conversation session remains active. |
| `contactCollection` | boolean | No | Whether to enable contact collection for this Twilio integration. |
| `twilioIntegrationId` | string | Yes | The unique identifier of the Twilio integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update WhatsApp Integration

**Slug:** `CHATBOTKIT_UPDATE_WHATS_APP_INTEGRATION`

Tool to update an existing WhatsApp integration's configuration. Use when you need to modify WhatsApp integration settings such as access token, phone number ID, session duration, contact collection, or associated bot/blueprint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | Updated name for the WhatsApp integration. |
| `botId` | string | No | The ID of the bot to use for this WhatsApp integration. |
| `accessToken` | string | No | The WhatsApp access token for authentication with the WhatsApp Business API. |
| `attachments` | boolean | No | Whether to enable attachment support for this WhatsApp integration. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this WhatsApp integration. |
| `description` | string | No | Updated description explaining the purpose of this WhatsApp integration. |
| `phoneNumberId` | string | No | The WhatsApp phone number ID associated with this integration. |
| `sessionDuration` | integer | No | Session duration in seconds. Controls how long a conversation session remains active. |
| `contactCollection` | boolean | No | Whether to enable contact collection for this WhatsApp integration. |
| `whatsappIntegrationId` | string | Yes | The unique identifier of the WhatsApp integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Widget Integration

**Slug:** `CHATBOTKIT_UPDATE_WIDGET_INTEGRATION`

Tool to update an existing Widget integration's configuration. Use when you need to modify widget settings such as title, theme, placeholder text, auto-scroll behavior, or other display and functionality options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form` | boolean | No | Enable form functionality in the widget. |
| `math` | boolean | No | Enable mathematical notation rendering in the widget. |
| `meta` | object | No | Optional key-value metadata pairs for organizing or tagging the integration. |
| `name` | string | No | Updated name for the Widget integration. |
| `botId` | string | No | The ID of the bot to use for this Widget integration. |
| `intro` | string | No | Introduction text to display in the widget. |
| `theme` | string | No | Theme for the widget appearance. |
| `title` | string | No | Title to display in the widget header. |
| `tools` | boolean | No | Enable tools functionality in the widget. |
| `layout` | string | No | Layout style for the widget. |
| `origin` | string | No | Origin URL where the widget is allowed to be embedded. |
| `stream` | boolean | No | Enable streaming responses in the widget. |
| `unfurl` | boolean | No | Enable link unfurling in messages. |
| `initial` | string | No | Initial message to display when the widget loads. |
| `plugins` | string | No | Plugins configuration for the widget. |
| `verbose` | boolean | No | Enable verbose mode for detailed logging. |
| `voiceIn` | boolean | No | Enable voice input in the widget. |
| `carousel` | boolean | No | Enable carousel display for messages in the widget. |
| `language` | string | No | Language code for the widget interface. |
| `maximize` | boolean | No | Start the widget in maximized mode. |
| `voiceOut` | boolean | No | Enable voice output in the widget. |
| `poweredBy` | boolean | No | Display 'Powered by ChatBotKit' branding in the widget. |
| `autoScroll` | boolean | No | Enable auto-scrolling to the latest message in the widget. |
| `startFirst` | boolean | No | Start the conversation immediately when the widget loads. |
| `attachments` | boolean | No | Enable file attachments in the widget. |
| `blueprintId` | string | No | The ID of the blueprint to associate with this Widget integration. |
| `description` | string | No | Updated description explaining the purpose of this Widget integration. |
| `messagePeek` | boolean | No | Enable message peek functionality. |
| `placeholder` | string | No | Placeholder text for the message input field. |
| `sessionDuration` | number | No | Session duration in seconds. |
| `contactCollection` | boolean | No | Enable collection of contact information from users. |
| `exportConversation` | boolean | No | Enable users to export their conversation history. |
| `restartConversation` | boolean | No | Enable users to restart the conversation. |
| `widgetIntegrationId` | string | Yes | The unique identifier of the Widget integration to update. This is a required path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Conversation Attachment

**Slug:** `CHATBOTKIT_UPLOAD_CONVERSATION_ATTACHMENT`

Upload a file as a conversation attachment in ChatBotKit. This action creates an attachment record and returns upload details. Use when you need to attach files (documents, images, etc.) to a conversation for the bot to reference.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload as a conversation attachment. |
| `conversationId` | string | Yes | The unique identifier of the conversation to attach the file to. Obtain this ID from the list_conversations action or when creating a new conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File

**Slug:** `CHATBOTKIT_UPLOAD_FILE`

Tool to upload content to an existing file resource in ChatBotKit. Use when you need to populate a file resource with actual file data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload. |
| `fileId` | string | Yes | The unique identifier of the file to upload content to. This ID should be obtained from a file creation action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Conversation Contact

**Slug:** `CHATBOTKIT_UPSERT_CONVERSATION_CONTACT`

Tool to upsert (create or update) contact information for a conversation in ChatBotKit. Use when you need to associate contact details like email, phone, or nickname with a conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `nick` | string | No | The nickname or display name of the contact. |
| `email` | string | No | The email address of the contact. |
| `phone` | string | No | The phone number of the contact. Must be in E.164 format with separators (e.g., +1-234-567-8900). |
| `fingerprint` | string | No | A unique fingerprint identifier for the contact. Must be at least 16 characters long. |
| `conversationId` | string | Yes | The unique identifier of the conversation to upsert contact for. Obtain this ID from the list_conversations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upvote Bot

**Slug:** `CHATBOTKIT_UPVOTE_BOT`

Tool to upvote a bot in ChatBotKit. Use when you want to endorse or rate a bot positively, providing optional feedback on why the bot deserves recognition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `botId` | string | Yes | The unique identifier of the bot to upvote. Use the List Bots action to find available bot IDs. |
| `value` | integer | No | The value of the upvote, ranging from 1 to 100. Defaults to 100 if not specified. Higher values indicate stronger endorsement. |
| `reason` | string | No | Optional reason for upvoting the bot. Provide context for why the bot is being upvoted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upvote Conversation

**Slug:** `CHATBOTKIT_UPVOTE_CONVERSATION`

Tool to upvote a conversation in ChatBotKit. Use when you want to endorse or rate a conversation positively, providing optional feedback on quality.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | integer | No | The value of the upvote, ranging from 1 to 100. Defaults to 100 if not specified. Higher values indicate stronger endorsement. |
| `reason` | string | No | Optional reason for upvoting the conversation. Provide context for why the conversation is being upvoted. |
| `conversationId` | string | Yes | The unique identifier of the conversation to upvote. Use the List Conversations action to find available conversation IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upvote Conversation Message

**Slug:** `CHATBOTKIT_UPVOTE_CONVERSATION_MESSAGE`

Tool to upvote a conversation message in ChatBotKit. Use when you want to endorse or rate a specific message positively within a conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | integer | No | The value of the upvote, ranging from 1 to 100. Defaults to 100 if not specified. Higher values indicate stronger endorsement. |
| `reason` | string | No | Optional reason for upvoting the message. Provide context for why the message is being upvoted. |
| `messageId` | string | Yes | The unique identifier of the message to upvote. Use List Conversation Messages action to find available message IDs within a conversation. |
| `conversationId` | string | Yes | The unique identifier of the conversation containing the message to upvote. Use List Conversations action to find available conversation IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Secret

**Slug:** `CHATBOTKIT_VERIFY_SECRET`

Tool to verify a secret in ChatBotKit. Use when you need to check the authentication status of a secret credential.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secretId` | string | Yes | The ID of the secret to be verified |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
