Chatbotkit integration: operations for AI agents
Chatbotkit connects to Type.com as an integration. This page lists the 361 operations documented for Claude and Codex in Type.com: 135 read, 180 write, 46 destructive.
About Chatbotkit
ChatBotKit is a platform that enables developers to build and manage AI-powered chatbots, offering comprehensive APIs and SDKs for seamless integration into applications.
Categories: Customer Support
How to connect Chatbotkit to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
361 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
361 operations listed.
Graph QL
- Write
Execute a GraphQL query
POST /graphql
Task
- Read
List tasks
GET /task/list
- Read
Export tasks
GET /task/export
- Read
Fetch task
GET /task/{taskId}/fetch
- Read
List task executions
GET /task/{taskId}/execution/list
- Write
Subscribe to task workflow events
Subscribe to real-time task workflow events. The stream currently includes operation begin, operation end, and error events emitted by the task's conversation engine while a task execution is running.
- Write
Create a new task
Create a new task with the given parameters.
- Write
Update task
POST /task/{taskId}/update
- Write
Trigger a task
Manually trigger a task to execute immediately.
- Destructive
Delete task
POST /task/{taskId}/delete
- Destructive
Cancel a running task
POST /task/{taskId}/cancel
- Destructive
Cancel a task execution
POST /task/{taskId}/execution/{taskExecutionId}/cancel
Platform
- Read
Retrieve a list of available reports
GET /platform/report/list
- Read
Search platform secrets
POST /platform/secret/search
- Read
Retrieve a list of platform secrets
GET /platform/secret/list
- Read
Retrieve a list of platform models
GET /platform/model/list
- Read
Search platform examples
POST /platform/example/search
- Read
Retrieve a list of platform examples
GET /platform/example/list
- Read
Fetch a specific platform example with full details
GET /platform/example/{exampleId}/fetch
- Read
Retrieve a list of platform actions
GET /platform/action/list
- Read
Search platform abilities
POST /platform/ability/search
- Read
Retrieve a list of platform abilities
GET /platform/ability/list
- Write
Generate multiple reports
Generates multiple reports in a single request. Input is a map where each key is a report ID and each value contains the input parameters for that report. Returns a map with the same keys containing the corresponding report outputs.
- Write
Generate a specific report
Generates a report based on the specified report ID and input parameters.
- Write
Clone a platform example
POST /platform/example/{exampleId}/clone
Open AI Compatibility
- Write
Create a chat completion (OpenAI-compatible)
An OpenAI Chat Completions compatible endpoint. Point any OpenAI client at this base URL and set model to a selector such as model/name=... or bot/id=.... Supports streaming and tool calling.
Conversation
- Read
List conversations
GET /conversation/list
- Read
Export conversations
GET /conversation/export
- Read
Fetch conversation
GET /conversation/{conversationId}/fetch
- Read
Fetch conversation usage statistics
Retrieve usage statistics for a specific conversation, including total tokens (BASE type only) and total messages. Optionally filter by date range.
- Write
Initiates conversation with the whatsapp integration
POST /integration/whatsapp/{whatsappIntegrationId}/initiate
- Write
Initiates conversation with the twilio integration
POST /integration/twilio/{twilioIntegrationId}/initiate
- Write
Initiates conversation with the telegram integration
POST /integration/telegram/{telegramIntegrationId}/initiate
- Write
Initiates conversation with the slack integration
POST /integration/slack/{slackIntegrationId}/initiate
- Write
Initiates a meeting session with the recall integration
POST /integration/recall/{recallIntegrationId}/initiate
- Write
Initiate a conversation with a Microsoft Teams integration
POST /integration/microsoftteams/{microsoftteamsIntegrationId}/initiate
- Write
Initiates conversation with the messenger integration
POST /integration/messenger/{messengerIntegrationId}/initiate
- Write
Initiates conversation with the instagram integration
POST /integration/instagram/{instagramIntegrationId}/initiate
- Write
Initiates conversation with the googlechat integration
POST /integration/googlechat/{googlechatIntegrationId}/initiate
- Write
Initiates conversation with the email integration
POST /integration/email/{emailIntegrationId}/initiate
- Write
Initiates conversation with the discord integration
POST /integration/discord/{discordIntegrationId}/initiate
- Write
Lets the agent of a Chat integration start a message to a group or handle
POST /integration/chat/{chatIntegrationId}/initiate
- Write
Dispatch a conversation completion to run in the background
Dispatch a conversation completion to run asynchronously in the background. This endpoint accepts the same parameters as the complete endpoint but instead of streaming the response directly, it returns a channel ID that can be used to subscribe to the completion progress.
- Write
Create a new conversation
Create a new conversation with the given parameters and optional messages. The conversation will be initialized with the the backstory, model, dataset, skillset and other configuration options of the bot.
- Write
Complete the next message in a conversation
POST /conversation/complete
- Write
Compact an array of messages into a single summary
POST /conversation/compact
- Write
Upvote conversation
POST /conversation/{conversationId}/upvote
- Write
Update conversation
POST /conversation/{conversationId}/update
- Write
Send a message to a conversation
POST /conversation/{conversationId}/send
- Write
Receive a conversation response
POST /conversation/{conversationId}/receive
- Write
Downvote conversation
POST /conversation/{conversationId}/downvote
- Write
Dispatch a stateful conversation completion to run in the background
Dispatch a stateful conversation completion to run asynchronously in the background.
- Write
Send and receive a conversation response
POST /conversation/{conversationId}/complete
- Write
Compact a conversation into a checkpoint
POST /conversation/{conversationId}/compact
- Write
Subscribe to a conversation's live monitor channel
Subscribe to a conversation to receive a live, curated feed of its lifecycle events as it runs - message, operation (tool call), completion and error events - regardless of how the conversation is being executed (interactive, dispatched, or via an integration such as Slack, Disc…
- Destructive
Delete conversation
POST /conversation/{conversationId}/delete
User
- Read
List users
GET /user/list
- Read
Fetch a user
GET /user/{userId}/fetch
- Read
List user tokens
GET /user/{userId}/token/list
- Read
List user contexts
GET /user/{userId}/context/list
- Read
Fetch a user context
GET /user/{userId}/context/{contextId}/fetch
- Write
Create user
POST /user/create
- Write
Update a user
POST /user/{userId}/update
- Write
Create user token
POST /user/{userId}/token/create
- Write
Update a user token
POST /user/{userId}/token/{tokenId}/update
- Write
Create a user session
POST /user/{userId}/session/create
- Write
Create user context
POST /user/{userId}/context/create
- Write
Update a user context
POST /user/{userId}/context/{contextId}/update
- Destructive
Delete a user
POST /user/{userId}/delete
- Destructive
Delete a user token
POST /user/{userId}/token/{tokenId}/delete
- Destructive
Delete a user context
POST /user/{userId}/context/{contextId}/delete
Usage
- Read
List usage records
GET /usage/list
- Read
Fetch usage
Fetches the usage data for the user in the current billing period.
- Read
Fetch usage series
Fetches a series of usage data points for the user for the last 90 days.
Team
- Read
Retrieve a list of teams
GET /team/list
Space
- Read
List spaces
GET /space/list
- Read
Export spaces
GET /space/export
- Read
Fetch a space
GET /space/{spaceId}/fetch
- Write
Create space
POST /space/create
- Write
Update space
POST /space/{spaceId}/update
- Destructive
Delete a space
POST /space/{spaceId}/delete
Space Storage
- Read
List files and directories in space storage
List files and directories in the space's storage. Supports both flat and recursive listing. The path is specified in the URL after /list/. Omit the path to list the root directory.
- Read
Download a file from space storage
Download a file from space storage. The file path is specified in the URL after /download/. Can return either the direct file content (default) or a presigned download URL (when Accept: application/json).
- Write
Upload a file to space storage
Upload a file to space storage. The file path is specified in the URL after /upload/. The file can be specified either as a HTTP URL, a data URL, a multipart/form-data, or as a raw file stream.
- Write
Move (rename) a file in space storage
Move a file from one location to another within space storage, or rename a file by moving it to a new path. The source file path is specified in the URL after /move/. The destinationPath in the request body is the target location for the file.
- Write
Copy a file in space storage
Copy a file from one location to another within space storage. The source file path is specified in the URL after /copy/. The destinationPath in the request body specifies where to copy the file.
- Destructive
Delete a file or directory from space storage
Delete a file or directory from space storage. The path is specified in the URL after /delete/. If recursive is true and the path is a directory, all files within it will be deleted.
Space Site
- Read
List space sites
GET /space/{spaceId}/site/list
- Read
Fetch a space site
GET /space/{spaceId}/site/{siteId}/fetch
- Write
Create a space site
POST /space/{spaceId}/site/create
- Write
Update a space site
POST /space/{spaceId}/site/{siteId}/update
- Write
Create a temporary link to a space site
Mints a signed link that opens the site, or one folder of it, until the link expires. This is how a private site is opened. The link is a credential; share it only with people who should see the content.
- Destructive
Delete a space site
POST /space/{spaceId}/site/{siteId}/delete
Skillset
- Read
Retrieve a list of skillsets
GET /skillset/list
- Read
Fetch a skillset
GET /skillset/{skillsetId}/fetch
- Write
Create skillset
POST /skillset/create
- Write
Update skillset
POST /skillset/{skillsetId}/update
- Destructive
Delete a skillset
POST /skillset/{skillsetId}/delete
Skillset Ability
- Read
Retrieve a list of skillset abilities
GET /skillset/{skillsetId}/ability/list
- Read
Export skillset abilities
GET /skillset/{skillsetId}/ability/export
- Read
Fetch a ability from a skillset
GET /skillset/{skillsetId}/ability/{abilityId}/fetch
- Write
Create ability
POST /skillset/{skillsetId}/ability/create
- Write
Update a skillset ability
POST /skillset/{skillsetId}/ability/{abilityId}/update
- Write
Execute a skillset ability
Executes a specific ability from a skillset with the provided input. This endpoint processes the ability's instruction template using the given input and returns the execution result along with usage statistics.
- Destructive
Delete a ability from a skillset
POST /skillset/{skillsetId}/ability/{abilityId}/delete
Secret
- Read
Retrieve a list of secrets
GET /secret/list
- Read
Fetch a secret
GET /secret/{secretId}/fetch
- Write
Create secret
POST /secret/create
- Write
Verify secret
POST /secret/{secretId}/verify
- Write
Update secret
POST /secret/{secretId}/update
- Write
Proxy a request with a secret
Performs an outbound HTTP request with the secret injected into the request headers at egress. The secret value never leaves the server. Reference the secret in any header value using ${SECRETDEFAULT}; if no header references the secret, it is injected into Authorization.
- Write
Mint a secret for a token
Returns a usable token minted from the secret (a refreshed OAuth access token, a freshly signed JWT, or a stored bearer token).
- Write
Authenticate secret
POST /secret/{secretId}/authenticate
- Destructive
Revoke secret
POST /secret/{secretId}/revoke
- Destructive
Delete a secret
POST /secret/{secretId}/delete
Portal
- Read
Retrieve a list of portals
GET /portal/list
- Read
Fetch a portal
GET /portal/{portalId}/fetch
- Write
Create portal
POST /portal/create
- Write
Update portal
POST /portal/{portalId}/update
- Destructive
Delete a portal
POST /portal/{portalId}/delete
Policy
- Read
Retrieve a list of policies
GET /policy/list
- Read
Fetch a policy
GET /policy/{policyId}/fetch
- Write
Create policy
POST /policy/create
- Write
Update policy
POST /policy/{policyId}/update
- Destructive
Delete policy
POST /policy/{policyId}/delete
Memory
- Read
Search memories for records matching a given search query
POST /memory/search
- Read
List memories
GET /memory/list
- Read
Export memories
GET /memory/export
- Read
Fetch memory
GET /memory/{memoryId}/fetch
- Write
Create a new memory
Create a new memory with the given parameters.
- Write
Update memory
POST /memory/{memoryId}/update
- Destructive
Delete memory
POST /memory/{memoryId}/delete
Magic
- Read
Retrieve a list of magic prompts
GET /magic/list
- Write
Generate text (description, records, abilities and more) based on input.
POST /magic/{promptId}/generate
Widget Integration
- Read
List Widget integrations
GET /integration/widget/list
- Read
Fetch a widgetIntegration
GET /integration/widget/{widgetIntegrationId}/fetch
- Write
Create Widget integration
POST /integration/widget/create
- Write
Update a Widget integration
POST /integration/widget/{widgetIntegrationId}/update
- Write
Setup Widget integration
POST /integration/widget/{widgetIntegrationId}/setup
- Write
Clone Widget integration
POST /integration/widget/{widgetIntegrationId}/clone
- Write
Detach a file from a widget integration
POST /integration/widget/{widgetIntegrationId}/file/{fileId}/detach
- Write
Attach a file to a widget integration
POST /integration/widget/{widgetIntegrationId}/file/{fileId}/attach
- Destructive
Delete Widget integration
POST /integration/widget/{widgetIntegrationId}/delete
Whats App Integration
- Read
List WhatsApp integrations
GET /integration/whatsapp/list
- Read
Fetch a whatsappIntegration
GET /integration/whatsapp/{whatsappIntegrationId}/fetch
- Write
Create WhatsApp integration
POST /integration/whatsapp/create
- Write
Update a WhatsApp integration
POST /integration/whatsapp/{whatsappIntegrationId}/update
- Write
Setup a WhatsApp integration
POST /integration/whatsapp/{whatsappIntegrationId}/setup
- Destructive
Delete WhatsApp integration
POST /integration/whatsapp/{whatsappIntegrationId}/delete
Twilio Integration
- Read
List Twilio integrations
GET /integration/twilio/list
- Read
Fetch a twilioIntegration
GET /integration/twilio/{twilioIntegrationId}/fetch
- Write
Create Twilio integration
POST /integration/twilio/create
- Write
Update a Twilio integration
POST /integration/twilio/{twilioIntegrationId}/update
- Write
Setup a Twilio integration
POST /integration/twilio/{twilioIntegrationId}/setup
- Destructive
Delete Twilio integration
POST /integration/twilio/{twilioIntegrationId}/delete
Trigger Integration
- Read
List Trigger integrations
GET /integration/trigger/list
- Read
Fetch a triggerIntegration
GET /integration/trigger/{triggerIntegrationId}/fetch
- Write
Create Trigger integration
POST /integration/trigger/create
- Write
Update a Trigger integration
POST /integration/trigger/{triggerIntegrationId}/update
- Write
Setup a Trigger integration
POST /integration/trigger/{triggerIntegrationId}/setup
- Write
Invoke Trigger integration
POST /integration/trigger/{triggerIntegrationId}/invoke
- Destructive
Delete Trigger integration
POST /integration/trigger/{triggerIntegrationId}/delete
Telegram Integration
- Read
List Telegram integrations
GET /integration/telegram/list
- Read
Fetch a telegramIntegration
GET /integration/telegram/{telegramIntegrationId}/fetch
- Write
Create Telegram integration
POST /integration/telegram/create
- Write
Update a Telegram integration
POST /integration/telegram/{telegramIntegrationId}/update
- Write
Setup a Telegram integration
POST /integration/telegram/{telegramIntegrationId}/setup
- Destructive
Delete Telegram integration
POST /integration/telegram/{telegramIntegrationId}/delete
Support Integration
- Read
List Support integrations
GET /integration/support/list
- Read
Fetch a supportIntegration
GET /integration/support/{supportIntegrationId}/fetch
- Write
Create Support integration
POST /integration/support/create
- Write
Update a Support integration
POST /integration/support/{supportIntegrationId}/update
- Write
Trigger support integration on historic conversations
POST /integration/support/{supportIntegrationId}/trigger
- Destructive
Delete Support integration
POST /integration/support/{supportIntegrationId}/delete
Slack Integration
- Read
List Slack integrations
GET /integration/slack/list
- Read
Fetch a slackIntegration
GET /integration/slack/{slackIntegrationId}/fetch
- Write
Create Slack integration
POST /integration/slack/create
- Write
Update a Slack integration
POST /integration/slack/{slackIntegrationId}/update
- Write
Setup Slack integration
POST /integration/slack/{slackIntegrationId}/setup
- Destructive
Delete Slack integration
POST /integration/slack/{slackIntegrationId}/delete
Skill Server Integration
- Read
List SkillServer integrations
GET /integration/skillserver/list
- Read
Fetch the SkillServer manual
Returns a text-first manual describing the abilities exposed by this skill server and how to invoke them. Authenticated with the static access token as a bearer token.
- Read
Fetch a skillserverIntegration
GET /integration/skillserver/{skillserverIntegrationId}/fetch
- Write
Create SkillServer integration
POST /integration/skillserver/create
- Write
Update a SkillServer integration
POST /integration/skillserver/{skillserverIntegrationId}/update
- Write
Invoke a SkillServer ability
Directly invoke a single ability from the linked skillset by name. Authenticated with the static access token as a bearer token. Responses are plain text by default; append ?format=json (or send an Accept: application/json header) for a JSON response.
- Destructive
Delete SkillServer integration
POST /integration/skillserver/{skillserverIntegrationId}/delete
Sitemap Integration
- Read
List Sitemap integrations
GET /integration/sitemap/list
- Read
Fetch a sitemapIntegration
GET /integration/sitemap/{sitemapIntegrationId}/fetch
- Write
Create Sitemap integration
POST /integration/sitemap/create
- Write
Update a Sitemap integration
POST /integration/sitemap/{sitemapIntegrationId}/update
- Write
Sync a Sitemap integration
POST /integration/sitemap/{sitemapIntegrationId}/sync
- Destructive
Delete Sitemap integration
POST /integration/sitemap/{sitemapIntegrationId}/delete
Notion Integration
- Read
List Notion integrations
GET /integration/notion/list
- Read
Fetch a notionIntegration
GET /integration/notion/{notionIntegrationId}/fetch
- Write
Create Notion integration
POST /integration/notion/create
- Write
Update a Notion integration
POST /integration/notion/{notionIntegrationId}/update
- Write
Sync Notion integration
POST /integration/notion/{notionIntegrationId}/sync
- Destructive
Delete Notion integration
POST /integration/notion/{notionIntegrationId}/delete
Microsoft Teams Integration
- Read
List Microsoft Teams integrations
GET /integration/microsoftteams/list
- Read
Fetch a Microsoft Teams integration
GET /integration/microsoftteams/{microsoftteamsIntegrationId}/fetch
- Write
Create a Microsoft Teams integration
POST /integration/microsoftteams/create
- Write
Update a Microsoft Teams integration
POST /integration/microsoftteams/{microsoftteamsIntegrationId}/update
- Write
Set up a Microsoft Teams integration
POST /integration/microsoftteams/{microsoftteamsIntegrationId}/setup
- Destructive
Delete a Microsoft Teams integration
POST /integration/microsoftteams/{microsoftteamsIntegrationId}/delete
Messenger Integration
- Read
List Messenger integrations
GET /integration/messenger/list
- Read
Fetch a messengerIntegration
GET /integration/messenger/{messengerIntegrationId}/fetch
- Write
Create Messenger integration
POST /integration/messenger/create
- Write
Update a Messenger integration
POST /integration/messenger/{messengerIntegrationId}/update
- Write
Setup a Messenger integration
POST /integration/messenger/{messengerIntegrationId}/setup
- Destructive
Delete Messenger integration
POST /integration/messenger/{messengerIntegrationId}/delete
Mcp Server Integration
- Read
List McpServer integrations
GET /integration/mcpserver/list
- Read
Fetch a mcpserverIntegration
GET /integration/mcpserver/{mcpserverIntegrationId}/fetch
- Write
Create McpServer integration
POST /integration/mcpserver/create
- Write
Update a McpServer integration
POST /integration/mcpserver/{mcpserverIntegrationId}/update
- Destructive
Delete McpServer integration
POST /integration/mcpserver/{mcpserverIntegrationId}/delete
Instagram Integration
- Read
List Instagram integrations
GET /integration/instagram/list
- Read
Fetch an Instagram integration
GET /integration/instagram/{instagramIntegrationId}/fetch
- Write
Create Instagram integration
POST /integration/instagram/create
- Write
Update an Instagram integration
POST /integration/instagram/{instagramIntegrationId}/update
- Write
Setup an Instagram integration
POST /integration/instagram/{instagramIntegrationId}/setup
- Destructive
Delete Instagram integration
POST /integration/instagram/{instagramIntegrationId}/delete
Google Chat Integration
- Read
List Google Chat integrations
GET /integration/googlechat/list
- Read
Fetch a Google Chat integration
GET /integration/googlechat/{googlechatIntegrationId}/fetch
- Write
Create Google Chat integration
POST /integration/googlechat/create
- Write
Update a Google Chat integration
POST /integration/googlechat/{googlechatIntegrationId}/update
- Write
Setup Google Chat integration
POST /integration/googlechat/{googlechatIntegrationId}/setup
- Destructive
Delete Google Chat integration
POST /integration/googlechat/{googlechatIntegrationId}/delete
Git Hub Integration
- Read
List GitHub integrations
GET /integration/github/list
- Read
Validate a GitHub integration's App credentials
POST /integration/github/{githubIntegrationId}/setup
- Read
Fetch a githubIntegration
GET /integration/github/{githubIntegrationId}/fetch
- Write
Create GitHub integration
POST /integration/github/create
- Write
Update a GitHub integration
POST /integration/github/{githubIntegrationId}/update
- Destructive
Delete GitHub integration
POST /integration/github/{githubIntegrationId}/delete
Extract Integration
- Read
List Extract integrations
GET /integration/extract/list
- Read
Fetch a extractIntegration
GET /integration/extract/{extractIntegrationId}/fetch
- Read
List extract integration items
GET /integration/extract/{extractIntegrationId}/item/list
- Read
Export extract integration items
GET /integration/extract/{extractIntegrationId}/item/export
- Write
Create Extract integration
POST /integration/extract/create
- Write
Update a Extract integration
POST /integration/extract/{extractIntegrationId}/update
- Write
Trigger extract integration on historic conversations
POST /integration/extract/{extractIntegrationId}/trigger
- Destructive
Delete Extract integration
POST /integration/extract/{extractIntegrationId}/delete
Email Integration
- Read
List Email integrations
GET /integration/email/list
- Read
Fetch a emailIntegration
GET /integration/email/{emailIntegrationId}/fetch
- Write
Create Email integration
POST /integration/email/create
- Write
Update a Email integration
POST /integration/email/{emailIntegrationId}/update
- Write
Setup a Email integration
POST /integration/email/{emailIntegrationId}/setup
- Destructive
Delete Email integration
POST /integration/email/{emailIntegrationId}/delete
Discord Integration
- Read
List Discord integrations
GET /integration/discord/list
- Read
Fetch a discordIntegration
GET /integration/discord/{discordIntegrationId}/fetch
- Write
Create Discord integration
POST /integration/discord/create
- Write
Update a Discord integration
POST /integration/discord/{discordIntegrationId}/update
- Write
Setup Discord integration
POST /integration/discord/{discordIntegrationId}/setup
- Destructive
Delete Discord integration
POST /integration/discord/{discordIntegrationId}/delete
Chat Integration
- Read
List Chat integrations
GET /integration/chat/list
- Read
Fetch a Chat integration
GET /integration/chat/{chatIntegrationId}/fetch
- Read
List the recent messages of a group or a direct chat
GET /integration/chat/{chatIntegrationId}/message/list
- Read
List the other members of a Chat integration's server
GET /integration/chat/{chatIntegrationId}/member/list
- Read
List the groups of a Chat integration's server
GET /integration/chat/{chatIntegrationId}/group/list
- Write
Create Chat integration
POST /integration/chat/create
- Write
Update a Chat integration
POST /integration/chat/{chatIntegrationId}/update
- Write
Setup a Chat integration
POST /integration/chat/{chatIntegrationId}/setup
- Write
Create a Chat session token for one contact
A trusted backend calls this with the owner's credentials for a person it has signed in. The returned token lets that person's browser send to the listed destinations and list their recent messages, and nothing else.
- Write
Send a contact's message to a group or handle of a Chat integration's server
POST /integration/chat/{chatIntegrationId}/message/send
- Destructive
Delete Chat integration
POST /integration/chat/{chatIntegrationId}/delete
File
- Read
Retrieve a list of files
GET /file/list
- Read
Fetch a file
GET /file/{fileId}/fetch
- Read
Download a file
Download a file. If the file is not public, the user must be authenticated.
- Write
Create file
POST /file/create
- Write
Upload the specified file
Upload the specified file to the file storage service. The file can be specified either as a HTTP URL, a data URL, a multipart/form-data, or as a raw file stream.
- Write
Update file
POST /file/{fileId}/update
- Write
Sync file
POST /file/{fileId}/sync
- Destructive
Delete a file
POST /file/{fileId}/delete
Event
- Read
List event logs
GET /event/log/list
- Read
Export event logs
GET /event/log/export
- Write
Subscribe to live event logs
Subscribe to receive real-time event logs as they are generated. This endpoint returns a streaming response that continuously delivers events as they occur in your account. The connection remains open until the client closes it or an error occurs.
Decision
- Write
Answer typed questions about a state
POST /decision/create
Dataset
- Read
Retrieve a list of datasets
GET /dataset/list
- Read
Search a dataset for records matching a given search query
POST /dataset/{datasetId}/search
- Read
Fetch a dataset
GET /dataset/{datasetId}/fetch
- Write
Create dataset
POST /dataset/create
- Write
Update dataset
POST /dataset/{datasetId}/update
- Destructive
Delete a dataset
POST /dataset/{datasetId}/delete
Dataset Record
- Read
Retrieve a list of dataset records
GET /dataset/{datasetId}/record/list
- Read
Export dataset records
GET /dataset/{datasetId}/record/export
- Read
Fetch a record from a dataset
GET /dataset/{datasetId}/record/{recordId}/fetch
- Write
Create record
POST /dataset/{datasetId}/record/create
- Write
Update a dataset record
POST /dataset/{datasetId}/record/{recordId}/update
- Destructive
Delete a record from a dataset
POST /dataset/{datasetId}/record/{recordId}/delete
Dataset File
- Read
Retrieve a list of dataset files
GET /dataset/{datasetId}/file/list
- Write
Sync dataset file
POST /dataset/{datasetId}/file/{fileId}/sync
- Write
Detach dataset file
POST /dataset/{datasetId}/file/{fileId}/detach
- Write
Attach dataset file
POST /dataset/{datasetId}/file/{fileId}/attach
Conversation Session
- Write
Create conversation session
Conversation tokens allow client-side applications to create a unique, authenticated credential for each conversation.
Conversation Message
- Read
List conversation messages
GET /conversation/{conversationId}/message/list
- Read
Fetch conversation message
GET /conversation/{conversationId}/message/{messageId}/fetch
- Write
Create message
POST /conversation/{conversationId}/message/create
- Write
Upvote conversation message
POST /conversation/{conversationId}/message/{messageId}/upvote
- Write
Update conversation message
POST /conversation/{conversationId}/message/{messageId}/update
- Write
Synthesize conversation message
POST /conversation/{conversationId}/message/{messageId}/synthesize
- Write
Downvote conversation message
POST /conversation/{conversationId}/message/{messageId}/downvote
- Destructive
Delete a message
POST /conversation/{conversationId}/message/{messageId}/delete
Conversation Contact
- Write
Upsert contact
POST /conversation/{conversationId}/contact/upsert
Conversation Attachment
- Read
List conversation attachments
GET /conversation/{conversationId}/attachment/list
- Write
Upload a file as a conversation attachment
Upload the specified file to the conversation. The file can be specified either as a HTTP URL, a data URL, a multipart/form-data, or as a raw file stream.
Contact
- Read
List contacts
GET /contact/list
- Read
Export contacts
GET /contact/export
- Read
Fetch contact
GET /contact/{contactId}/fetch
- Write
Ensure a contact exists or create a new one
Ensure a contact with the given parameters exists or create a new one.
- Write
Create a new contact
Create a new contact with the given parameters.
- Write
Update contact
POST /contact/{contactId}/update
- Destructive
Delete contact
POST /contact/{contactId}/delete
Contact Task
- Read
List contact tasks
GET /contact/{contactId}/task/list
Contact Space
- Read
List contact spaces
GET /contact/{contactId}/space/list
Contact Secret
- Read
List contact secrets
GET /contact/{contactId}/secret/list
- Write
Verify contact secret
POST /contact/{contactId}/secret/{secretId}/verify
- Write
Proxy a request with a contact's secret
Performs an outbound HTTP request with a personal (per-contact) secret injected into the request headers at egress. The secret value never leaves the server. The upstream response is returned verbatim.
- Write
Mint a contact's secret for a token
Returns a usable token minted from a personal (per-contact) secret. The credential leaves the server, for use when a proxy cannot serve the request. Owner-only. Platform-managed and basic/plain secrets are not mintable.
- Write
Authenticate contact secret
POST /contact/{contactId}/secret/{secretId}/authenticate
- Destructive
Revoke contact secret
POST /contact/{contactId}/secret/{secretId}/revoke
Contact Rating
- Read
List contact ratings
GET /contact/{contactId}/rating/list
Contact Memory
- Read
Search memories for a specific contact
POST /contact/{contactId}/memory/search
- Read
List contact memories
GET /contact/{contactId}/memory/list
Contact Conversation
- Read
List contact conversations
GET /contact/{contactId}/conversation/list
Computer
- Read
List computers
GET /computer/list
- Read
Export computers
GET /computer/export
- Read
Fetch a computer
GET /computer/{computerId}/fetch
- Read
Read a file from a computer
POST /computer/{computerId}/file/read
- Write
Create computer
POST /computer/create
- Write
Update computer
POST /computer/{computerId}/update
- Write
Stop a computer
POST /computer/{computerId}/stop
- Write
Start a computer
POST /computer/{computerId}/start
- Write
Restart a computer
POST /computer/{computerId}/restart
- Write
Run a command on a computer
POST /computer/{computerId}/exec
- Write
Create a remote access link for a desktop computer
Mints a short-lived, signed link that opens the computer's desktop in a browser over web VNC. The link is a credential; share it only with people who should see and control the computer.
- Write
Write a file to a computer
POST /computer/{computerId}/file/write
- Destructive
Delete a computer
POST /computer/{computerId}/delete
Channel
- Write
Subscribe to channel messages
Subscribe to a channel to receive real-time messages published to it. This endpoint returns a streaming response that will continuously send message events as they are published to the channel via the publish endpoint.
- Write
Publish a message to a channel
Publish a message to a specific channel. The message will be broadcast to all subscribers currently listening to this channel via the subscribe endpoint.
Bot
- Read
Retrieve a list of bots
GET /bot/list
- Read
Fetch a bot
GET /bot/{botId}/fetch
- Read
Fetch bot usage statistics
Retrieve usage statistics for a specific bot, including total tokens (BASE type only), total conversations, and total messages. Optionally filter by date range.
- Write
Create bot
POST /bot/create
- Write
Upvote a bot
POST /bot/{botId}/upvote
- Write
Update bot
POST /bot/{botId}/update
- Write
Downvote a bot
POST /bot/{botId}/downvote
- Write
Clone bot
POST /bot/{botId}/clone
- Destructive
Delete a bot
POST /bot/{botId}/delete
Bot Session
- Write
Create bot session
POST /bot/{botId}/session/create
Bot Memory
- Read
Search memories for a specific bot
POST /bot/{botId}/memory/search
Blueprint
- Read
Retrieve a list of blueprints
GET /blueprint/list
- Read
Fetch a blueprint
GET /blueprint/{blueprintId}/fetch
- Write
Create blueprint
POST /blueprint/create
- Write
Update blueprint
POST /blueprint/{blueprintId}/update
- Write
Clone a blueprint
POST /blueprint/{blueprintId}/clone
- Destructive
Delete a blueprint
POST /blueprint/{blueprintId}/delete
Blueprint Resources
- Read
List the resources of a blueprint
GET /blueprint/{blueprintId}/resource/list
- Read
Export blueprint resources
Export a blueprint and all its resources. The default format is JSON. Set the Accept header to application/terraform+hcl to export as Terraform HCL code.
- Write
Import resources into an existing blueprint
Reconciles resources by alias. A resource whose alias already exists in the blueprint is updated in place (credentials are preserved); otherwise it is created. Resources without an alias are always created.
Blueprint Bulletins
- Read
List the bulletins on a blueprint's shared board
GET /blueprint/{blueprintId}/bulletin/list
- Write
Post a bulletin to a blueprint's shared board
POST /blueprint/{blueprintId}/bulletin/create
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 27, 2026. Chatbotkit API docs.