Botpress integration: operations for AI agents
Botpress connects to Type.com as an integration. This page lists the 188 operations documented for Claude and Codex in Type.com: 98 read, 45 write, 45 destructive.
About Botpress
Botpress is an open-source platform for building, deploying, and managing chatbots.
Categories: Customer Support
How to connect Botpress to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
188 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.
188 operations listed.
Endpoints
- Read
Get Account
Get details of the account authenticating with this endpoint.
- Read
List Personal Access Tokens
List PATs (Personal Access Tokens) of account.
- Read
Get Account Preference
Get a preference of the account
- Read
List Public Integrations
List public integration
- Read
Get Public Integration By Id
Get public integration by Id
- Read
Get Public Integration
Get public integration by name and version
- Read
List Public Plugins
List public plugin
- Read
Get Public Plugin By Id
Get public plugin by Id
- Read
Get Dereferenced Public Plugin By Id
Get public plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations
- Read
Get Public Plugin
Get public plugin by name and version
- Read
Get Public Plugin Code
Get public plugin code
- Read
List Public Interfaces
List public interfaces
- Read
Get Public Interface By Id
Get public interface by Id
- Read
Get Public Interface
Get public interface by name and version
- Read
List Bots
List bots
- Read
Get Bot
Get bot details
- Read
Get Bot Logs
Get bot logs
- Read
Get Bot Webchat
Get the webchat code/URL for a bot
- Read
Get Bot Analytics
Get bot analytics
- Read
List Action Runs
List action runs for a specific integration of a bot
- Read
Get Bot Issue
Get Bot Issue
- Read
List Bot Issues
List Bot Issues
- Read
List Bot Issue Events
List Events for a Bot Issue
- Read
List Bot Versions
List Versions for a Bot
- Read
Get Bot Version
Get a specific version of a bot
- Read
Get Bot Json
Download the raw bot JSON for a bot. Optionally specify versionId to download a specific version.
- Read
List Bot Api Keys
List BAKs (Bot Api Keys) of a bot
- Read
Get Bot Allowlist
Get the Bot Allowlist
- Read
List Workspace Invoices
List invoices billed to workspace
- Read
Get Upcoming Invoice
Get upcoming invoice for workspace
- Read
List Workspaces
List workspaces the user has access to
- Read
Get Public Workspace
Get workspace public details
- Read
Get Workspace
Get workspace details
- Read
List Workspace Usages
List workspace usages
- Read
Break Down Workspace Usage By Bot
Break down workspace usage by bot
- Read
Get All Workspace Quota Completion
For a user, gets a map of workspace IDs to their highest quota completion rate
- Read
Get Workspace Quota
Get workspace quota
- Read
List Workspace Quotas
List workspace quotas
- Read
List Public Workspaces
List public workspaces
- Read
Get Audit Records
Get the audit records of a workspace, sorted from most recent to oldest.
- Read
Get Workspace Preference
Get a preference of the workspace
- Read
List Workspace Members
Lists all the members in a workspace
- Read
Get Workspace Member
Get details of the account authenticating with this endpoint.
- Read
List Integration Api Keys
List IAKs (Integration Api Keys) of an integration
- Read
List Integrations
List integrations, supports filtering and sorting capabilities
- Read
Validate Integration Creation
Perform a validation of an integration creation request
- Read
Get Integration
Get integration
- Read
Get Integration Logs
Get integration logs
- Read
Get Integration By Name
Get integration
- Read
List Interfaces
List Interfaces
- Read
Get Interface
Get Interface
- Read
Get Interface By Name
Get Interface by name and version
- Read
List Plugins
List Plugins
- Read
Get Plugin
Get Plugin
- Read
Get Dereferenced Plugin
Get plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations
- Read
Get Plugin By Name
Get Plugin by name and version
- Read
Get Plugin Code
Get Plugin Code
- Read
Get Usage
Get usage
- Read
Get Multiple Usages
Get multiple usages
- Read
List Usage History
Get usage history
- Read
List Usage Activity
List the usage activity for a given usage type and ID. The most recent activity is listed first.
- Read
List Usage Activity Daily
List the aggregate daily usage activity (aggregate) for a given usage type and ID. The most recent activity is listed first.
- Read
List Activities
List activities of a task
- Read
List Conversations
Returns a list of Conversation objects
- Read
Get Conversation
Retrieves the Conversation object for a valid identifier.
- Read
Get Or Create Conversation
Get or create a new Conversation
- Read
List Participants
Retrieves a list of Participants for a given Conversation.
- Read
Get Participant
Retrieves a Participant from a Conversation.
- Read
List Events
Retrieves a list of Event you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
- Read
Get Event
Retrieves the Event object for a valid identifier.
- Read
List Messages
Retrieves the conversation's Messages
- Read
Get Or Create Message
Retrieves the Message object for given discriminating tags. If the message does not exist, it will be created. If the message already exists, its tags and payload will be updated with the provided values if they are defined.
- Read
Get Message
Retrieves the Message object for a valid identifier.
- Read
List Users
Retrieves a list of User previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using Tags.
- Read
Get User
Retrieves the User object for a valid identifier.
- Read
Get Or Create User
Get or create a new User
- Read
Get State
Retrieves the State object for a valid identifiers.
- Read
Get Or Set State
Retrieves the State object for a valid identifiers. If the state does not exist, it creates a new state.
- Read
List Workflows
Retrieves a list of Workflow you've previously created. The workflows are returned in sorted order, with the most recent appearing first. The list can be filtered using Tags.
- Read
Get Workflow
Retrieves the Workflow object for a valid identifier.
- Read
Get Or Create Workflow
Get a workflow by tags or creates a new Workflow if it doesn't exists.
- Read
List Tag Values
Get a bot tag values
- Read
Listen Conversation
Creates a SSE stream to receive messages and events from a conversation
- Read
List Files
List files for bot
- Read
Get File
Get file
- Read
Search Files
Search files
- Read
List File Passages
List passages for a file
- Read
List File Tags
List available tags
- Read
List File Tag Values
List available tags
- Read
List Knowledge Bases
List knowledge bases for bot
- Read
List Tables
Retrieves a list of all tables associated with your bot.
- Read
Get Table
Retrieves detailed information about a specific table, identified by its name or unique identifier.
- Read
Get Or Create Table
Retrieves information about a specific table if it exists; otherwise, creates a new table based on the provided schema.
- Read
Export Table
Starts an export job for the table
- Read
Get Table Jobs
Returns a list of recent jobs for the table (export/import operations)
- Read
Get Table Row
Fetches a specific row from a table using the row's unique identifier.
- Read
Find Table Rows
Enables the search and filtering of rows within a table based on specific criteria. This operation supports complex queries for advanced data manipulation and retrieval.
- Write
Run Vrl
Run a VRL script
- Write
Create Personal Access Token
Create a PAT
- Write
Set Account Preference
Set a preference for the account
- Write
Create Bot
Create bot
- Write
Transfer Bot
Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
- Write
Create Bot Version
Create a new version for a bot
- Write
Publish From Bot Json
Deploy a bot using the provided raw bot JSON payload.
- Write
Deploy Bot Version
Deploys a version for a bot
- Write
Create Bot Api Key
Create a BAK
- Write
Migrate Workspace To V4
Migrate a workspace from v3 to v4 billing. Not meant for public use.
- Write
Charge Workspace Unpaid Invoices
Charge unpaid invoices of a workspace.
- Write
Create Workspace
Create workspace
- Write
Set Workspace Preference
Set a preference for the workspace
- Write
Create Workspace Member
Add a member to the workspace
- Write
Create Integration Api Key
Create an IAK
- Write
Create Integration
Create integration
- Write
Request Integration Verification
Request Integration Verification
- Write
Create Interface
Create Interface
- Write
Create Plugin
Create Plugin
- Write
Introspect
Introspect the API
- Write
Create Conversation
Creates a new Conversation
- Write
Add Participant
Add a Participant to a Conversation.
- Write
Create Event
Creates a custom Event
- Write
Create Message
Creates a new Message
- Write
Create User
Creates a new User. This operation can only be called when using the shared encryption key.
- Write
Set State Expiry
Updates the State expiry.
- Write
Set State
Overrides the State object by setting the values of the parameters passed.
- Write
Patch State
Updates the State object by setting the values of the parameters passed.
- Write
Call Action
Call an action
- Write
Configure Integration
An integration can call this endpoint to configure itself
- Write
Create Workflow
Creates a new Workflow.
- Write
Track Analytics
Add an event to the analytics
- Write
Capture Observation
Capture a bot runtime observation. Does not support integration observations yet.
- Write
Copy File
Copy file
- Write
Create Knowledge Base
Creates a knowledge base for grouping files.
- Write
Create Table
Initiates the creation of a new table based on the provided schema, excluding system-managed fields like IDs and timestamps.
- Write
Duplicate Table
Duplicates the table schema & content
- Write
Import Table
Import the content of a file into a table. The table must already have been created with the correct schema. Data already in the table will be kept.
- Write
Create Table Rows
Inserts one or multiple new rows into the specified table.
- Write
Upsert Table Rows
Inserts or updates rows based on a key. If a row exists, it is updated; otherwise, a new row is created.
- Destructive
Delete Account
Delete the account associated with authenticated user
- Destructive
Update Account
Update details of the account associated with authenticated user
- Destructive
Delete Personal Access Token
Delete a PAT
- Destructive
Update Bot
Update bot
- Destructive
Delete Bot
Delete bot
- Destructive
Delete Bot Issue
Delete Bot Issue
- Destructive
Delete Bot Api Key
Delete a BAK
- Destructive
Update Bot Allowlist
Update the Bot Allowlist
- Destructive
Update Workspace
Update workspace
- Destructive
Delete Workspace
Delete workspace
- Destructive
Check Handle Availability
Check if a workspace handle is available
- Destructive
Update Workspace Member
Update the member of a workspace
- Destructive
Delete Workspace Member
Remove a member of a workspace
- Destructive
Delete Integration Api Key
Delete an IAK
- Destructive
Update Integration
Update integration
- Destructive
Delete Integration
Delete integration
- Destructive
Validate Integration Update
Perform a validation of an integration update request
- Destructive
Update Interface
Update Interface
- Destructive
Delete Interface
Delete Interface
- Destructive
Update Plugin
Update Plugin
- Destructive
Delete Plugin
Delete Plugin
- Destructive
Change AISpend Quota
Change AI Spend quota
- Destructive
Update Conversation
Update a Conversation object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
- Destructive
Delete Conversation
Permanently deletes a Conversation. It cannot be undone. Also immediately deletes corresponding Messages.
- Destructive
Remove Participant
Remove a Participant from a Conversation.
- Destructive
Cancel Scheduled Event
Permanently cancels a scheduled Event. The event must be in a scheduled state.
- Destructive
Update Message
Updates a message tags and payload. The message type cannot be changed. Calling this operation from an integration, to update an incoming message, will not invoke the bot.
- Destructive
Delete Message
Permanently deletes a Message. It cannot be undone.
- Destructive
Update User
Update User
- Destructive
Delete User
Permanently deletes a User. It cannot be undone.
- Destructive
Update Workflow
Update a Workflow object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
- Destructive
Delete Workflow
Permanently deletes a Workflow. It cannot be undone.
- Destructive
Upsert File
Creates or updates a file using the key parameter as unique identifier. Updating a file will erase the existing content of the file. Upload the file content by sending it in a PUT request to the uploadUrl returned in the response.
- Destructive
Update File Metadata
Update file metadata, without updating the file content.
- Destructive
Delete File
Deletes a file.
- Destructive
Set File Passages
Sets the indexed file passages asynchronously. All existing indexed passages will be deleted as soon as the indexing begins. This endpoint will return immediately and set the file status to "indexingpending".
- Destructive
Update Knowledge Base
Updates a knowledge base.
- Destructive
Delete Knowledge Base
Deletes a knowledge base.
- Destructive
Update Table
Updates the schema or the name of an existing table.
- Destructive
Delete Table
Permanently deletes a table and all its associated data from the system. Use with caution, as this action cannot be undone.
- Destructive
Rename Table Column
Renames an existing column within a table to better reflect its content or usage. The operation targets a specific table and requires the current and new column names.
- Destructive
Update Table Rows
Updates specified rows in a table, allowing partial success with detailed feedback on errors.
- Destructive
Delete Table Rows
Allows selective deletion of rows or complete clearance of a table.
Experimental
- Write
Rotate Bot Signing Secrets
Rotate bot signing secrets. This will generate a new signing secret and invalidate the old ones after 24 hours.
- Write
Rotate Integration Signing Secrets
Rotate integration signing secrets. This will generate a new signing secret and invalidate the old ones after 24 hours.
- Write
Initialize Incoming Message
Initializes a user, conversation and sends a message to the conversation.
- Write
Import Messages
Imports messages if no matching messages already exist. On partial failure, returns an Error with both resolvedMessages and failedMessages arrays.
- Destructive
Unlink Sandboxed Conversations
EXPERIMENTAL Unlink all sandboxed conversations for an integration installed in a bot
No operations match.
See How connections work for access and permissions, or browse all integrations.