Create Chat Agent
Creates a chat agent in Retell AI.
Query
Comma-separated response fields to include.
Body
List of PII categories to scrub from transcripts and recordings.
Examples of the variable value to teach model the style and syntax.
Selected prohibited user topic categories to check. When user messages contain these topics, the agent will respond with a placeholder message instead of processing the request.
Selected prohibited agent topic categories to check. When agent messages contain these topics, they will be replaced with a placeholder message.
Post chat analysis data to extract from the chat. This data will augment the pre-defined variables extracted in the chat analysis. This will be available after the chat ends.
Which webhook events this agent should receive. If not set, defaults to chat_started, chat_ended, chat_analyzed.
type of the Response Engine. Allowed values: retell-llm.
id of the Retell LLM Response Engine.
Version of the Retell LLM Response Engine.
The name of the chat agent. Only used for your own reference.
Message to display when the chat is automatically closed.
If users stay silent for a period after agent speech, end the chat. The minimum value allowed is 120,000 ms (2 minutes). The maximum value allowed is 259,200,000 ms (72 hours). By default, this is set to 3,600,000 (1 hour).
Specifies what language (and dialect) the chat will operate in. For instance, selecting `en-GB` optimizes for British English. If unset, will use default value `en-US`. Select `multi` for multilingual support, currently this supports Spanish and English.
The webhook for agent to listen to chat events. See what events it would get at [webhook doc](/features/webhook). If set, will binds webhook events for this agent to the specified url, and will ignore the account level webhook for this agent. Set to `null` to remove webhook url from this agent.
The timeout for the webhook in milliseconds. If not set, default value of 10000 will apply.
Controls what data is stored for this agent. "everything" stores all data including transcripts and recordings. "everything_except_pii" stores data but excludes PII when possible based on PII configuration. "basic_attributes_only" stores only basic metadata. If not set, defaults to "everything". Allowed values: everything, everything_except_pii, basic_attributes_only.
Number of days to retain call/chat data before automatic deletion. Must be between 1 and 730 days. If not set, data is retained forever (no automatic deletion).
Whether this agent opts in to signed url for public log. If not set, default value of false will apply.
The expiration time for the signed url in milliseconds. Only applicable when opt_in_signed_url is true. If not set, default value of 86400000 (24 hours) will apply.
Type of the variable to extract. Allowed values: string.
Name of the variable.
Description of the variable.
Whether this data is required. If true and the data is not extracted, the call will be marked as unsuccessful.
Available LLM models for agents.
The prompt to use for post call analysis to evaluate whether the call is successful. Set to null to use the default prompt.
The prompt to use for post call analysis to summarize the call. Set to null to use the default prompt.
Prompt to guide how the post chat analysis should evaluate user sentiment. When unset, the default system prompt is used. Set to null to use the default prompt.
The processing mode for PII scrubbing. Currently only post-call is supported. Allowed values: post_call.
Whether the agent is public. When set to true, the agent is available for public agent preview link.