Tool to create a new chat session with a chat agent. Use when you need to initiate a new chat conversation with a RetellAI chat agent.
agent_idRequiredstringThe chat agent to use for the call.
metadataobjectAn arbitrary object for storage purpose only. You can put anything here like your internal customer id associated with the chat. Not used for processing. You can later get this field from the chat object.
agent_versionintegerThe version of the chat agent to use for the chat. If not provided, will default to latest version.
retell_llm_dynamic_variablesobjectAdd optional dynamic variables in key value pairs of string that injects into your Response Engine prompt and tool description. Only applicable for Response Engine.
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.