Sign in

v28

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-05-2887246443.7 KB

List all chat agents

get/list-chat-agents

Query parameters

limitinteger
Example:50

A limit on the number of objects to be returned. Limit can range between 1 and 1000, and the default is 1000.

pagination_keystring
Example:16b980523634a6dc504898cda492e939

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_versioninteger

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.

is_latestboolean
Example:true

If true, only return the latest version of each chat agent.

Response

Successfully retrieved all chat agents.

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
  }
]