createBot

Create bot

POST /v1/admin/bots

cURL

cURL

curl --request POST \
  --url https://api.botpress.cloud/v1/admin/bots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "states": {},
  "events": {},
  "recurringEvents": {},
  "actions": {},
  "configuration": {
    "data": {},
    "schema": {}
  },
  "user": {
    "tags": {}
  },
  "conversation": {
    "tags": {}
  },
  "message": {
    "tags": {}
  },
  "tags": {},
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "medias": [
    {
      "url": "<string>",
      "name": "<string>"
    }
  ],
  "url": "<string>",
  "secrets": {},
  "dev": true
}
'

200

{
  "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,
    "secrets": [
      "<string>"
    ],
    "alwaysAlive": true,
    "medias": [
      {
        "url": "<string>",
        "name": "<string>"
      }
    ],
    "maxExecutionTime": 123,
    "description": "<string>",
    "deployedAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id · string · required

Workspace ID

x-multiple-integrations · string

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.

Body

application/json

Bot metadata

states · object

A mapping of states to their definition

Show child attributes

events · object

Events definition

Show child attributes

recurringEvents · object

Show child attributes

subscriptions · object

Subscriptions of the bot

Show child attributes

actions · object

Actions definition

Show child attributes

configuration · object

Show child attributes

user · object

Show child attributes

conversation · object

Show child attributes

message · object

Show child attributes

tags · object

Optional attributes of the Bot

Show child attributes

code · string

JavaScript code of the bot

name · string

Optional name for the bot, if not provided will be auto-generated

Minimum string length: 1

description · string

Optional description for the bot

Maximum string length: 2000

medias · object[]

Media files associated with the Bot

Show child attributes

url · string

URL of the Bot

secrets · object

Secrets are values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.

Show child attributes

dev · boolean

Indicates if the Bot is a development bot; Development bots run locally and can install dev integrations

Response

200

application/json

Success

bot · object · required

Show child attributes