Sign in

Retrieve details of a specific chat agent

get/get-chat-agent/{agent_id}

Path parameters

agent_idstring required
Example:16b980523634a6dc504898cda492e939

Unique id of the chat agent to be retrieved.

Query parameters

integer
OR
string
Example:1

Optional version of the API to use for this request. If not provided, will default to latest version.

Response

Successfully retrieved the chat agent.

agent_idstring required

Unique id of chat agent.

versioninteger

The version of the chat agent.

base_versioninteger nullable

Version that this draft was based on. Null for initial versions.

assigned_tagsstring[]

Tags assigned to this chat agent version. Preferred tag is listed first.

is_publishedboolean

Whether the chat agent is published.

agent_namestring nullable

The name of the chat agent. Only used for your own reference.

auto_close_messagestring nullable

Message to display when the chat is automatically closed.

end_chat_after_silence_msinteger nullable

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).

webhook_urlstring nullable

The webhook for agent to listen to chat events. See what events it would get at webhook doc. 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_eventsstring[] nullable

Which webhook events this agent should receive. If not set, defaults to chat_started, chat_ended, chat_analyzed.

webhook_timeout_msinteger

The timeout for the webhook in milliseconds. If not set, default value of 10000 will apply.

data_storage_setting'everything' | 'everything_except_pii' | 'basic_attributes_only' nullable

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_retention_daysinteger nullable

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).

opt_in_signed_urlboolean

Whether this agent opts in to signed url for public log. If not set, default value of false will apply.

signed_url_expiration_msinteger nullable

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.

post_chat_analysis_model'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'null' nullable

Available LLM models for agents.

analysis_successful_promptstring nullable

The prompt to use for post call analysis to evaluate whether the call is successful. Set to null to use the default prompt.

analysis_summary_promptstring nullable

The prompt to use for post call analysis to summarize the call. Set to null to use the default prompt.

analysis_user_sentiment_promptstring nullable

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.

timezonestring nullable

IANA timezone for the agent (e.g. America/New_York). Defaults to America/Los_Angeles if not set.

last_modification_timestampinteger required

Last modification timestamp (milliseconds since epoch). Either the time of last update or creation if no updates available.

Example response

{
  "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
  "base_version": 12,
  "agent_name": "Jarvis",
  "auto_close_message": "Thank you for chatting. The conversation has ended.",
  "end_chat_after_silence_ms": 3600000,
  "language": "en-US",
  "webhook_url": "https://webhook-url-here",
  "webhook_timeout_ms": 10000,
  "data_storage_setting": "everything",
  "data_storage_retention_days": 30,
  "opt_in_signed_url": true,
  "signed_url_expiration_ms": 86400000,
  "post_chat_analysis_data": [
    {
      "type": "string",
      "name": "customer_name",
      "description": "The name of the customer.",
      "examples": [
        "John Doe",
        "Jane Smith"
      ]
    }
  ],
  "analysis_successful_prompt": "The agent finished the task and the call was complete without being cutoff.",
  "analysis_summary_prompt": "Summarize the call in a few sentences.",
  "analysis_user_sentiment_prompt": "Evaluate the user's sentiment based on their tone and satisfaction level.",
  "timezone": "America/New_York",
  "last_modification_timestamp": 1703413636133
}

Changes

Changed in 15 of the 28 revisions of this API.51055

  • 6342a99901081See the full diff
    • ●

      removed the optional property allOf[ChatAgentRequest]/is_public from the response with the 200 status

      response-optional-property-removed

  • 7dd16ddf69d82See the full diff
    • ○

      query request parameter version list-of-types was widened by adding types string

      request-parameter-list-of-types-widened

    • ○

      for the query request parameter version, the type/format was generalized from integer/ to /

      request-parameter-type-generalized

  • a109c375a3671See the full diff
    • ●

      removed the optional property allOf[subschema #3]/response_engine_data from the response with the 200 status

      response-optional-property-removed

  • f1a0d7c1e36c13See the full diff
    • ●

      added the new transcript_updated enum value to the allOf[ChatAgentRequest]/webhook_events/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added subschema #1 subschema #3 to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed subschema #1 subschema #3 from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      removed the gemini-2.5-flash enum value from the allOf[ChatAgentRequest]/post_chat_analysis_model response property for the response status 200

      response-property-enum-value-removed

  • 1b4a9d84942a1See the full diff
    • ●

      added the new gpt-5.5 enum value to the allOf[ChatAgentRequest]/post_chat_analysis_model response property for the response status 200

      response-property-enum-value-added

  • a44406f743c2239See the full diff
    • ▲

      added LanguageLegacy subschema #2 to the allOf[ChatAgentRequest]/language response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the allOf[ChatAgentRequest]/language response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ○

      removed the bg-BG enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ca-ES enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the cs-CZ enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the da-DK enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the de-DE enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the el-GR enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the en-AU enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the en-GB enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the en-IN enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the en-NZ enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the en-US enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the es-419 enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the es-ES enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the fi-FI enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the fr-CA enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the fr-FR enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the hi-IN enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the hu-HU enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the id-ID enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the it-IT enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ja-JP enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ko-KR enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the lt-LT enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the lv-LV enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the multi enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the nl-BE enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the nl-NL enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the no-NO enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the pl-PL enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the pt-BR enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the pt-PT enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ro-RO enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ru-RU enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the sk-SK enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the sv-SE enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the th-TH enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the tr-TR enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the vi-VN enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the zh-CN enum value from the allOf[ChatAgentRequest]/language response property for the response status 200

      response-property-enum-value-removed

  • 8ee53928bf311See the full diff
    • ●

      added the new gemini-3.1-flash-lite enum value to the allOf[ChatAgentRequest]/post_chat_analysis_model response property for the response status 200

      response-property-enum-value-added

  • 56de19127afb13See the full diff
    • ▲

      added AnalysisData ChatPresetAnalysisData to the allOf[ChatAgentRequest]/post_chat_analysis_data/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property allOf[ChatAgentRequest]/handbook_config to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ChatAgentRequest]/timezone to the response with the 200 status

      response-optional-property-added

    • ○

      removed StringAnalysisData EnumAnalysisData BooleanAnalysisData NumberAnalysisData from the allOf[ChatAgentRequest]/post_chat_analysis_data/items/ response property oneOf list for the response status 200

      response-property-one-of-removed

  • 3aa6f6e028ef2See the full diff
    • ●

      added the new gpt-5.4-mini enum value to the allOf[ChatAgentRequest]/post_chat_analysis_model response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new gpt-5.4-nano enum value to the allOf[ChatAgentRequest]/post_chat_analysis_model response property for the response status 200

      response-property-enum-value-added

  • 424df3aa79001See the full diff
    • ●

      added the new gpt-5.4 enum value to the allOf[ChatAgentRequest]/post_chat_analysis_model response property for the response status 200

      response-property-enum-value-added