Sign in
text-ai
text_agents

Get Text Agent

Get a single Text Agent by ID.

get/api/v1/text-ai/text-agents/{text_agent_id}

Path parameters

text_agent_idstring uuid required

Response

Successful Response

idstring uuid required
namestring required
system_promptstring nullable
modelstring
timezonestring nullable
greeting_messagestring nullable
brandingobject nullable
collect_fieldsstring[]
session_timeout_minutesinteger nullable

Inactivity timeout in minutes. null = no timeout.

idle_close_messagestring nullable

Posted into the chat when the inactivity timeout closes it. null = close silently.

tenant_idstring uuid required
enabledboolean required
publishable_keystring required
text_widget_group_idstring uuid nullable
environmentstring
active_version_idstring uuid nullable
handoff_enabledboolean required
handoff_providerstring nullable required
handoff_configobject nullable required
created_atstring date-time required
updated_atstring date-time required

Changes