text-ai
text_agents

Update Text Agent

Changed on

Update an existing Text Agent (partial update supported).

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

Request

  • Base URL: https://api.getanana.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.getanana.com/api/v1/text-ai/text-agents/{text_agent_id}
  • Auth: none declared

Path parameters

text_agent_idstring uuid required

Request body

namestring nullable
system_promptstring nullable
modelstring nullable
enabledboolean nullable
timezonestring nullable
greeting_messagestring nullable
brandingobject nullable
collect_fieldsstring[] nullable
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.

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

  • a9cebb28e243Revision changes
    • info

      added the optional property // to the response with the status

  • 6b978a517225Revision changes
    • info

      added the optional property //// to the response with the status