Chat API
Admin API
Tables API
Runtime API
curl --request PUT \
--url https://api.botpress.cloud/v1/admin/bots/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-workspace-id: <x-workspace-id>' \
--data '
{
"url": "<string>",
"authentication": "iam",
"configuration": {
"data": {},
"schema": {}
},
"tags": {},
"blocked": true,
"maxExecutionTime": 123,
"alwaysAlive": true,
"user": {
"tags": {}
},
"message": {
"tags": {}
},
"conversation": {
"tags": {}
},
"events": {},
"actions": {},
"states": {},
"recurringEvents": {},
"integrations": {},
"plugins": {},
"subscriptions": {
"events": {}
},
"code": "<string>",
"name": "<string>",
"medias": [
{
"url": "<string>",
"name": "<string>"
}
],
"layers": [
"<string>"
],
"shouldMergePlugins": true
}
'{
"bot": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"signingSecret": "<string>",
"integrations": {},
"plugins": {},
"user": {
"tags": {}
},
"conversation": {
"tags": {}
},
"message": {
"tags": {}
},
"states": {},
"configuration": {
"data": {},
"schema": {}
},
"events": {},
"recurringEvents": {},
"subscriptions": {
"events": {}
},
"actions": {},
"tags": {},
"name": "<string>",
"dev": true,
"alwaysAlive": true,
"status": "active",
"medias": [
{
"url": "<string>",
"name": "<string>"
}
],
"maxExecutionTime": 123,
"deployedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}
}updateBot
Update bot
curl --request PUT \
--url https://api.botpress.cloud/v1/admin/bots/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-workspace-id: <x-workspace-id>' \
--data '
{
"url": "<string>",
"authentication": "iam",
"configuration": {
"data": {},
"schema": {}
},
"tags": {},
"blocked": true,
"maxExecutionTime": 123,
"alwaysAlive": true,
"user": {
"tags": {}
},
"message": {
"tags": {}
},
"conversation": {
"tags": {}
},
"events": {},
"actions": {},
"states": {},
"recurringEvents": {},
"integrations": {},
"plugins": {},
"subscriptions": {
"events": {}
},
"code": "<string>",
"name": "<string>",
"medias": [
{
"url": "<string>",
"name": "<string>"
}
],
"layers": [
"<string>"
],
"shouldMergePlugins": true
}
'{
"bot": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"signingSecret": "<string>",
"integrations": {},
"plugins": {},
"user": {
"tags": {}
},
"conversation": {
"tags": {}
},
"message": {
"tags": {}
},
"states": {},
"configuration": {
"data": {},
"schema": {}
},
"events": {},
"recurringEvents": {},
"subscriptions": {
"events": {}
},
"actions": {},
"tags": {},
"name": "<string>",
"dev": true,
"alwaysAlive": true,
"status": "active",
"medias": [
{
"url": "<string>",
"name": "<string>"
}
],
"maxExecutionTime": 123,
"deployedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Workspace ID
Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.
Path Parameters
Bot ID
Body
Bot metadata
Maximum execution time (in seconds).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Title of the event
64Description of the event
256Show child attributes
Show child attributes
Show child attributes
Show child attributes
Title of the action
64Description of the action
256Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Integration's definition ID. If defined, the record's key is treated as an alias for the integration instance.
Integration's configuration type. Set to default if null.
Disabled channels for this integration
Channel name
A mapping of plugin aliases to their configuration
Show child attributes
Show child attributes
Show child attributes
Show child attributes
A mapping of plugin interface aliases to their backing integrations
Show child attributes
Show child attributes
Show child attributes
Show child attributes
When an alias is provided, the plugin will use the integration corresponding to this alias. If not provided, the first integration matching the integrationId will be used.
When an alias is provided, the plugin will use the integration interface corresponding to this alias.
JavaScript code of the bot
Optional name for the bot, if not provided will be auto-generated
1UNUSED. Please ignore this field. It will be removed in the near future.
Response
Success
Show child attributes
Show child attributes
A mapping of integrations to their configuration. If the x-multiple-integrations header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Name of the Integration
200Version of the Integration
2002000200200registration_pending, registered, registration_failed, unregistration_pending, unregistered, unregistration_failed 2000Disabled channels for this integration
Channel name
ID of the Integration
28 - 36Creation date of the Integration in ISO 8601 format
Updating date of the Integration in ISO 8601 format
Title of the integration. This is the name that will be displayed in the UI
1 - 64Description of the integration. This is the description that will be displayed in the UI
256URL of the icon of the integration. This is the icon that will be displayed in the UI
[DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
public, private, unlisted Status of the integration version verification
unapproved, pending, approved, rejected 2000A mapping of plugin aliases to their configuration
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Title of the plugin. This is the name that will be displayed in the UI
1 - 64Description of the plugin. This is the description that will be displayed in the UI
256URL of the icon of the plugin. This is the icon that will be displayed in the UI
URL of the readme of the plugin. This is the readme that will be displayed in the UI
Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
A mapping of plugin interface aliases to their backing integrations
Show child attributes
Show child attributes
Show child attributes
Show child attributes
28 - 3620028 - 36200A mapping of plugin integration aliases to their backing integrations
User object configuration
Show child attributes
Show child attributes
Conversation object configuration
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Message object configuration
Show child attributes
Show child attributes
A mapping of states to their definition
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Events definition
Show child attributes
Show child attributes
Event Definition
Show child attributes
Show child attributes
Title of the event
64Description of the event
256Recurring events
Show child attributes
Show child attributes
Show child attributes
Show child attributes
200The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.
The reason why the recurring event failed to run in the last attempt.
2000Actions definition
Show child attributes
Show child attributes
Action definition
Show child attributes
Show child attributes
Title of the action
64Description of the action
256Status of the bot
active, deploying Maximum execution time of the bot (in seconds).
Id of the user that created the bot
Was this page helpful?