retell-sdk 4.66.0 → 5.1.0

package/resources/chat-agent.d.mts

@@ -0,0 +1,836 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class ChatAgent extends APIResource {
+    /**
+     * Create a new chat agent
+     *
+     * @example
+     * ```ts
+     * const chatAgentResponse = await client.chatAgent.create({
+     *   response_engine: {
+     *     llm_id: 'llm_234sdertfsdsfsdf',
+     *     type: 'retell-llm',
+     *   },
+     * });
+     * ```
+     */
+    create(body: ChatAgentCreateParams, options?: RequestOptions): APIPromise<ChatAgentResponse>;
+    /**
+     * Retrieve details of a specific chat agent
+     *
+     * @example
+     * ```ts
+     * const chatAgentResponse = await client.chatAgent.retrieve(
+     *   '16b980523634a6dc504898cda492e939',
+     * );
+     * ```
+     */
+    retrieve(agentID: string, query?: ChatAgentRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ChatAgentResponse>;
+    /**
+     * Update an existing chat agent
+     *
+     * @example
+     * ```ts
+     * const chatAgentResponse = await client.chatAgent.update(
+     *   '16b980523634a6dc504898cda492e939',
+     * );
+     * ```
+     */
+    update(agentID: string, params: ChatAgentUpdateParams, options?: RequestOptions): APIPromise<ChatAgentResponse>;
+    /**
+     * List all chat agents
+     *
+     * @example
+     * ```ts
+     * const chatAgentResponses = await client.chatAgent.list();
+     * ```
+     */
+    list(query?: ChatAgentListParams | null | undefined, options?: RequestOptions): APIPromise<ChatAgentListResponse>;
+    /**
+     * Delete an existing chat agent
+     *
+     * @example
+     * ```ts
+     * await client.chatAgent.delete(
+     *   'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+     * );
+     * ```
+     */
+    delete(agentID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get all versions of a chat agent
+     *
+     * @example
+     * ```ts
+     * const chatAgentResponses =
+     *   await client.chatAgent.getVersions(
+     *     '16b980523634a6dc504898cda492e939',
+     *   );
+     * ```
+     */
+    getVersions(agentID: string, options?: RequestOptions): APIPromise<ChatAgentGetVersionsResponse>;
+    /**
+     * Publish the latest version of the chat agent and create a new draft chat agent
+     * with newer version.
+     *
+     * @example
+     * ```ts
+     * await client.chatAgent.publish(
+     *   '16b980523634a6dc504898cda492e939',
+     * );
+     * ```
+     */
+    publish(agentID: string, options?: RequestOptions): APIPromise<void>;
+}
+export interface ChatAgentResponse {
+    /**
+     * Unique id of chat agent.
+     */
+    agent_id: string;
+    /**
+     * Last modification timestamp (milliseconds since epoch). Either the time of last
+     * update or creation if no updates available.
+     */
+    last_modification_timestamp: number;
+    /**
+     * The Response Engine to attach to the agent. It is used to generate responses for
+     * the agent. You need to create a Response Engine first before attaching it to an
+     * agent.
+     */
+    response_engine: ChatAgentResponse.ResponseEngineRetellLm | ChatAgentResponse.ResponseEngineCustomLm | ChatAgentResponse.ResponseEngineConversationFlow;
+    /**
+     * The name of the chat agent. Only used for your own reference.
+     */
+    agent_name?: string | null;
+    /**
+     * The prompt to use for post call analysis to evaluate whether the call is
+     * successful. Set to null to use the default prompt.
+     */
+    analysis_successful_prompt?: string | null;
+    /**
+     * The prompt to use for post call analysis to summarize the call. Set to null to
+     * use the default prompt.
+     */
+    analysis_summary_prompt?: string | null;
+    /**
+     * Message to display when the chat is automatically closed.
+     */
+    auto_close_message?: string | null;
+    /**
+     * 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".
+     */
+    data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only' | null;
+    /**
+     * 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).
+     */
+    end_chat_after_silence_ms?: number;
+    /**
+     * Configuration for guardrail checks to detect and prevent prohibited topics in
+     * agent output and user input.
+     */
+    guardrail_config?: ChatAgentResponse.GuardrailConfig;
+    /**
+     * Whether the agent is public. When set to true, the agent is available for public
+     * agent preview link.
+     */
+    is_public?: boolean | null;
+    /**
+     * Whether the chat agent is published.
+     */
+    is_published?: boolean;
+    /**
+     * 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.
+     */
+    language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'th-TH' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'multi';
+    /**
+     * Whether this agent opts in to signed url for public log. If not set, default
+     * value of false will apply.
+     */
+    opt_in_signed_url?: boolean;
+    /**
+     * Configuration for PII scrubbing from transcripts and recordings.
+     */
+    pii_config?: ChatAgentResponse.PiiConfig;
+    /**
+     * 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.
+     */
+    post_chat_analysis_data?: Array<ChatAgentResponse.StringAnalysisData | ChatAgentResponse.EnumAnalysisData | ChatAgentResponse.BooleanAnalysisData | ChatAgentResponse.NumberAnalysisData> | null;
+    /**
+     * The model to use for post chat analysis. Default to gpt-4.1-mini.
+     */
+    post_chat_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
+    /**
+     * 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.
+     */
+    signed_url_expiration_ms?: number | null;
+    /**
+     * The version of the chat agent.
+     */
+    version?: number;
+    /**
+     * Which webhook events this agent should receive. If not set, defaults to
+     * chat_started, chat_ended, chat_analyzed.
+     */
+    webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed'> | null;
+    /**
+     * The timeout for the webhook in milliseconds. If not set, default value of 10000
+     * will apply.
+     */
+    webhook_timeout_ms?: number;
+    /**
+     * 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.
+     */
+    webhook_url?: string | null;
+}
+export declare namespace ChatAgentResponse {
+    interface ResponseEngineRetellLm {
+        /**
+         * id of the Retell LLM Response Engine.
+         */
+        llm_id: string;
+        /**
+         * type of the Response Engine.
+         */
+        type: 'retell-llm';
+        /**
+         * Version of the Retell LLM Response Engine.
+         */
+        version?: number | null;
+    }
+    interface ResponseEngineCustomLm {
+        /**
+         * LLM websocket url of the custom LLM.
+         */
+        llm_websocket_url: string;
+        /**
+         * type of the Response Engine.
+         */
+        type: 'custom-llm';
+    }
+    interface ResponseEngineConversationFlow {
+        /**
+         * ID of the Conversation Flow Response Engine.
+         */
+        conversation_flow_id: string;
+        /**
+         * type of the Response Engine.
+         */
+        type: 'conversation-flow';
+        /**
+         * Version of the Conversation Flow Response Engine.
+         */
+        version?: number | null;
+    }
+    /**
+     * Configuration for guardrail checks to detect and prevent prohibited topics in
+     * agent output and user input.
+     */
+    interface GuardrailConfig {
+        /**
+         * 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.
+         */
+        input_topics?: Array<'platform_integrity_jailbreaking'> | null;
+        /**
+         * Selected prohibited agent topic categories to check. When agent messages contain
+         * these topics, they will be replaced with a placeholder message.
+         */
+        output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
+    }
+    /**
+     * Configuration for PII scrubbing from transcripts and recordings.
+     */
+    interface PiiConfig {
+        /**
+         * List of PII categories to scrub from transcripts and recordings.
+         */
+        categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
+        /**
+         * The processing mode for PII scrubbing. Currently only post-call is supported.
+         */
+        mode: 'post_call';
+    }
+    interface StringAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'string';
+        /**
+         * Examples of the variable value to teach model the style and syntax.
+         */
+        examples?: Array<string>;
+    }
+    interface EnumAnalysisData {
+        /**
+         * The possible values of the variable, must be non empty array.
+         */
+        choices: Array<string>;
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'enum';
+    }
+    interface BooleanAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'boolean';
+    }
+    interface NumberAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'number';
+    }
+}
+export type ChatAgentListResponse = Array<ChatAgentResponse>;
+export type ChatAgentGetVersionsResponse = Array<ChatAgentResponse>;
+export interface ChatAgentCreateParams {
+    /**
+     * The Response Engine to attach to the agent. It is used to generate responses for
+     * the agent. You need to create a Response Engine first before attaching it to an
+     * agent.
+     */
+    response_engine: ChatAgentCreateParams.ResponseEngineRetellLm | ChatAgentCreateParams.ResponseEngineCustomLm | ChatAgentCreateParams.ResponseEngineConversationFlow;
+    /**
+     * The name of the chat agent. Only used for your own reference.
+     */
+    agent_name?: string | null;
+    /**
+     * The prompt to use for post call analysis to evaluate whether the call is
+     * successful. Set to null to use the default prompt.
+     */
+    analysis_successful_prompt?: string | null;
+    /**
+     * The prompt to use for post call analysis to summarize the call. Set to null to
+     * use the default prompt.
+     */
+    analysis_summary_prompt?: string | null;
+    /**
+     * Message to display when the chat is automatically closed.
+     */
+    auto_close_message?: string | null;
+    /**
+     * 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".
+     */
+    data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only' | null;
+    /**
+     * 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).
+     */
+    end_chat_after_silence_ms?: number;
+    /**
+     * Configuration for guardrail checks to detect and prevent prohibited topics in
+     * agent output and user input.
+     */
+    guardrail_config?: ChatAgentCreateParams.GuardrailConfig;
+    /**
+     * Whether the agent is public. When set to true, the agent is available for public
+     * agent preview link.
+     */
+    is_public?: boolean | null;
+    /**
+     * 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.
+     */
+    language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'th-TH' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'multi';
+    /**
+     * Whether this agent opts in to signed url for public log. If not set, default
+     * value of false will apply.
+     */
+    opt_in_signed_url?: boolean;
+    /**
+     * Configuration for PII scrubbing from transcripts and recordings.
+     */
+    pii_config?: ChatAgentCreateParams.PiiConfig;
+    /**
+     * 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.
+     */
+    post_chat_analysis_data?: Array<ChatAgentCreateParams.StringAnalysisData | ChatAgentCreateParams.EnumAnalysisData | ChatAgentCreateParams.BooleanAnalysisData | ChatAgentCreateParams.NumberAnalysisData> | null;
+    /**
+     * The model to use for post chat analysis. Default to gpt-4.1-mini.
+     */
+    post_chat_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
+    /**
+     * 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.
+     */
+    signed_url_expiration_ms?: number | null;
+    /**
+     * Which webhook events this agent should receive. If not set, defaults to
+     * chat_started, chat_ended, chat_analyzed.
+     */
+    webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed'> | null;
+    /**
+     * The timeout for the webhook in milliseconds. If not set, default value of 10000
+     * will apply.
+     */
+    webhook_timeout_ms?: number;
+    /**
+     * 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.
+     */
+    webhook_url?: string | null;
+}
+export declare namespace ChatAgentCreateParams {
+    interface ResponseEngineRetellLm {
+        /**
+         * id of the Retell LLM Response Engine.
+         */
+        llm_id: string;
+        /**
+         * type of the Response Engine.
+         */
+        type: 'retell-llm';
+        /**
+         * Version of the Retell LLM Response Engine.
+         */
+        version?: number | null;
+    }
+    interface ResponseEngineCustomLm {
+        /**
+         * LLM websocket url of the custom LLM.
+         */
+        llm_websocket_url: string;
+        /**
+         * type of the Response Engine.
+         */
+        type: 'custom-llm';
+    }
+    interface ResponseEngineConversationFlow {
+        /**
+         * ID of the Conversation Flow Response Engine.
+         */
+        conversation_flow_id: string;
+        /**
+         * type of the Response Engine.
+         */
+        type: 'conversation-flow';
+        /**
+         * Version of the Conversation Flow Response Engine.
+         */
+        version?: number | null;
+    }
+    /**
+     * Configuration for guardrail checks to detect and prevent prohibited topics in
+     * agent output and user input.
+     */
+    interface GuardrailConfig {
+        /**
+         * 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.
+         */
+        input_topics?: Array<'platform_integrity_jailbreaking'> | null;
+        /**
+         * Selected prohibited agent topic categories to check. When agent messages contain
+         * these topics, they will be replaced with a placeholder message.
+         */
+        output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
+    }
+    /**
+     * Configuration for PII scrubbing from transcripts and recordings.
+     */
+    interface PiiConfig {
+        /**
+         * List of PII categories to scrub from transcripts and recordings.
+         */
+        categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
+        /**
+         * The processing mode for PII scrubbing. Currently only post-call is supported.
+         */
+        mode: 'post_call';
+    }
+    interface StringAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'string';
+        /**
+         * Examples of the variable value to teach model the style and syntax.
+         */
+        examples?: Array<string>;
+    }
+    interface EnumAnalysisData {
+        /**
+         * The possible values of the variable, must be non empty array.
+         */
+        choices: Array<string>;
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'enum';
+    }
+    interface BooleanAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'boolean';
+    }
+    interface NumberAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'number';
+    }
+}
+export interface ChatAgentRetrieveParams {
+    /**
+     * Optional version of the API to use for this request. If not provided, will
+     * default to latest version.
+     */
+    version?: number;
+}
+export interface ChatAgentUpdateParams {
+    /**
+     * Query param: Optional version of the API to use for this request. Default to
+     * latest version.
+     */
+    version?: number;
+    /**
+     * Body param: The name of the chat agent. Only used for your own reference.
+     */
+    agent_name?: string | null;
+    /**
+     * Body param: The prompt to use for post call analysis to evaluate whether the
+     * call is successful. Set to null to use the default prompt.
+     */
+    analysis_successful_prompt?: string | null;
+    /**
+     * Body param: The prompt to use for post call analysis to summarize the call. Set
+     * to null to use the default prompt.
+     */
+    analysis_summary_prompt?: string | null;
+    /**
+     * Body param: Message to display when the chat is automatically closed.
+     */
+    auto_close_message?: string | null;
+    /**
+     * Body param: 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".
+     */
+    data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only' | null;
+    /**
+     * Body param: 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).
+     */
+    end_chat_after_silence_ms?: number;
+    /**
+     * Body param: Configuration for guardrail checks to detect and prevent prohibited
+     * topics in agent output and user input.
+     */
+    guardrail_config?: ChatAgentUpdateParams.GuardrailConfig;
+    /**
+     * Body param: Whether the agent is public. When set to true, the agent is
+     * available for public agent preview link.
+     */
+    is_public?: boolean | null;
+    /**
+     * Body param: 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.
+     */
+    language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'th-TH' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'multi';
+    /**
+     * Body param: Whether this agent opts in to signed url for public log. If not set,
+     * default value of false will apply.
+     */
+    opt_in_signed_url?: boolean;
+    /**
+     * Body param: Configuration for PII scrubbing from transcripts and recordings.
+     */
+    pii_config?: ChatAgentUpdateParams.PiiConfig;
+    /**
+     * Body param: 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.
+     */
+    post_chat_analysis_data?: Array<ChatAgentUpdateParams.StringAnalysisData | ChatAgentUpdateParams.EnumAnalysisData | ChatAgentUpdateParams.BooleanAnalysisData | ChatAgentUpdateParams.NumberAnalysisData> | null;
+    /**
+     * Body param: The model to use for post chat analysis. Default to gpt-4.1-mini.
+     */
+    post_chat_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
+    /**
+     * Body param: The Response Engine to attach to the agent. It is used to generate
+     * responses for the agent. You need to create a Response Engine first before
+     * attaching it to an agent.
+     */
+    response_engine?: ChatAgentUpdateParams.ResponseEngineRetellLm | ChatAgentUpdateParams.ResponseEngineCustomLm | ChatAgentUpdateParams.ResponseEngineConversationFlow;
+    /**
+     * Body param: 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.
+     */
+    signed_url_expiration_ms?: number | null;
+    /**
+     * Body param: Which webhook events this agent should receive. If not set, defaults
+     * to chat_started, chat_ended, chat_analyzed.
+     */
+    webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed'> | null;
+    /**
+     * Body param: The timeout for the webhook in milliseconds. If not set, default
+     * value of 10000 will apply.
+     */
+    webhook_timeout_ms?: number;
+    /**
+     * Body param: 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.
+     */
+    webhook_url?: string | null;
+}
+export declare namespace ChatAgentUpdateParams {
+    /**
+     * Configuration for guardrail checks to detect and prevent prohibited topics in
+     * agent output and user input.
+     */
+    interface GuardrailConfig {
+        /**
+         * 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.
+         */
+        input_topics?: Array<'platform_integrity_jailbreaking'> | null;
+        /**
+         * Selected prohibited agent topic categories to check. When agent messages contain
+         * these topics, they will be replaced with a placeholder message.
+         */
+        output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
+    }
+    /**
+     * Configuration for PII scrubbing from transcripts and recordings.
+     */
+    interface PiiConfig {
+        /**
+         * List of PII categories to scrub from transcripts and recordings.
+         */
+        categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
+        /**
+         * The processing mode for PII scrubbing. Currently only post-call is supported.
+         */
+        mode: 'post_call';
+    }
+    interface StringAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'string';
+        /**
+         * Examples of the variable value to teach model the style and syntax.
+         */
+        examples?: Array<string>;
+    }
+    interface EnumAnalysisData {
+        /**
+         * The possible values of the variable, must be non empty array.
+         */
+        choices: Array<string>;
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'enum';
+    }
+    interface BooleanAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'boolean';
+    }
+    interface NumberAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+        /**
+         * Name of the variable.
+         */
+        name: string;
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'number';
+    }
+    interface ResponseEngineRetellLm {
+        /**
+         * id of the Retell LLM Response Engine.
+         */
+        llm_id: string;
+        /**
+         * type of the Response Engine.
+         */
+        type: 'retell-llm';
+        /**
+         * Version of the Retell LLM Response Engine.
+         */
+        version?: number | null;
+    }
+    interface ResponseEngineCustomLm {
+        /**
+         * LLM websocket url of the custom LLM.
+         */
+        llm_websocket_url: string;
+        /**
+         * type of the Response Engine.
+         */
+        type: 'custom-llm';
+    }
+    interface ResponseEngineConversationFlow {
+        /**
+         * ID of the Conversation Flow Response Engine.
+         */
+        conversation_flow_id: string;
+        /**
+         * type of the Response Engine.
+         */
+        type: 'conversation-flow';
+        /**
+         * Version of the Conversation Flow Response Engine.
+         */
+        version?: number | null;
+    }
+}
+export interface ChatAgentListParams {
+    /**
+     * A limit on the number of objects to be returned. Limit can range between 1 and
+     * 1000, and the default is 1000.
+     */
+    limit?: number;
+    /**
+     * The pagination key to continue fetching the next page of agents. Pagination key
+     * is represented by a agent id, pagination key and version pair is exclusive (not
+     * included in the fetched page). If not set, will start from the beginning.
+     */
+    pagination_key?: string;
+    /**
+     * Specifies the version of the agent associated with the pagination_key. When
+     * paginating, both the pagination_key and its version must be provided to ensure
+     * consistent ordering and to fetch the next page correctly.
+     */
+    pagination_key_version?: number;
+}
+export declare namespace ChatAgent {
+    export { type ChatAgentResponse as ChatAgentResponse, type ChatAgentListResponse as ChatAgentListResponse, type ChatAgentGetVersionsResponse as ChatAgentGetVersionsResponse, type ChatAgentCreateParams as ChatAgentCreateParams, type ChatAgentRetrieveParams as ChatAgentRetrieveParams, type ChatAgentUpdateParams as ChatAgentUpdateParams, type ChatAgentListParams as ChatAgentListParams, };
+}
+//# sourceMappingURL=chat-agent.d.mts.map