Botpress

AI · AI

Bots, conversations, messages, and tables in that workspace’s own account.

Acts as the person, not as itself

Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.

Credentials never touch the agent

Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.

Every call on the record

Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.

What an agent can do

Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.

botpress_delete_v1_admin_bots_by_idWRITE

Delete bot (Admin API) via DELETE /v1/admin/bots/{id}

api

botpress_delete_v1_admin_bots_by_id_issues_by_issueidWRITE

Delete Bot Issue (Admin API) via DELETE /v1/admin/bots/{id}/issues/{issueId}

api

botpress_delete_v1_admin_integrations_by_idWRITE

Delete integration (Admin API) via DELETE /v1/admin/integrations/{id}

api

botpress_delete_v1_admin_workspace_members_by_idWRITE

Remove a member of a workspace (Admin API) via DELETE /v1/admin/workspace-members/{id}

api

botpress_delete_v1_admin_workspaces_by_idWRITE

Delete workspace (Admin API) via DELETE /v1/admin/workspaces/{id}

api

botpress_delete_v1_chat_conversations_by_idWRITE

Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message). (Runtime API) via DELETE /v1/chat/conversations/{id}

api

botpress_delete_v1_chat_conversations_by_id_participants_by_useridWRITE

Remove a [Participant](#schema_participant) from a [Conversation](#schema_conversation). (Runtime API) via DELETE /v1/chat/conversations/{id}/participants/{userId}

api

botpress_delete_v1_chat_events_scheduled_by_idWRITE

Permanently cancels a scheduled [Event](#schema_event). The event must be in a `scheduled` state. (Runtime API) via DELETE /v1/chat/events/scheduled/{id}

api

botpress_delete_v1_chat_integration_identifiersWRITE

Unlink an identifier from all integration instances that currently hold it (Runtime API) via DELETE /v1/chat/integration/identifiers

api

botpress_delete_v1_chat_messages_by_idWRITE

Permanently deletes a [Message](#schema_message). It cannot be undone. (Runtime API) via DELETE /v1/chat/messages/{id}

api

botpress_delete_v1_chat_users_by_idWRITE

Permanently deletes a [User](#schema_user). It cannot be undone. (Runtime API) via DELETE /v1/chat/users/{id}

api

botpress_delete_v1_files_by_idWRITE

Deletes a file. (Files API) via DELETE /v1/files/{id}

api

botpress_delete_v1_tables_by_tableWRITE

Permanently deletes a table and all its associated data from the system. Use with caution, as this action cannot be undone. (Tables API) via DELETE /v1/tables/{table}

api

botpress_get_v1_admin_account_meREAD

Get details of the account authenticating with this endpoint. (Admin API) via GET /v1/admin/account/me

api

botpress_get_v1_admin_botsREAD

List bots (Admin API) via GET /v1/admin/bots

api

botpress_get_v1_admin_bots_by_idREAD

Get bot details (Admin API) via GET /v1/admin/bots/{id}

api

botpress_get_v1_admin_bots_by_id_analyticsREAD

Get bot analytics (Admin API) via GET /v1/admin/bots/{id}/analytics

api

botpress_get_v1_admin_bots_by_id_issuesREAD

List Bot Issues (Admin API) via GET /v1/admin/bots/{id}/issues

api

botpress_get_v1_admin_bots_by_id_issues_by_issueidREAD

Get Bot Issue (Admin API) via GET /v1/admin/bots/{id}/issues/{issueId}

api

botpress_get_v1_admin_bots_by_id_issues_by_issueid_eventsREAD

List Events for a Bot Issue (Admin API) via GET /v1/admin/bots/{id}/issues/{issueId}/events

api

botpress_get_v1_admin_bots_by_id_logsREAD

Get bot logs (Admin API) via GET /v1/admin/bots/{id}/logs

api

botpress_get_v1_admin_hub_integrationsREAD

List public integration (Admin API) via GET /v1/admin/hub/integrations

api

botpress_get_v1_admin_hub_integrations_by_idREAD

Get public integration by Id (Admin API) via GET /v1/admin/hub/integrations/{id}

api

botpress_get_v1_admin_hub_integrations_by_name_by_versionREAD

Get public integration by name and version (Admin API) via GET /v1/admin/hub/integrations/{name}/{version}

api

botpress_get_v1_admin_integrationsREAD

List integrations, supports filtering and sorting capabilities (Admin API) via GET /v1/admin/integrations

api

botpress_get_v1_admin_integrations_by_idREAD

Get integration (Admin API) via GET /v1/admin/integrations/{id}

api

botpress_get_v1_admin_integrations_by_id_logsREAD

Get integration logs (Admin API) via GET /v1/admin/integrations/{id}/logs

api

botpress_get_v1_admin_integrations_by_name_by_versionREAD

Get integration (Admin API) via GET /v1/admin/integrations/{name}/{version}

api

botpress_get_v1_admin_workspace_membersREAD

Lists all the members in a workspace (Admin API) via GET /v1/admin/workspace-members

api

botpress_get_v1_admin_workspace_members_meREAD

Get details of the account authenticating with this endpoint. (Admin API) via GET /v1/admin/workspace-members/me

api

botpress_get_v1_admin_workspacesREAD

List workspaces the user has access to (Admin API) via GET /v1/admin/workspaces

api

botpress_get_v1_admin_workspaces_by_idREAD

Get workspace details (Admin API) via GET /v1/admin/workspaces/{id}

api

botpress_get_v1_admin_workspaces_by_id_audit_recordsREAD

Get the audit records of a workspace, sorted from most recent to oldest. (Admin API) via GET /v1/admin/workspaces/{id}/audit-records

api

botpress_get_v1_admin_workspaces_by_id_publicREAD

Get workspace public details (Admin API) via GET /v1/admin/workspaces/{id}/public

api

botpress_get_v1_admin_workspaces_publicREAD

List public workspaces (Admin API) via GET /v1/admin/workspaces/public

api

botpress_get_v1_chat_conversationsREAD

Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags). (Runtime API) via GET /v1/chat/conversations

api

botpress_get_v1_chat_conversations_by_idREAD

Retrieves the [Conversation](#schema_conversation) object for a valid identifier. (Runtime API) via GET /v1/chat/conversations/{id}

api

botpress_get_v1_chat_conversations_by_id_participantsREAD

Retrieves a list of [Participant](#schema_participant) for a given [Conversation](#schema_conversation). (Runtime API) via GET /v1/chat/conversations/{id}/participants

api

botpress_get_v1_chat_conversations_by_id_participants_by_useridREAD

Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation). (Runtime API) via GET /v1/chat/conversations/{id}/participants/{userId}

api

botpress_get_v1_chat_eventsREAD

Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first. (Runtime API) via GET /v1/chat/events

api

botpress_get_v1_chat_events_by_idREAD

Retrieves the [Event](#schema_event) object for a valid identifiers. (Runtime API) via GET /v1/chat/events/{id}

api

botpress_get_v1_chat_integration_identifiers_availabilityREAD

Check whether an identifier is available, shareable, or unavailable for the calling integration (Runtime API) via GET /v1/chat/integration/identifiers/availability

api

botpress_get_v1_chat_integration_instance_identifiersREAD

List the identifiers held by the calling integration instance (Runtime API) via GET /v1/chat/integration-instance/identifiers

api

botpress_get_v1_chat_messagesREAD

Retrieves a list of [Message](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags). (Runtime API) via GET /v1/chat/messages

api

botpress_get_v1_chat_messages_by_idREAD

Retrieves the [Message](#schema_message) object for a valid identifier. (Runtime API) via GET /v1/chat/messages/{id}

api

botpress_get_v1_chat_states_by_type_by_id_by_nameREAD

Retrieves the [State](#schema_state) object for a valid identifier. (Runtime API) via GET /v1/chat/states/{type}/{id}/{name}

api

botpress_get_v1_chat_usersREAD

Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags). (Runtime API) via GET /v1/chat/users

api

botpress_get_v1_chat_users_by_idREAD

Retrieves the [User](#schema_user) object for a valid identifier. (Runtime API) via GET /v1/chat/users/{id}

api

botpress_get_v1_filesREAD

List files for bot (Files API) via GET /v1/files

api

botpress_get_v1_files_by_idREAD

Get file (Files API) via GET /v1/files/{id}

api

botpress_get_v1_files_by_id_passagesREAD

List passages for a file (Files API) via GET /v1/files/{id}/passages

api

botpress_get_v1_files_searchREAD

Search files (Files API) via GET /v1/files/search

api

botpress_get_v1_files_tagsREAD

List available tags (Files API) via GET /v1/files/tags

api

botpress_get_v1_files_tags_by_tag_valuesREAD

List available tags (Files API) via GET /v1/files/tags/{tag}/values

api

botpress_get_v1_tablesREAD

Retrieves a list of all tables associated with your bot. (Tables API) via GET /v1/tables

api

botpress_get_v1_tables_by_tableREAD

Retrieves detailed information about a specific table, identified by its name or unique identifier. (Tables API) via GET /v1/tables/{table}

api

botpress_get_v1_tables_by_table_rowREAD

Fetches a specific row from a table using the row's unique identifier. (Tables API) via GET /v1/tables/{table}/row

api

botpress_patch_v1_chat_states_by_type_by_id_by_nameWRITE

Updates the [State](#schema_state) object by setting the values of the parameters passed. (Runtime API) via PATCH /v1/chat/states/{type}/{id}/{name}

api

botpress_post_v1_admin_botsWRITE

Create bot (Admin API) via POST /v1/admin/bots

api

botpress_post_v1_admin_integrationsWRITE

Create integration (Admin API) via POST /v1/admin/integrations

api

botpress_post_v1_admin_integrations_validateWRITE

Perform a validation of an integration creation request (Admin API) via POST /v1/admin/integrations/validate

api

botpress_post_v1_admin_workspace_membersWRITE

Add a member to the workspace (Admin API) via POST /v1/admin/workspace-members

api

botpress_post_v1_admin_workspacesWRITE

Create workspace (Admin API) via POST /v1/admin/workspaces

api

botpress_post_v1_chat_actionsWRITE

Call an action (Runtime API) via POST /v1/chat/actions

api

botpress_post_v1_chat_conversationsWRITE

Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details. (Runtime API) via POST /v1/chat/conversations

api

botpress_post_v1_chat_conversations_by_id_participantsWRITE

Add a [Participant](#schema_participant) to a [Conversation](#schema_conversation). (Runtime API) via POST /v1/chat/conversations/{id}/participants

api

botpress_post_v1_chat_conversations_get_or_createWRITE

Retrieves the [Conversation](#schema_conversation) object containing given tags. If the conversation does not exist, it will be created. Tags will be updated if they are set in the request body. (Runtime API) via POST /v1/chat/conversations/get-or-create

api

botpress_post_v1_chat_eventsWRITE

Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details. (Runtime API) via POST /v1/chat/events

api

botpress_post_v1_chat_integrations_configureWRITE

An integration can call this endpoint to configure itself. When `identifiers` fails because a value is already claimed by another instance (or the sharing cap is reached), the whole call is rejected with a 409 and no changes from the request are applied. (Runtime API) via POST /v1/chat/integrations/configure

api

botpress_post_v1_chat_messagesWRITE

Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details. (Runtime API) via POST /v1/chat/messages

api

botpress_post_v1_chat_messages_get_or_createWRITE

Retrieves the [Message](#schema_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. (Runtime API) via POST /v1/chat/messages/get-or-create

api

botpress_post_v1_chat_states_by_type_by_id_by_nameWRITE

Overrides the [State](#schema_state) object by setting the values of the parameters passed. (Runtime API) via POST /v1/chat/states/{type}/{id}/{name}

api

botpress_post_v1_chat_states_by_type_by_id_by_name_expiryWRITE

Updates the [State](#schema_state) expiry. (Runtime API) via POST /v1/chat/states/{type}/{id}/{name}/expiry

api

botpress_post_v1_chat_states_by_type_by_id_by_name_get_or_setWRITE

Retrieves the [State](#schema_state) object for a valid identifiers. If the state does not exist, it creates a new state. (Runtime API) via POST /v1/chat/states/{type}/{id}/{name}/get-or-set

api

botpress_post_v1_chat_usersWRITE

Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details. (Runtime API) via POST /v1/chat/users

api

botpress_post_v1_chat_users_get_or_createWRITE

Retrieves the [User](#schema_user) object for given discriminating tags. If the user does not exist, it will be created. If the user already exists, its name, pictureUrl, attributes, and tags will be updated with the provided values. (Runtime API) via POST /v1/chat/users/get-or-create

api

botpress_post_v1_files_by_idorkey_by_destinationkeyWRITE

Copy file (Files API) via POST /v1/files/{idOrKey}/{destinationKey}

api

botpress_post_v1_tablesWRITE

Initiates the creation of a new table based on the provided schema, excluding system-managed fields like IDs and timestamps. (Tables API) via POST /v1/tables

api

botpress_post_v1_tables_by_sourcetableid_duplicateWRITE

Duplicates the table schema & content (Tables API) via POST /v1/tables/{sourceTableId}/duplicate

api

botpress_post_v1_tables_by_tableWRITE

Retrieves information about a specific table if it exists; otherwise, creates a new table based on the provided schema. (Tables API) via POST /v1/tables/{table}

api

botpress_post_v1_tables_by_table_rowsWRITE

Inserts one or multiple new rows into the specified table. (Tables API) via POST /v1/tables/{table}/rows

api

botpress_post_v1_tables_by_table_rows_deleteWRITE

Allows selective deletion of rows or complete clearance of a table. (Tables API) via POST /v1/tables/{table}/rows/delete

api

botpress_post_v1_tables_by_table_rows_findWRITE

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. (Tables API) via POST /v1/tables/{table}/rows/find

api

botpress_post_v1_tables_by_table_rows_upsertWRITE

Inserts or updates rows based on a key. If a row exists, it is updated; otherwise, a new row is created. (Tables API) via POST /v1/tables/{table}/rows/upsert

api

botpress_put_v1_admin_account_meWRITE

Update details of the account associated with authenticated user (Admin API) via PUT /v1/admin/account/me

api

botpress_put_v1_admin_bots_by_idWRITE

Update bot (Admin API) via PUT /v1/admin/bots/{id}

api

botpress_put_v1_admin_integrations_by_idWRITE

Update integration (Admin API) via PUT /v1/admin/integrations/{id}

api

botpress_put_v1_admin_integrations_by_id_validateWRITE

Perform a validation of an integration update request (Admin API) via PUT /v1/admin/integrations/{id}/validate

api

botpress_put_v1_admin_workspace_members_by_idWRITE

Update the member of a workspace (Admin API) via PUT /v1/admin/workspace-members/{id}

api

botpress_put_v1_admin_workspaces_by_idWRITE

Update workspace (Admin API) via PUT /v1/admin/workspaces/{id}

api

botpress_put_v1_chat_conversations_by_idWRITE

Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. (Runtime API) via PUT /v1/chat/conversations/{id}

api

botpress_put_v1_chat_messages_by_idWRITE

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. The other way around it also true; Calling this operation from the bot, to update an outgoing message, will not invoke the integration. (Runtime API) via PUT /v1/chat/messages/{id}

api

botpress_put_v1_chat_users_by_idWRITE

Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. (Runtime API) via PUT /v1/chat/users/{id}

api

botpress_put_v1_filesWRITE

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. (Files API) via PUT /v1/files

api

botpress_put_v1_files_by_idWRITE

Update file metadata, without updating the file content. (Files API) via PUT /v1/files/{id}

api

botpress_put_v1_tables_by_tableWRITE

Updates the schema or the name of an existing table. (Tables API) via PUT /v1/tables/{table}

api

botpress_put_v1_tables_by_table_columnWRITE

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. (Tables API) via PUT /v1/tables/{table}/column

api

botpress_put_v1_tables_by_table_rowsWRITE

Updates specified rows in a table, allowing partial success with detailed feedback on errors. (Tables API) via PUT /v1/tables/{table}/rows

api