Create a new chat agent with specified configuration. Use when you need to set up a chat-based AI agent with custom response engine and behavior settings.
languagestringLanguage/dialect for chat operations (e.g., 'en-US', 'es-ES'). Defaults to 'en-US'.
is_publicbooleanWhether this chat agent is available for public preview
agent_namestringChat agent identifier for reference purposes
pii_configobjectPII (Personally Identifiable Information) scrubbing configuration
webhook_urlstringURL that will receive chat event notifications (e.g., chat started, ended, analyzed)
response_engineRequiredThe Response Engine generating agent responses. Required field with type, llm_id, and version.
opt_in_signed_urlbooleanEnable signed URLs for public logs access. When enabled, secure time-limited URLs are generated.
auto_close_messagestringMessage displayed when chat auto-closes after silence period
webhook_timeout_msintegerWebhook timeout in milliseconds. Defaults to 10,000ms.
data_storage_settingstringData retention policy for the chat. Options: 'everything', 'everything_except_pii', or 'basic_attributes_only'.
analysis_summary_promptstringSummary generation guidance for chat analysis. Maximum 2000 characters.
post_chat_analysis_dataarrayCustom analysis extraction schema for post-chat analysis
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.