Docs

createBot

Create bot

POST/v1/admin/bots

Authorization

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

Header parameters

x-workspace-idstring
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

Bot metadata

states?object
A mapping of states to their definition
events?object
Events definition
recurringEvents?object
subscriptions?object
Subscriptions of the bot
actions?object
Actions definition
configuration?object
user?object
conversation?object
message?object
tags?object
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(min length: 1)
description?string
Optional description for the bot(max length: 2000)
medias?object[]
Media files associated with the Bot
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.
dev?boolean
Indicates if the Bot is a development bot; Development bots run locally and can install dev integrations
type?enum<string>
Available options:"studio","adk"
maxExecutionTime?integer
Maximum execution time (in seconds).

Response

Success

botobject