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.
- Tools
- 59
- What they doRead · write · destructive
- 27 · 24 · 827 read24 write8 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ChatBotKit connection
In AgentKit > Connections, create a ChatBotKit connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'chatbotkit'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'chatbotkit_blueprints_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "chatbotkit"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="chatbotkit_blueprints_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their ChatBotKit credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolchatbotkit_blueprint_getGet one blueprint.Read-onlyGet Blueprint
Get one blueprint. Returns an object with alias, name, description, meta, id, createdAt, updatedAt, contactId, visibility. Use chatbotkit_blueprint_get for one blueprint.
Inputs
blueprint_idstringrequired- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_blueprints_listList blueprints (groups of related bots, datasets and skillsets).Read-onlyList Blueprints
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.
Inputs
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_bot_getGet one bot with its model, backstory, dataset and skillset.Read-onlyGet Bot
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.
Inputs
bot_idstringrequired- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_bot_usage_getGet token and conversation usage of a bot.Read-onlyGet Bot Usage
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.
Inputs
bot_idstringrequired- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
fromstring- Start date for the period (ISO 8601 format) Example: 2026-01-31T12:00:00Z
tostring- End date for the period (ISO 8601 format) Example: 2026-01-31T12:00:00Z
chatbotkit_bots_listList the bots in the account.Read-onlyList Bots
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.
Inputs
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_contact_conversations_listList the conversations of a contact.Read-onlyList Contact Conversations
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.
Inputs
contact_idstringrequired- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_contact_getGet one contact.Read-onlyGet Contact
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.
Inputs
contact_idstringrequired- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_contacts_listList contacts (end users who talk to your bots).Read-onlyList Contacts
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.
Inputs
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_conversation_getGet one conversation with its bot and settings.Read-onlyGet Conversation
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.
Inputs
conversation_idstringrequired- Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_conversation_message_getGet one message of a conversation.Read-onlyGet Conversation Message
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.
Inputs
conversation_idstringrequired- Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
message_idstringrequired- Message ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_conversation_messages_listList the messages of a conversation.Read-onlyList Conversation Messages
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.
Inputs
conversation_idstringrequired- Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_conversations_listList conversations.Read-onlyList Conversations
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.
Inputs
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_dataset_getGet one dataset with its settings.Read-onlyGet Dataset
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.
Inputs
dataset_idstringrequired- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_dataset_records_listList the records of a dataset.Read-onlyList Dataset Records
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.
Inputs
dataset_idstringrequired- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_dataset_searchSearch a dataset for records relevant to a query (semantic search).Read-onlySearch Dataset
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.
Inputs
dataset_idstringrequired- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
searchstringrequired- Text to search for. Example: refund policy
filterobject- Optional filter on record metadata, as an object of field to value. Example: {"category": "billing"}
chatbotkit_datasets_listList datasets (knowledge bases).Read-onlyList Datasets
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.
Inputs
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_file_getGet one file metadata.Read-onlyGet File
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.
Inputs
file_idstringrequired- File ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_files_listList uploaded files.Read-onlyList Files
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.
Inputs
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_memories_listList stored memories (facts bots remember).Read-onlyList Memories
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.
Inputs
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_memory_searchSearch memories for records matching a query.Read-onlySearch Memories
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.
Inputs
searchstringrequired- Text to search for. Example: refund policy
bot_idstring- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_platform_models_listList the AI models available on the platform.Read-onlyList Models
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.
Inputs
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
typestring- The type of models to list. One of: language, image, video, rerank, decision. Example: languageone of
languageimagevideorerankdecision
chatbotkit_skillset_abilities_listList the abilities in a skillset.Read-onlyList Skillset Abilities
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.
Inputs
skillset_idstringrequired- Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_skillset_getGet one skillset.Read-onlyGet Skillset
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.
Inputs
skillset_idstringrequired- Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_skillsets_listList skillsets (groups of abilities a bot can use).Read-onlyList Skillsets
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.
Inputs
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc takeinteger- Number of items to return. Example: 25
chatbotkit_task_getGet one task with its bot, schedule and status.Read-onlyGet Task
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.
Inputs
task_idstringrequired- Task ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_tasks_listList tasks (scheduled or on-demand bot jobs).Read-onlyList Tasks
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.
Inputs
blueprint_idstring- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
bot_idstring- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
cursorstring- Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metastring- Free-form metadata object. Example: {"team": "support"}
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc statusstring- Filter by task status. One of: idle, running, canceled. Example: idleone of
idlerunningcanceled takeinteger- Number of items to return. Example: 25
chatbotkit_usage_getGet the account usage for the current billing period.Read-onlyGet Usage
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.
Inputs
This tool takes no inputs.
chatbotkit_bot_cloneCreate a copy of a bot.WriteClone Bot
Create a copy of a bot. Returns an object with id. Use chatbotkit_bot_clone to try changes on a copy.
Inputs
bot_idstringrequired- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_bot_createCreate a bot with a model, backstory and optional dataset and skillset.WriteCreate Bot
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.
Inputs
aliasstring- Unique alias. Example: support-bot
backstorystring- Instructions (system prompt) for the bot. Example: You are a friendly support agent for Acme.
blueprint_idstring- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
dataset_idstring- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
metaobject- Free-form metadata object. Example: {"team": "support"}
modelstring- Model name, from chatbotkit_platform_models_list. Example: gpt-4o
moderationboolean- The moderation flag for this configuration. Example: true
namestring- Name. Example: Support bot
privacyboolean- The privacy flag for this configuration. Example: true
skillset_idstring- Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
visibilitystring- Visibility. One of: private, protected, public. Example: privateone of
privateprotectedpublic
chatbotkit_bot_updateUpdate a bot.WriteUpdate Bot
Update a bot. Returns an object with id. Use chatbotkit_bot_update to change a bot backstory, model, dataset or skillset.
- Idempotent
Inputs
bot_idstringrequired- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
aliasstring- Unique alias. Example: support-bot
backstorystring- Instructions (system prompt) for the bot. Example: You are a friendly support agent for Acme.
blueprint_idstring- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
dataset_idstring- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
metaobject- Free-form metadata object. Example: {"team": "support"}
modelstring- Model name, from chatbotkit_platform_models_list. Example: gpt-4o
moderationboolean- The moderation flag for this configuration. Example: true
namestring- Name. Example: Support bot
privacyboolean- The privacy flag for this configuration. Example: true
skillset_idstring- Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
visibilitystring- Visibility. One of: private, protected, public. Example: privateone of
privateprotectedpublic
chatbotkit_completion_createGenerate the next bot message for a list of messages without saving a conversation.WriteGet Stateless Completion
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.
Inputs
messagesarrayrequired- Messages so far, each with a type (user, bot, context, ...) and text. Example: [{"type": "user", "text": "What are your opening hours?"}]
bot_idstring- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idobject- Contact ID to associate with the completion. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_contact_createCreate a contact.WriteCreate Contact
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.
Inputs
descriptionstring- Description. Example: Answers product questions
emailstring- Contact email. Example: jane@example.com
fingerprintstring- Your own unique identifier for the contact. Example: user-4711
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
nickstring- Nickname. Example: jane
phonestring- Contact phone. Example: +15555550101
preferencesstring- The preferences of the contact. Example: example
verified_atnumber- The timestamp (ms) when the contact was verified. Example: 10
chatbotkit_contact_ensureReturn the contact with the given fingerprint, email or phone, creating it if missing.WriteEnsure Contact
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.
- Idempotent
Inputs
fingerprintstringrequired- Your own unique identifier for the contact. Example: user-4711
descriptionstring- Description. Example: Answers product questions
emailstring- Contact email. Example: jane@example.com
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
nickstring- Nickname. Example: jane
phonestring- Contact phone. Example: +15555550101
preferencesstring- The preferences of the contact. Example: example
verified_atnumber- The timestamp (ms) when the contact was verified. Example: 10
chatbotkit_contact_updateUpdate a contact.WriteUpdate Contact
Update a contact. Returns an object with id. Use chatbotkit_contact_update to change contact details.
- Idempotent
Inputs
contact_idstringrequired- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
emailstring- Contact email. Example: jane@example.com
fingerprintstring- Your own unique identifier for the contact. Example: user-4711
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
nickstring- Nickname. Example: jane
phonestring- Contact phone. Example: +15555550101
preferencesstring- The preferences of the contact. Example: example
verified_atnumber- The timestamp (ms) when the contact was verified. Example: 10
chatbotkit_conversation_createCreate a conversation with a bot (or inline model and backstory), optionally with starting messages.WriteCreate Conversation
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.
Inputs
bot_idstring- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
messagesarray- Messages so far, each with a type (user, bot, context, ...) and text. Example: [{"type": "user", "text": "What are your opening hours?"}]
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
space_idstring- The space id assigned to this conversation. Example: abc123
task_idstring- The task id assigned to this conversation. Example: abc123
chatbotkit_conversation_message_createInsert a message of any type (user, bot, context) into a conversation.WriteCreate Conversation Message
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.
Inputs
conversation_idstringrequired- Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
textstringrequired- Text. Example: What are your opening hours?
typestringrequired- Message type. One of: user, bot, reasoning, context, instruction, backstory, activity, checkpoint. Example: contextone of
userbotreasoningcontextinstructionbackstoryactivitycheckpoint descriptionstring- Description. Example: Answers product questions
entitiesarray- Known entities. Example: ["value"]
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
chatbotkit_conversation_message_sendAdd a user message to a conversation without generating a reply.WriteSend Message
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.
Inputs
conversation_idstringrequired- Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
textstringrequired- User message to add. Example: I need help with my order.
entitiesarray- Known entities. Example: ["value"]
chatbotkit_conversation_replySend a user message to a conversation and get the bot reply in one call.WriteSend Message and Get Reply
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.
Inputs
conversation_idstringrequired- Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
entitiesarray- Known entities. Example: ["value"]
textstring- User message to send. Example: What are your opening hours?
chatbotkit_conversation_reply_receiveGenerate the bot reply to the latest message in a conversation.WriteReceive Reply
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.
Inputs
conversation_idstringrequired- Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_conversation_updateUpdate a conversation settings.WriteUpdate Conversation
Update a conversation settings. Returns an object with id. Use chatbotkit_conversation_update to change a conversation bot or metadata.
- Idempotent
Inputs
conversation_idstringrequired- Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
bot_idstring- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
expires_atinteger- Epoch-ms timestamp at which the conversation is automatically deleted; null clears any expiry. Example: 10
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
space_idstring- The space id assigned to this conversation. Example: abc123
task_idstring- The task id assigned to this conversation. Example: abc123
chatbotkit_dataset_createCreate a dataset (knowledge base) for bots to search.WriteCreate Dataset
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.
Inputs
aliasstring- Unique alias. Example: support-bot
blueprint_idstring- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
match_instructionstring- An instruction to include before found records. Example: example
metaobject- Free-form metadata object. Example: {"team": "support"}
mismatch_instructionstring- An instruction to include if no records where found. Example: example
namestring- Name. Example: Support bot
record_max_tokensnumber- The total number of tokens for each record. Example: 10
rerankerstring- The reranker class for the dataset. Example: example
search_max_recordsnumber- The total number of records to return during search. Example: 10
search_max_tokensnumber- The total number of tokens to use during search. Example: 10
search_min_scorenumber- The minimum score to filter search results by. Example: 10
separatorsstring- A list of separators to use when tokenizing text. Example: example
visibilitystring- Visibility. One of: private, protected, public. Example: privateone of
privateprotectedpublic
chatbotkit_dataset_record_createAdd a text record to a dataset.WriteCreate Dataset Record
Add a text record to a dataset. Returns an object with id. Use chatbotkit_dataset_record_create to teach a bot a fact.
Inputs
dataset_idstringrequired- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
textstringrequired- Record text. Example: Our support line is open Monday to Friday, 9:00 to 17:00 CET.
metaobject- Free-form metadata object. Example: {"team": "support"}
sourcestring- Where the text came from. Example: https://example.com/support
chatbotkit_dataset_record_updateUpdate a dataset record.WriteUpdate Dataset Record
Update a dataset record. Returns an object with id. Use chatbotkit_dataset_record_update to correct knowledge.
- Idempotent
Inputs
dataset_idstringrequired- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
record_idstringrequired- Record ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
metaobject- Free-form metadata object. Example: {"team": "support"}
sourcestring- The source to update the record with. Example: example
textstring- New record text. Example: Our support line is open Monday to Saturday.
chatbotkit_dataset_updateUpdate a dataset settings.WriteUpdate Dataset
Update a dataset settings. Returns an object with id. Use chatbotkit_dataset_update to rename a dataset or tune retrieval.
- Idempotent
Inputs
dataset_idstringrequired- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
aliasstring- Unique alias. Example: support-bot
blueprint_idstring- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
match_instructionstring- An instruction to include before found records. Example: example
metaobject- Free-form metadata object. Example: {"team": "support"}
mismatch_instructionstring- An instruction to include if no records where found. Example: example
namestring- Name. Example: Support bot
record_max_tokensnumber- The total number of tokens to for each record. Example: 10
rerankerstring- The reranker class for the dataset. Example: example
search_max_recordsnumber- The total number of records to return during search. Example: 10
search_max_tokensnumber- The total number of tokens to use during search. Example: 10
search_min_scorenumber- The minimum score to filter search results by. Example: 10
separatorsstring- A list of separators to use when tokenizing text. Example: example
visibilitystring- Visibility. One of: private, protected, public. Example: privateone of
privateprotectedpublic
chatbotkit_memory_createStore a memory for a bot or contact.WriteCreate Memory
Store a memory for a bot or contact. Returns an object with id. Use chatbotkit_memory_create to make a bot remember a fact.
Inputs
textstringrequired- Memory text. Example: Jane prefers email over phone.
bot_idstring- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
expires_atinteger- Epoch-ms timestamp at which the memory is automatically deleted; null for no expiry. Example: 10
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
chatbotkit_skillset_ability_createAdd an ability (an instruction-defined action) to a skillset.WriteCreate Ability
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.
Inputs
skillset_idstringrequired- Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
aliasstring- Unique alias. Example: support-bot
blueprint_idstring- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
instructionstring- 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_idstring- The ID of the bot associated with the ability. Example: abc123
linked_computer_idstring- The ID of the computer the ability runs shell commands on. Example: abc123
linked_file_idstring- The ID of the file associated with the ability. Example: abc123
linked_secret_idstring- The ID of the secret associated with the ability. Example: abc123
linked_space_idstring- The ID of the space associated with the ability. Example: abc123
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
statestring- The lifecycle state of a resource - toggle it on/off without deleting it. One of: enabled, disabled. Example: enabledone of
enableddisabled
chatbotkit_skillset_ability_executeRun one skillset ability directly with input parameters.WriteExecute Ability
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.
Inputs
ability_idstringrequired- Ability ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
skillset_idstringrequired- Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
inputstring- 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
chatbotkit_skillset_createCreate a skillset.WriteCreate Skillset
Create a skillset. Returns an object with id. Use chatbotkit_skillset_create, then add abilities with chatbotkit_skillset_ability_create.
Inputs
aliasstring- Unique alias. Example: support-bot
blueprint_idstring- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
statestring- The lifecycle state of a resource - toggle it on/off without deleting it. One of: enabled, disabled. Example: enabledone of
enableddisabled visibilitystring- Visibility. One of: private, protected, public. Example: privateone of
privateprotectedpublic
chatbotkit_skillset_updateUpdate a skillset.WriteUpdate Skillset
Update a skillset. Returns an object with id. Use chatbotkit_skillset_update to rename a skillset.
- Idempotent
Inputs
skillset_idstringrequired- Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
aliasstring- Unique alias. Example: support-bot
blueprint_idstring- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
statestring- The lifecycle state of a resource - toggle it on/off without deleting it. One of: enabled, disabled. Example: enabledone of
enableddisabled visibilitystring- Visibility. One of: private, protected, public. Example: privateone of
privateprotectedpublic
chatbotkit_task_createCreate a task that runs a bot on a schedule or on demand.WriteCreate Task
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.
Inputs
blueprint_idstring- Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
bot_idstring- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
contact_idstring- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
descriptionstring- Description. Example: Answers product questions
expires_atnumber- An optional epoch-millisecond timestamp after which the task is automatically deleted. Pass null or omit for no expiry. Example: 10
max_callsnumber- The maximum number of tool calls across the whole task run (0 or null for unbounded) Example: 10
max_iterationsnumber- The maximum number of iterations per task execution. Example: 10
max_timenumber- The maximum time per task execution in milliseconds. Example: 10
metaobject- Free-form metadata object. Example: {"team": "support"}
namestring- Name. Example: Support bot
schedulestring- The schedule of the task. Cron expressions and date-based schedules are evaluated in the provided timezone when set. Example: example
session_durationnumber- The session duration of the Widget integration. Example: 10
statestring- The lifecycle state of a resource - toggle it on/off without deleting it. One of: enabled, disabled. Example: enabledone of
enableddisabled timezonestring- An optional IANA timezone identifier used when evaluating the task schedule. Example: America/New_York
chatbotkit_task_triggerRun a task now.WriteRun Task
Run a task now. Returns an object with id. Use chatbotkit_task_trigger to execute a task immediately.
Inputs
task_idstringrequired- Task ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_bot_deleteDelete a bot.DestructiveDelete Bot
Delete a bot. Returns an object with id. Use chatbotkit_bot_delete to remove a bot for good.
Inputs
bot_idstringrequired- Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_contact_deleteDelete a contact.DestructiveDelete Contact
Delete a contact. Returns an object with id. Use chatbotkit_contact_delete to remove an end user.
Inputs
contact_idstringrequired- Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_conversation_deleteDelete a conversation and its messages.DestructiveDelete Conversation
Delete a conversation and its messages. Returns an object with id. Use chatbotkit_conversation_delete to remove a conversation.
Inputs
conversation_idstringrequired- Conversation ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_dataset_deleteDelete a dataset and its records.DestructiveDelete Dataset
Delete a dataset and its records. Returns an object with id. Use chatbotkit_dataset_delete to remove a knowledge base.
Inputs
dataset_idstringrequired- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_dataset_record_deleteDelete a dataset record.DestructiveDelete Dataset Record
Delete a dataset record. Returns an object with id. Use chatbotkit_dataset_record_delete to remove outdated knowledge.
Inputs
dataset_idstringrequired- Dataset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
record_idstringrequired- Record ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_memory_deleteDelete a memory.DestructiveDelete Memory
Delete a memory. Returns an object with id. Use chatbotkit_memory_delete to make a bot forget a fact.
Inputs
memory_idstringrequired- Memory ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_skillset_deleteDelete a skillset and its abilities.DestructiveDelete Skillset
Delete a skillset and its abilities. Returns an object with id. Use chatbotkit_skillset_delete to remove a skillset.
Inputs
skillset_idstringrequired- Skillset ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
chatbotkit_task_deleteDelete a task.DestructiveDelete Task
Delete a task. Returns an object with id. Use chatbotkit_task_delete to remove a task.
Inputs
task_idstringrequired- Task ID. Example: cm1a2b3c4d5e6f7g8h9i0j1k
No tools match.