Tool to create a new conversation in Botpress via the Runtime API. Use when you need to initiate a new conversation thread. The required tags must be provided according to the specific integration being used.
idstringOptional custom identifier for the conversation. If not provided, one will be auto-generated.
tagsRequiredobjectTags for the conversation. Required tags depend on the specific integration. Provide as a dictionary of key-value pairs.
botIdRequiredstringUUID of the bot to create the conversation for. This is passed as the x-bot-id header.
channelRequiredstringChannel name as defined in the integration. For chat integration, use 'channel'. This must match a channel defined in the specific integration being used.
integrationIdstringIntegration identifier (UUID). Either integration_id or integration_alias must be provided. This is passed as the x-integration-id header.
integrationAliasstringIntegration alias. Either integration_id or integration_alias must be provided. This is passed as the x-integration-alias header.
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.