Create Bot

Header Parameters

x-workspace-id*string

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.

Request Body

application/json

Bot metadata

TypeScript Definitions

Use the request body type in TypeScript.

states?

A mapping of states to their definition

events?

Events definition

recurringEvents?

subscriptions?

Subscriptions of the bot

actions?

Actions definition

configuration?

user?

conversation?

message?

tags?

Optional attributes of the Bot

code?string

JavaScript code of the bot

name?string

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

Length1 <= length

description?string

Optional description for the bot

Lengthlength <= 2000

medias?array<>

Media files associated with the Bot

url?string

URL of the Bot

secrets?

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.

dev?boolean

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

type?string

Type of the Bot

Value in

"studio"
"adk"
"desk"

maxExecutionTime?integer

Maximum execution time (in seconds).

Response Body

`application/json`

curl -X POST "https://example.com/v1/admin/bots" \  -H "x-workspace-id: string" \  -H "Content-Type: application/json" \  -d '{}'

{  "bot": {    "id": "stringstringstringstringstri",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "signingSecret": "string",    "integrations": {      "property1": {        "enabled": true,        "name": "string",        "version": "string",        "webhookUrl": "string",        "webhookId": "string",        "identifier": "string",        "configurationType": "string",        "configuration": {},        "status": "registration_pending",        "statusReason": "string",        "disabledChannels": [          "string"        ],        "id": "stringstringstringstringstri",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "title": "string",        "description": "string",        "iconUrl": "string",        "public": true,        "visibility": "public",        "verificationStatus": "unapproved",        "lifecycleStatus": "published"      },      "property2": {        "enabled": true,        "name": "string",        "version": "string",        "webhookUrl": "string",        "webhookId": "string",        "identifier": "string",        "configurationType": "string",        "configuration": {},        "status": "registration_pending",        "statusReason": "string",        "disabledChannels": [          "string"        ],        "id": "stringstringstringstringstri",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "title": "string",        "description": "string",        "iconUrl": "string",        "public": true,        "visibility": "public",        "verificationStatus": "unapproved",        "lifecycleStatus": "published"      }    },    "plugins": {      "property1": {        "enabled": true,        "name": "string",        "version": "string",        "configuration": {},        "interfaces": {          "property1": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string",            "integrationInterfaceAlias": "string",            "interfaceId": "stringstringstringstringstri"          },          "property2": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string",            "integrationInterfaceAlias": "string",            "interfaceId": "stringstringstringstringstri"          }        },        "integrations": {          "property1": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string"          },          "property2": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string"          }        },        "id": "stringstringstringstringstri",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "title": "string",        "description": "string",        "iconUrl": "string",        "readmeUrl": "string",        "public": true,        "visibility": "public",        "lifecycleStatus": "published"      },      "property2": {        "enabled": true,        "name": "string",        "version": "string",        "configuration": {},        "interfaces": {          "property1": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string",            "integrationInterfaceAlias": "string",            "interfaceId": "stringstringstringstringstri"          },          "property2": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string",            "integrationInterfaceAlias": "string",            "interfaceId": "stringstringstringstringstri"          }        },        "integrations": {          "property1": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string"          },          "property2": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string"          }        },        "id": "stringstringstringstringstri",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "title": "string",        "description": "string",        "iconUrl": "string",        "readmeUrl": "string",        "public": true,        "visibility": "public",        "lifecycleStatus": "published"      }    },    "maxExecutionTime": 0,    "user": {      "tags": {        "property1": {          "title": "string",          "description": "string"        },        "property2": {          "title": "string",          "description": "string"        }      }    },    "conversation": {      "tags": {        "property1": {          "title": "string",          "description": "string"        },        "property2": {          "title": "string",          "description": "string"        }      }    },    "message": {      "tags": {        "property1": {          "title": "string",          "description": "string"        },        "property2": {          "title": "string",          "description": "string"        }      }    },    "states": {      "property1": {        "type": "conversation",        "schema": {},        "expiry": 1      },      "property2": {        "type": "conversation",        "schema": {},        "expiry": 1      }    },    "configuration": {      "data": {},      "schema": {}    },    "events": {      "property1": {        "title": "string",        "description": "string",        "schema": {},        "attributes": {          "property1": "string",          "property2": "string"        }      },      "property2": {        "title": "string",        "description": "string",        "schema": {},        "attributes": {          "property1": "string",          "property2": "string"        }      }    },    "recurringEvents": {      "property1": {        "schedule": {          "cron": "string"        },        "type": "string",        "payload": {},        "failedAttempts": 0,        "lastFailureReason": "string"      },      "property2": {        "schedule": {          "cron": "string"        },        "type": "string",        "payload": {},        "failedAttempts": 0,        "lastFailureReason": "string"      }    },    "subscriptions": {      "events": {        "property1": {},        "property2": {}      }    },    "actions": {      "property1": {        "title": "string",        "description": "string",        "billable": true,        "cacheable": true,        "input": {          "schema": {}        },        "output": {          "schema": {}        },        "attributes": {          "property1": "string",          "property2": "string"        }      },      "property2": {        "title": "string",        "description": "string",        "billable": true,        "cacheable": true,        "input": {          "schema": {}        },        "output": {          "schema": {}        },        "attributes": {          "property1": "string",          "property2": "string"        }      }    },    "tags": {      "property1": "string",      "property2": "string"    },    "name": "string",    "description": "string",    "deployedAt": "2019-08-24T14:15:22Z",    "dev": true,    "secrets": [      "string"    ],    "createdBy": "string",    "alwaysAlive": true,    "status": "active",    "medias": [      {        "url": "string",        "name": "string"      }    ],    "type": "studio"  }}

{  "bot": {    "id": "stringstringstringstringstri",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "signingSecret": "string",    "integrations": {      "property1": {        "enabled": true,        "name": "string",        "version": "string",        "webhookUrl": "string",        "webhookId": "string",        "identifier": "string",        "configurationType": "string",        "configuration": {},        "status": "registration_pending",        "statusReason": "string",        "disabledChannels": [          "string"        ],        "id": "stringstringstringstringstri",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "title": "string",        "description": "string",        "iconUrl": "string",        "public": true,        "visibility": "public",        "verificationStatus": "unapproved",        "lifecycleStatus": "published"      },      "property2": {        "enabled": true,        "name": "string",        "version": "string",        "webhookUrl": "string",        "webhookId": "string",        "identifier": "string",        "configurationType": "string",        "configuration": {},        "status": "registration_pending",        "statusReason": "string",        "disabledChannels": [          "string"        ],        "id": "stringstringstringstringstri",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "title": "string",        "description": "string",        "iconUrl": "string",        "public": true,        "visibility": "public",        "verificationStatus": "unapproved",        "lifecycleStatus": "published"      }    },    "plugins": {      "property1": {        "enabled": true,        "name": "string",        "version": "string",        "configuration": {},        "interfaces": {          "property1": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string",            "integrationInterfaceAlias": "string",            "interfaceId": "stringstringstringstringstri"          },          "property2": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string",            "integrationInterfaceAlias": "string",            "interfaceId": "stringstringstringstringstri"          }        },        "integrations": {          "property1": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string"          },          "property2": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string"          }        },        "id": "stringstringstringstringstri",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "title": "string",        "description": "string",        "iconUrl": "string",        "readmeUrl": "string",        "public": true,        "visibility": "public",        "lifecycleStatus": "published"      },      "property2": {        "enabled": true,        "name": "string",        "version": "string",        "configuration": {},        "interfaces": {          "property1": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string",            "integrationInterfaceAlias": "string",            "interfaceId": "stringstringstringstringstri"          },          "property2": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string",            "integrationInterfaceAlias": "string",            "interfaceId": "stringstringstringstringstri"          }        },        "integrations": {          "property1": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string"          },          "property2": {            "integrationId": "stringstringstringstringstri",            "integrationAlias": "string"          }        },        "id": "stringstringstringstringstri",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "title": "string",        "description": "string",        "iconUrl": "string",        "readmeUrl": "string",        "public": true,        "visibility": "public",        "lifecycleStatus": "published"      }    },    "maxExecutionTime": 0,    "user": {      "tags": {        "property1": {          "title": "string",          "description": "string"        },        "property2": {          "title": "string",          "description": "string"        }      }    },    "conversation": {      "tags": {        "property1": {          "title": "string",          "description": "string"        },        "property2": {          "title": "string",          "description": "string"        }      }    },    "message": {      "tags": {        "property1": {          "title": "string",          "description": "string"        },        "property2": {          "title": "string",          "description": "string"        }      }    },    "states": {      "property1": {        "type": "conversation",        "schema": {},        "expiry": 1      },      "property2": {        "type": "conversation",        "schema": {},        "expiry": 1      }    },    "configuration": {      "data": {},      "schema": {}    },    "events": {      "property1": {        "title": "string",        "description": "string",        "schema": {},        "attributes": {          "property1": "string",          "property2": "string"        }      },      "property2": {        "title": "string",        "description": "string",        "schema": {},        "attributes": {          "property1": "string",          "property2": "string"        }      }    },    "recurringEvents": {      "property1": {        "schedule": {          "cron": "string"        },        "type": "string",        "payload": {},        "failedAttempts": 0,        "lastFailureReason": "string"      },      "property2": {        "schedule": {          "cron": "string"        },        "type": "string",        "payload": {},        "failedAttempts": 0,        "lastFailureReason": "string"      }    },    "subscriptions": {      "events": {        "property1": {},        "property2": {}      }    },    "actions": {      "property1": {        "title": "string",        "description": "string",        "billable": true,        "cacheable": true,        "input": {          "schema": {}        },        "output": {          "schema": {}        },        "attributes": {          "property1": "string",          "property2": "string"        }      },      "property2": {        "title": "string",        "description": "string",        "billable": true,        "cacheable": true,        "input": {          "schema": {}        },        "output": {          "schema": {}        },        "attributes": {          "property1": "string",          "property2": "string"        }      }    },    "tags": {      "property1": "string",      "property2": "string"    },    "name": "string",    "description": "string",    "deployedAt": "2019-08-24T14:15:22Z",    "dev": true,    "secrets": [      "string"    ],    "createdBy": "string",    "alwaysAlive": true,    "status": "active",    "medias": [      {        "url": "string",        "name": "string"      }    ],    "type": "studio"  }}

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`