Tool to create a new conversation. Use when you need to start a new chat session with a bot. Conversations store message history between users and bots. You can either reference an existing bot by ID or configure a new bot inline.
metaobjectAdditional metadata to associate with the conversation as key-value pairs.
namestringName of the conversation for identification and organization purposes.
botIdstringID of an existing bot to use for this conversation. Use this OR inline bot configuration (model, backstory, etc.), not both.
modelstringModel definition for inline bot configuration. Specify the AI model to use (e.g., 'gpt-3.5-turbo', 'gpt-4'). Only used if botId is not provided.
taskIdstringID of a task to associate with this conversation.
privacybooleanPrivacy flag. Set to true to enable privacy mode for this conversation.
spaceIdstringID of a space to associate with this conversation for organization.
messagesarrayInitial messages to seed the conversation with. Each message must have a type and text.
backstorystringBot backstory for inline bot configuration. Sets the bot's personality and context. Only used if botId is not provided.
contactIdstringID of a contact to associate with this conversation.
datasetIdstringID of a dataset to associate with the conversation for knowledge retrieval.
moderationbooleanModeration flag. Set to true to enable content moderation for this conversation.
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.