Tool to create a new bot in a Botpress workspace via the Admin API. Use when you need to provision a new bot with optional configuration including name, code, tags, events, states, and integrations.
devbooleanIndicates if this is a development bot. Set to true for local development bots.
urlstringURL for development bot webhooks. Only applicable when dev=true.
codestringJavaScript code containing the bot's custom logic and behavior.
namestringName identifier for the bot. If not provided, the API will auto-generate a unique name. Must be unique within the workspace.
tagsobjectCustom key-value metadata tags for the bot. Each value limited to 500 characters.
userobjectUser tag definitions for metadata on user objects.
eventsobjectEvent definitions with title, description, and schema for custom bot events.
mediasarrayArray of media files. Each item must have 'url' and 'name' properties.
statesobjectConversation/user/bot/task state definitions with schema validation and expiry settings.
actionsobjectCustom action definitions with input/output schemas for bot actions.
messageobjectMessage tag definitions for metadata on message objects.
conversationobjectConversation tag definitions for metadata on conversation objects.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.