Chat API
- Introduction
- Endpoints
Admin API
- Getting started
- Concepts
- Endpoints
- GETgetAccount
- PUTupdateAccount
- GETlistPublicIntegrations
- GETgetPublicIntegrationById
- GETgetPublicIntegration
- POSTcreateBot
- GETlistBots
- PUTupdateBot
- GETgetBot
- DELdeleteBot
- GETgetBotLogs
- GETgetBotAnalytics
- GETgetBotIssue
- DELdeleteBotIssue
- GETlistBotIssues
- GETlistBotIssueEvents
- POSTcreateWorkspace
- GETlistWorkspaces
- GETgetPublicWorkspace
- GETgetWorkspace
- PUTupdateWorkspace
- DELdeleteWorkspace
- GETlistPublicWorkspaces
- GETgetAuditRecords
- GETlistWorkspaceMembers
- POSTcreateWorkspaceMember
- GETgetWorkspaceMember
- DELdeleteWorkspaceMember
- PUTupdateWorkspaceMember
- POSTcreateIntegration
- GETlistIntegrations
- POSTvalidateIntegrationCreation
- PUTupdateIntegration
- GETgetIntegration
- DELdeleteIntegration
- PUTvalidateIntegrationUpdate
- GETgetIntegrationLogs
- GETgetIntegrationByName
- GET
Files API
Tables API
- Getting Started
- Endpoints
Runtime API
- Getting Started
- Concepts
- Endpoints
createBot
Create bot
curl --request POST \
--url https://api.botpress.cloud/v1/admin/bots \
--header 'Content-Type: application/json' \
--data '{
"states": {},
"events": {},
"recurringEvents": {},
"subscriptions": {
"events": {}
},
"actions": {},
"configuration": {
"data": {},
"schema": {}
},
"user": {
"tags": {}
},
"conversation": {
"tags": {}
},
"message": {
"tags": {}
},
"tags": {},
"code": "<string>",
"name": "<string>",
"medias": [
{
"url": "<string>",
"name": "<string>"
}
],
"url": "<string>",
"dev": true
}'{
"bot": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"signingSecret": "<string>",
"integrations": {},
"user": {
"tags": {}
},
"conversation": {
"tags": {}
},
"message": {
"tags": {}
},
"states": {},
"configuration": {
"data": {},
"schema": {}
},
"events": {},
"recurringEvents": {},
"subscriptions": {
"events": {}
},
"actions": {},
"tags": {},
"name": "<string>",
"deployedAt": "2023-11-07T05:31:56Z",
"dev": true,
"createdBy": "<string>",
"alwaysAlive": true,
"status": "active",
"medias": [
{
"url": "<string>",
"name": "<string>"
}
]
}
}Body
Actions definition
Action definition
Title of the action
64Description of the action
256JavaScript code of the bot
Optional name for the bot, if not provided will be auto-generated
1Response
A mapping of integrations to their configuration
Name of the Integration
200Version of the Integration
2002000200200registration_pending, registered, registration_failed, unregistration_pending, unregistered, unregistration_failed 2000ID 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
Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
Status of the integration version verification
unapproved, pending, approved, rejected 2000Conversation object configuration
Recurring events
200200The 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
Action definition
Title of the action
64Description of the action
256Indicates if the Bot is a development bot; Development bots run locally and can install dev integrations
Status of the bot
active, deploying Id of the user that created the bot
Was this page helpful?
curl --request POST \
--url https://api.botpress.cloud/v1/admin/bots \
--header 'Content-Type: application/json' \
--data '{
"states": {},
"events": {},
"recurringEvents": {},
"subscriptions": {
"events": {}
},
"actions": {},
"configuration": {
"data": {},
"schema": {}
},
"user": {
"tags": {}
},
"conversation": {
"tags": {}
},
"message": {
"tags": {}
},
"tags": {},
"code": "<string>",
"name": "<string>",
"medias": [
{
"url": "<string>",
"name": "<string>"
}
],
"url": "<string>",
"dev": true
}'{
"bot": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"signingSecret": "<string>",
"integrations": {},
"user": {
"tags": {}
},
"conversation": {
"tags": {}
},
"message": {
"tags": {}
},
"states": {},
"configuration": {
"data": {},
"schema": {}
},
"events": {},
"recurringEvents": {},
"subscriptions": {
"events": {}
},
"actions": {},
"tags": {},
"name": "<string>",
"deployedAt": "2023-11-07T05:31:56Z",
"dev": true,
"createdBy": "<string>",
"alwaysAlive": true,
"status": "active",
"medias": [
{
"url": "<string>",
"name": "<string>"
}
]
}
}