> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to ChatBotKit

The ChatBotKit connector lets your AI agent act in each user's ChatBotKit account. Each user connects their own ChatBotKit access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.

**Authentication:** Bearer Token
**Categories:** AI
**Tools:** 59: 27 read, 24 write, 8 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CHATBOTKIT)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the ChatBotKit connection

   In **AgentKit > Connections**, create a ChatBotKit connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'chatbotkit'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize ChatBotKit:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'chatbotkit_blueprints_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "chatbotkit"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize ChatBotKit:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="chatbotkit_blueprints_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their ChatBotKit credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'chatbotkit_blueprint_get',
  toolInput: {
    blueprint_id: '<blueprint_id>',
  },
  connector: 'chatbotkit',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="chatbotkit_blueprint_get",
    tool_input={
        "blueprint_id": "<blueprint_id>",
    },
    connection_name="chatbotkit",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `chatbotkit_blueprint_get`

Get Blueprint · Read-only

Get one blueprint.
Returns an object with alias, name, description, meta, id, createdAt, updatedAt, contactId, visibility.
Use chatbotkit_blueprint_get for one blueprint.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `blueprint_id` (`string`, required): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"blueprint_id":"<blueprint_id>"}`

### `chatbotkit_blueprints_list`

List Blueprints · Read-only

List blueprints (groups of related bots, datasets and skillsets).
Returns items[] (each with alias, name, description, meta, id, createdAt, updatedAt, contactId) plus cursor.
Use chatbotkit_blueprints_list to find a blueprint ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{}`

### `chatbotkit_bot_get`

Get Bot · Read-only

Get one bot with its model, backstory, dataset and skillset.
Returns an object with alias, name, description, meta, id, createdAt, updatedAt, model, backstory, datasetId, and more.
Use chatbotkit_bot_get for one bot.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `bot_id` (`string`, required): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"bot_id":"<bot_id>"}`

### `chatbotkit_bot_usage_get`

Get Bot Usage · Read-only

Get token and conversation usage of a bot.
Returns an object with tokens, conversations, messages.
Use chatbotkit_bot_usage_get for one bot. Use chatbotkit_usage_get for the account.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `bot_id` (`string`, required): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `from` (`string`, optional): Start date for the period (ISO 8601 format) Example: 2026-01-31T12:00:00Z
- `to` (`string`, optional): End date for the period (ISO 8601 format) Example: 2026-01-31T12:00:00Z

Example input: `{"bot_id":"<bot_id>"}`

### `chatbotkit_bots_list`

List Bots · Read-only

List the bots in the account.
Returns items[] (each with alias, name, description, meta, id, createdAt, updatedAt, model) plus cursor.
Use chatbotkit_bots_list to find a bot ID. Use chatbotkit_bot_get for one bot.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{}`

### `chatbotkit_contact_conversations_list`

List Contact Conversations · Read-only

List the conversations of a contact.
Returns items[] (each with name, description, meta, id, createdAt, updatedAt, botId, contactId) plus cursor.
Use chatbotkit_contact_conversations_list to see a user history.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, required): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{"contact_id":"<contact_id>"}`

### `chatbotkit_contact_get`

Get Contact · Read-only

Get one contact.
Returns an object with name, description, meta, id, createdAt, updatedAt, fingerprint, email, phone, nick, and more.
Use chatbotkit_contact_get for one contact.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, required): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"contact_id":"<contact_id>"}`

### `chatbotkit_contacts_list`

List Contacts · Read-only

List contacts (end users who talk to your bots).
Returns items[] (each with name, description, meta, id, createdAt, updatedAt, fingerprint, email) plus cursor.
Use chatbotkit_contacts_list to find a contact ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{}`

### `chatbotkit_conversation_get`

Get Conversation · Read-only

Get one conversation with its bot and settings.
Returns an object with name, description, meta, id, createdAt, updatedAt, botId, contactId, taskId, expiresAt.
Use chatbotkit_conversation_get for one conversation. Use chatbotkit_conversation_messages_list for its messages.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"conversation_id":"<conversation_id>"}`

### `chatbotkit_conversation_message_get`

Get Conversation Message · Read-only

Get one message of a conversation.
Returns an object with name, description, meta, id, createdAt, updatedAt, type, text.
Use chatbotkit_conversation_message_get for one message.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `message_id` (`string`, required): Message ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"conversation_id":"<conversation_id>","message_id":"<message_id>"}`

### `chatbotkit_conversation_messages_list`

List Conversation Messages · Read-only

List the messages of a conversation.
Returns items[] (each with name, description, meta, id, createdAt, updatedAt, type, text) plus cursor.
Use chatbotkit_conversation_messages_list to read a transcript.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{"conversation_id":"<conversation_id>"}`

### `chatbotkit_conversations_list`

List Conversations · Read-only

List conversations.
Returns items[] (each with name, description, meta, id, createdAt, updatedAt, botId, contactId) plus cursor.
Use chatbotkit_conversations_list to find a conversation ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{}`

### `chatbotkit_dataset_get`

Get Dataset · Read-only

Get one dataset with its settings.
Returns an object with alias, name, description, meta, id, createdAt, updatedAt, blueprintId, contactId, reranker, and more.
Use chatbotkit_dataset_get for one dataset.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dataset_id` (`string`, required): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"dataset_id":"<dataset_id>"}`

### `chatbotkit_dataset_records_list`

List Dataset Records · Read-only

List the records of a dataset.
Returns items[] (each with id, createdAt, updatedAt, text, source) plus cursor.
Use chatbotkit_dataset_records_list to browse knowledge.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dataset_id` (`string`, required): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{"dataset_id":"<dataset_id>"}`

### `chatbotkit_dataset_search`

Search Dataset · Read-only

Search a dataset for records relevant to a query (semantic search).
Returns an object with id, records.
Use chatbotkit_dataset_search to check what a bot would retrieve.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dataset_id` (`string`, required): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `search` (`string`, required): Text to search for. Example: refund policy
- `filter` (`object`, optional): Optional filter on record metadata, as an object of field to value. Example: {"category": "billing"}

Example input: `{"dataset_id":"<dataset_id>","search":"<search>"}`

### `chatbotkit_datasets_list`

List Datasets · Read-only

List datasets (knowledge bases).
Returns items[] (each with alias, name, description, meta, id, createdAt, updatedAt, blueprintId) plus cursor.
Use chatbotkit_datasets_list to find a dataset ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{}`

### `chatbotkit_file_get`

Get File · Read-only

Get one file metadata.
Returns an object with alias, name, description, meta, id, createdAt, updatedAt, blueprintId, contactId, visibility.
Use chatbotkit_file_get for one file.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `file_id` (`string`, required): File ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"file_id":"<file_id>"}`

### `chatbotkit_files_list`

List Files · Read-only

List uploaded files.
Returns items[] (each with alias, name, description, meta, id, createdAt, updatedAt, blueprintId) plus cursor.
Use chatbotkit_files_list to find a file ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{}`

### `chatbotkit_memories_list`

List Memories · Read-only

List stored memories (facts bots remember).
Returns items[] (each with name, description, meta, id, createdAt, updatedAt, contactId, botId) plus cursor.
Use chatbotkit_memories_list to browse. Use chatbotkit_memory_search to find relevant memories.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{}`

### `chatbotkit_memory_search`

Search Memories · Read-only

Search memories for records matching a query.
Returns items[] (each with id, text, meta).
Use chatbotkit_memory_search to find what bots remember about a topic.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `search` (`string`, required): Text to search for. Example: refund policy
- `bot_id` (`string`, optional): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"search":"<search>"}`

### `chatbotkit_platform_models_list`

List Models · Read-only

List the AI models available on the platform.
Returns items[] (each with name, description, meta, id, createdAt, updatedAt, type, default) plus cursor.
Use chatbotkit_platform_models_list to pick a model for a bot.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25
- `type` (`string`, optional): The type of models to list. One of: language, image, video, rerank, decision. Example: language. One of: `language`, `image`, `video`, `rerank`, `decision`.

Example input: `{}`

### `chatbotkit_skillset_abilities_list`

List Skillset Abilities · Read-only

List the abilities in a skillset.
Returns items[] (each with alias, name, description, meta, id, createdAt, updatedAt, blueprintId) plus cursor.
Use chatbotkit_skillset_abilities_list to find an ability ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `skillset_id` (`string`, required): Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{"skillset_id":"<skillset_id>"}`

### `chatbotkit_skillset_get`

Get Skillset · Read-only

Get one skillset.
Returns an object with alias, name, description, meta, id, createdAt, updatedAt, blueprintId, contactId, visibility, and more.
Use chatbotkit_skillset_get for one skillset.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `skillset_id` (`string`, required): Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"skillset_id":"<skillset_id>"}`

### `chatbotkit_skillsets_list`

List Skillsets · Read-only

List skillsets (groups of abilities a bot can use).
Returns items[] (each with alias, name, description, meta, id, createdAt, updatedAt, blueprintId) plus cursor.
Use chatbotkit_skillsets_list to find a skillset ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{}`

### `chatbotkit_task_get`

Get Task · Read-only

Get one task with its bot, schedule and status.
Returns an object with name, description, meta, id, createdAt, updatedAt, blueprintId, contactId, botId, schedule, and more.
Use chatbotkit_task_get for one task.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_id` (`string`, required): Task ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"task_id":"<task_id>"}`

### `chatbotkit_tasks_list`

List Tasks · Read-only

List tasks (scheduled or on-demand bot jobs).
Returns items[] (each with name, description, meta, id, createdAt, updatedAt, blueprintId, contactId) plus cursor.
Use chatbotkit_tasks_list to find a task ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `blueprint_id` (`string`, optional): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `bot_id` (`string`, optional): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `cursor` (`string`, optional): Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`string`, optional): Free-form metadata object. Example: {"team": "support"}
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `status` (`string`, optional): Filter by task status. One of: idle, running, canceled. Example: idle. One of: `idle`, `running`, `canceled`.
- `take` (`integer`, optional): Number of items to return. Example: 25

Example input: `{}`

### `chatbotkit_usage_get`

Get Usage · Read-only

Get the account usage for the current billing period.
Returns an object with tokens, conversations, messages, database.
Use chatbotkit_usage_get to check token and conversation consumption.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `chatbotkit_bot_clone`

Clone Bot · Write

Create a copy of a bot.
Returns an object with id.
Use chatbotkit_bot_clone to try changes on a copy.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `bot_id` (`string`, required): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"bot_id":"<bot_id>"}`

### `chatbotkit_bot_create`

Create Bot · Write

Create a bot with a model, backstory and optional dataset and skillset.
Returns an object with id.
Use chatbotkit_bot_create for a new chatbot or agent.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `alias` (`string`, optional): Unique alias. Example: support-bot
- `backstory` (`string`, optional): Instructions (system prompt) for the bot. Example: You are a friendly support agent for Acme.
- `blueprint_id` (`string`, optional): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `dataset_id` (`string`, optional): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `model` (`string`, optional): Model name, from chatbotkit_platform_models_list. Example: gpt-4o
- `moderation` (`boolean`, optional): The moderation flag for this configuration. Example: true
- `name` (`string`, optional): Name. Example: Support bot
- `privacy` (`boolean`, optional): The privacy flag for this configuration. Example: true
- `skillset_id` (`string`, optional): Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `visibility` (`string`, optional): Visibility. One of: private, protected, public. Example: private. One of: `private`, `protected`, `public`.

Example input: `{}`

### `chatbotkit_bot_update`

Update Bot · Write

Update a bot.
Returns an object with id.
Use chatbotkit_bot_update to change a bot backstory, model, dataset or skillset.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `bot_id` (`string`, required): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `alias` (`string`, optional): Unique alias. Example: support-bot
- `backstory` (`string`, optional): Instructions (system prompt) for the bot. Example: You are a friendly support agent for Acme.
- `blueprint_id` (`string`, optional): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `dataset_id` (`string`, optional): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `model` (`string`, optional): Model name, from chatbotkit_platform_models_list. Example: gpt-4o
- `moderation` (`boolean`, optional): The moderation flag for this configuration. Example: true
- `name` (`string`, optional): Name. Example: Support bot
- `privacy` (`boolean`, optional): The privacy flag for this configuration. Example: true
- `skillset_id` (`string`, optional): Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `visibility` (`string`, optional): Visibility. One of: private, protected, public. Example: private. One of: `private`, `protected`, `public`.

Example input: `{"bot_id":"<bot_id>"}`

### `chatbotkit_completion_create`

Get Stateless Completion · Write

Generate the next bot message for a list of messages without saving a conversation.
Returns an object with text, usage, end.
Use chatbotkit_completion_create for a one-off reply. Use chatbotkit_conversation_reply to keep history.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `messages` (`array`, required): Messages so far, each with a type (user, bot, context, ...) and text. Example: [{"type": "user", "text": "What are your opening hours?"}]
- `bot_id` (`string`, optional): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`object`, optional): Contact ID to associate with the completion. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"messages":[{"type":"user","text":"What are your opening hours?"}]}`

### `chatbotkit_contact_create`

Create Contact · Write

Create a contact.
Returns an object with id.
Use chatbotkit_contact_create for a new end user. Use chatbotkit_contact_ensure to create only if missing.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, optional): Description. Example: Answers product questions
- `email` (`string`, optional): Contact email. Example: jane@example.com
- `fingerprint` (`string`, optional): Your own unique identifier for the contact. Example: user-4711
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot
- `nick` (`string`, optional): Nickname. Example: jane
- `phone` (`string`, optional): Contact phone. Example: +15555550101
- `preferences` (`string`, optional): The preferences of the contact. Example: example
- `verified_at` (`number`, optional): The timestamp (ms) when the contact was verified. Example: 10

Example input: `{}`

### `chatbotkit_contact_ensure`

Ensure Contact · Write

Return the contact with the given fingerprint, email or phone, creating it if missing.
Returns an object with id.
Use chatbotkit_contact_ensure to map your users to ChatBotKit contacts.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `fingerprint` (`string`, required): Your own unique identifier for the contact. Example: user-4711
- `description` (`string`, optional): Description. Example: Answers product questions
- `email` (`string`, optional): Contact email. Example: jane@example.com
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot
- `nick` (`string`, optional): Nickname. Example: jane
- `phone` (`string`, optional): Contact phone. Example: +15555550101
- `preferences` (`string`, optional): The preferences of the contact. Example: example
- `verified_at` (`number`, optional): The timestamp (ms) when the contact was verified. Example: 10

Example input: `{"fingerprint":"<fingerprint>"}`

### `chatbotkit_contact_update`

Update Contact · Write

Update a contact.
Returns an object with id.
Use chatbotkit_contact_update to change contact details.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, required): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `email` (`string`, optional): Contact email. Example: jane@example.com
- `fingerprint` (`string`, optional): Your own unique identifier for the contact. Example: user-4711
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot
- `nick` (`string`, optional): Nickname. Example: jane
- `phone` (`string`, optional): Contact phone. Example: +15555550101
- `preferences` (`string`, optional): The preferences of the contact. Example: example
- `verified_at` (`number`, optional): The timestamp (ms) when the contact was verified. Example: 10

Example input: `{"contact_id":"<contact_id>"}`

### `chatbotkit_conversation_create`

Create Conversation · Write

Create a conversation with a bot (or inline model and backstory), optionally with starting messages.
Returns an object with id, messages.
Use chatbotkit_conversation_create before chatbotkit_conversation_reply to chat statefully.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `bot_id` (`string`, optional): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `messages` (`array`, optional): Messages so far, each with a type (user, bot, context, ...) and text. Example: [{"type": "user", "text": "What are your opening hours?"}]
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot
- `space_id` (`string`, optional): The space id assigned to this conversation. Example: abc123
- `task_id` (`string`, optional): The task id assigned to this conversation. Example: abc123

Example input: `{}`

### `chatbotkit_conversation_message_create`

Create Conversation Message · Write

Insert a message of any type (user, bot, context) into a conversation.
Returns an object with id, entities.
Use chatbotkit_conversation_message_create to add context or a scripted bot message.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `conversation_id` (`string`, required): Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `text` (`string`, required): Text. Example: What are your opening hours?
- `type` (`string`, required): Message type. One of: user, bot, reasoning, context, instruction, backstory, activity, checkpoint. Example: context. One of: `user`, `bot`, `reasoning`, `context`, `instruction`, `backstory`, `activity`, `checkpoint`.
- `description` (`string`, optional): Description. Example: Answers product questions
- `entities` (`array`, optional): Known entities. Example: ["value"]
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot

Example input: `{"conversation_id":"<conversation_id>","text":"<text>","type":"user"}`

### `chatbotkit_conversation_message_send`

Send Message · Write

Add a user message to a conversation without generating a reply.
Returns an object with id, entities.
Use chatbotkit_conversation_message_send then chatbotkit_conversation_reply_receive to split sending from replying.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `conversation_id` (`string`, required): Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `text` (`string`, required): User message to add. Example: I need help with my order.
- `entities` (`array`, optional): Known entities. Example: ["value"]

Example input: `{"conversation_id":"<conversation_id>","text":"<text>"}`

### `chatbotkit_conversation_reply`

Send Message and Get Reply · Write

Send a user message to a conversation and get the bot reply in one call.
Returns an object with id, text, usage, end.
Use chatbotkit_conversation_reply to chat in a saved conversation. Use chatbotkit_completion_create for a one-off reply without saving.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `conversation_id` (`string`, required): Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `entities` (`array`, optional): Known entities. Example: ["value"]
- `text` (`string`, optional): User message to send. Example: What are your opening hours?

Example input: `{"conversation_id":"<conversation_id>"}`

### `chatbotkit_conversation_reply_receive`

Receive Reply · Write

Generate the bot reply to the latest message in a conversation.
Returns an object with id, text, usage.
Use chatbotkit_conversation_reply_receive after chatbotkit_conversation_message_send.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `conversation_id` (`string`, required): Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"conversation_id":"<conversation_id>"}`

### `chatbotkit_conversation_update`

Update Conversation · Write

Update a conversation settings.
Returns an object with id.
Use chatbotkit_conversation_update to change a conversation bot or metadata.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `bot_id` (`string`, optional): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `expires_at` (`integer`, optional): Epoch-ms timestamp at which the conversation is automatically deleted; null clears any expiry. Example: 10
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot
- `space_id` (`string`, optional): The space id assigned to this conversation. Example: abc123
- `task_id` (`string`, optional): The task id assigned to this conversation. Example: abc123

Example input: `{"conversation_id":"<conversation_id>"}`

### `chatbotkit_dataset_create`

Create Dataset · Write

Create a dataset (knowledge base) for bots to search.
Returns an object with id.
Use chatbotkit_dataset_create, then add content with chatbotkit_dataset_record_create.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `alias` (`string`, optional): Unique alias. Example: support-bot
- `blueprint_id` (`string`, optional): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `match_instruction` (`string`, optional): An instruction to include before found records. Example: example
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `mismatch_instruction` (`string`, optional): An instruction to include if no records where found. Example: example
- `name` (`string`, optional): Name. Example: Support bot
- `record_max_tokens` (`number`, optional): The total number of tokens for each record. Example: 10
- `reranker` (`string`, optional): The reranker class for the dataset. Example: example
- `search_max_records` (`number`, optional): The total number of records to return during search. Example: 10
- `search_max_tokens` (`number`, optional): The total number of tokens to use during search. Example: 10
- `search_min_score` (`number`, optional): The minimum score to filter search results by. Example: 10
- `separators` (`string`, optional): A list of separators to use when tokenizing text. Example: example
- `visibility` (`string`, optional): Visibility. One of: private, protected, public. Example: private. One of: `private`, `protected`, `public`.

Example input: `{}`

### `chatbotkit_dataset_record_create`

Create Dataset Record · Write

Add a text record to a dataset.
Returns an object with id.
Use chatbotkit_dataset_record_create to teach a bot a fact.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `dataset_id` (`string`, required): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `text` (`string`, required): Record text. Example: Our support line is open Monday to Friday, 9:00 to 17:00 CET.
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `source` (`string`, optional): Where the text came from. Example: https://example.com/support

Example input: `{"dataset_id":"<dataset_id>","text":"<text>"}`

### `chatbotkit_dataset_record_update`

Update Dataset Record · Write

Update a dataset record.
Returns an object with id.
Use chatbotkit_dataset_record_update to correct knowledge.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dataset_id` (`string`, required): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `record_id` (`string`, required): Record ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `source` (`string`, optional): The source to update the record with. Example: example
- `text` (`string`, optional): New record text. Example: Our support line is open Monday to Saturday.

Example input: `{"dataset_id":"<dataset_id>","record_id":"<record_id>"}`

### `chatbotkit_dataset_update`

Update Dataset · Write

Update a dataset settings.
Returns an object with id.
Use chatbotkit_dataset_update to rename a dataset or tune retrieval.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dataset_id` (`string`, required): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `alias` (`string`, optional): Unique alias. Example: support-bot
- `blueprint_id` (`string`, optional): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `match_instruction` (`string`, optional): An instruction to include before found records. Example: example
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `mismatch_instruction` (`string`, optional): An instruction to include if no records where found. Example: example
- `name` (`string`, optional): Name. Example: Support bot
- `record_max_tokens` (`number`, optional): The total number of tokens to for each record. Example: 10
- `reranker` (`string`, optional): The reranker class for the dataset. Example: example
- `search_max_records` (`number`, optional): The total number of records to return during search. Example: 10
- `search_max_tokens` (`number`, optional): The total number of tokens to use during search. Example: 10
- `search_min_score` (`number`, optional): The minimum score to filter search results by. Example: 10
- `separators` (`string`, optional): A list of separators to use when tokenizing text. Example: example
- `visibility` (`string`, optional): Visibility. One of: private, protected, public. Example: private. One of: `private`, `protected`, `public`.

Example input: `{"dataset_id":"<dataset_id>"}`

### `chatbotkit_memory_create`

Create Memory · Write

Store a memory for a bot or contact.
Returns an object with id.
Use chatbotkit_memory_create to make a bot remember a fact.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `text` (`string`, required): Memory text. Example: Jane prefers email over phone.
- `bot_id` (`string`, optional): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `expires_at` (`integer`, optional): Epoch-ms timestamp at which the memory is automatically deleted; null for no expiry. Example: 10
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot

Example input: `{"text":"<text>"}`

### `chatbotkit_skillset_ability_create`

Create Ability · Write

Add an ability (an instruction-defined action) to a skillset.
Returns an object with id.
Use chatbotkit_skillset_ability_create to give bots a new capability.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `skillset_id` (`string`, required): Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `alias` (`string`, optional): Unique alias. Example: support-bot
- `blueprint_id` (`string`, optional): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `instruction` (`string`, optional): Ability definition: what it does and how, often a template referencing an action or secret. Example: Fetch the weather for the given city from https://wttr.in/<city>?format=3
- `linked_bot_id` (`string`, optional): The ID of the bot associated with the ability. Example: abc123
- `linked_computer_id` (`string`, optional): The ID of the computer the ability runs shell commands on. Example: abc123
- `linked_file_id` (`string`, optional): The ID of the file associated with the ability. Example: abc123
- `linked_secret_id` (`string`, optional): The ID of the secret associated with the ability. Example: abc123
- `linked_space_id` (`string`, optional): The ID of the space associated with the ability. Example: abc123
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot
- `state` (`string`, optional): The lifecycle state of a resource - toggle it on/off without deleting it. One of: enabled, disabled. Example: enabled. One of: `enabled`, `disabled`.

Example input: `{"skillset_id":"<skillset_id>"}`

### `chatbotkit_skillset_ability_execute`

Execute Ability · Write

Run one skillset ability directly with input parameters.
Returns an object with usage, error, result, messages.
Use chatbotkit_skillset_ability_execute to test an ability.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `ability_id` (`string`, required): Ability ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `skillset_id` (`string`, required): Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `input` (`string`, optional): The input to process with the ability. This can be structured text such as JSON or YAML for precise parameter control, or unstructured natural language text. When unstructured text is provided, the system will automatically detect and extract the relevant parameters from the input. Example: example

Example input: `{"ability_id":"<ability_id>","skillset_id":"<skillset_id>"}`

### `chatbotkit_skillset_create`

Create Skillset · Write

Create a skillset.
Returns an object with id.
Use chatbotkit_skillset_create, then add abilities with chatbotkit_skillset_ability_create.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `alias` (`string`, optional): Unique alias. Example: support-bot
- `blueprint_id` (`string`, optional): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot
- `state` (`string`, optional): The lifecycle state of a resource - toggle it on/off without deleting it. One of: enabled, disabled. Example: enabled. One of: `enabled`, `disabled`.
- `visibility` (`string`, optional): Visibility. One of: private, protected, public. Example: private. One of: `private`, `protected`, `public`.

Example input: `{}`

### `chatbotkit_skillset_update`

Update Skillset · Write

Update a skillset.
Returns an object with id.
Use chatbotkit_skillset_update to rename a skillset.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `skillset_id` (`string`, required): Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `alias` (`string`, optional): Unique alias. Example: support-bot
- `blueprint_id` (`string`, optional): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot
- `state` (`string`, optional): The lifecycle state of a resource - toggle it on/off without deleting it. One of: enabled, disabled. Example: enabled. One of: `enabled`, `disabled`.
- `visibility` (`string`, optional): Visibility. One of: private, protected, public. Example: private. One of: `private`, `protected`, `public`.

Example input: `{"skillset_id":"<skillset_id>"}`

### `chatbotkit_task_create`

Create Task · Write

Create a task that runs a bot on a schedule or on demand.
Returns an object with id.
Use chatbotkit_task_create for recurring agent work.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `blueprint_id` (`string`, optional): Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `bot_id` (`string`, optional): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `contact_id` (`string`, optional): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `description` (`string`, optional): Description. Example: Answers product questions
- `expires_at` (`number`, optional): An optional epoch-millisecond timestamp after which the task is automatically deleted. Pass null or omit for no expiry. Example: 10
- `max_calls` (`number`, optional): The maximum number of tool calls across the whole task run (0 or null for unbounded) Example: 10
- `max_iterations` (`number`, optional): The maximum number of iterations per task execution. Example: 10
- `max_time` (`number`, optional): The maximum time per task execution in milliseconds. Example: 10
- `meta` (`object`, optional): Free-form metadata object. Example: {"team": "support"}
- `name` (`string`, optional): Name. Example: Support bot
- `schedule` (`string`, optional): The schedule of the task. Cron expressions and date-based schedules are evaluated in the provided timezone when set. Example: example
- `session_duration` (`number`, optional): The session duration of the Widget integration. Example: 10
- `state` (`string`, optional): The lifecycle state of a resource - toggle it on/off without deleting it. One of: enabled, disabled. Example: enabled. One of: `enabled`, `disabled`.
- `timezone` (`string`, optional): An optional IANA timezone identifier used when evaluating the task schedule. Example: America/New_York

Example input: `{}`

### `chatbotkit_task_trigger`

Run Task · Write

Run a task now.
Returns an object with id.
Use chatbotkit_task_trigger to execute a task immediately.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `task_id` (`string`, required): Task ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"task_id":"<task_id>"}`

### `chatbotkit_bot_delete`

Delete Bot · Destructive

Delete a bot.
Returns an object with id.
Use chatbotkit_bot_delete to remove a bot for good.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `bot_id` (`string`, required): Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"bot_id":"<bot_id>"}`

### `chatbotkit_contact_delete`

Delete Contact · Destructive

Delete a contact.
Returns an object with id.
Use chatbotkit_contact_delete to remove an end user.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `contact_id` (`string`, required): Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"contact_id":"<contact_id>"}`

### `chatbotkit_conversation_delete`

Delete Conversation · Destructive

Delete a conversation and its messages.
Returns an object with id.
Use chatbotkit_conversation_delete to remove a conversation.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `conversation_id` (`string`, required): Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"conversation_id":"<conversation_id>"}`

### `chatbotkit_dataset_delete`

Delete Dataset · Destructive

Delete a dataset and its records.
Returns an object with id.
Use chatbotkit_dataset_delete to remove a knowledge base.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `dataset_id` (`string`, required): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"dataset_id":"<dataset_id>"}`

### `chatbotkit_dataset_record_delete`

Delete Dataset Record · Destructive

Delete a dataset record.
Returns an object with id.
Use chatbotkit_dataset_record_delete to remove outdated knowledge.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `dataset_id` (`string`, required): Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
- `record_id` (`string`, required): Record ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"dataset_id":"<dataset_id>","record_id":"<record_id>"}`

### `chatbotkit_memory_delete`

Delete Memory · Destructive

Delete a memory.
Returns an object with id.
Use chatbotkit_memory_delete to make a bot forget a fact.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `memory_id` (`string`, required): Memory ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"memory_id":"<memory_id>"}`

### `chatbotkit_skillset_delete`

Delete Skillset · Destructive

Delete a skillset and its abilities.
Returns an object with id.
Use chatbotkit_skillset_delete to remove a skillset.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `skillset_id` (`string`, required): Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"skillset_id":"<skillset_id>"}`

### `chatbotkit_task_delete`

Delete Task · Destructive

Delete a task.
Returns an object with id.
Use chatbotkit_task_delete to remove a task.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `task_id` (`string`, required): Task ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k

Example input: `{"task_id":"<task_id>"}`

## Related

Other AI connectors ([all 216](/agentkit/connectors/?category=ai)):

- [Chorus](/agentkit/connectors/chorus/): Scalekit connector, Username and password, 9 tools
- [Gong](/agentkit/connectors/gong/): Scalekit connector, OAuth, 69 tools
- [Jiminny](/agentkit/connectors/jiminny/): Scalekit connector, Access token, 27 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
