text-ai
text_agents

Update Text Agent Scenarios

Changed on

Replace all scenarios for a Text Agent and sync tool configs.

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

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}/scenarios
  • Auth: none declared

Path parameters

text_agent_idstring uuid required

Request body

idstring uuid required
namestring required
conditionstring nullable
priorityinteger
enabledboolean
business_hours_onlyboolean
fallback_numbersstring[]
randomize_hunt_orderboolean
hunt_group_namestring nullable
retired_numbersstring[]
pre_execution_instructionstring nullable

Instruction for the LLM before executing this tool

post_execution_instructionstring nullable

Instruction for the LLM after receiving the tool result

transfer_ring_timeout_secondsinteger nullable
warm_transfer_hold_message_mode'default' | 'silent' | 'custom' nullable
warm_transfer_hold_messagestring nullable
warm_transfer_briefing_mode'default' | 'custom' nullable
warm_transfer_briefing_instructionsstring nullable
warm_transfer_farewell_mode'default' | 'silent' | 'custom' nullable
warm_transfer_farewell_messagestring nullable
warm_connect_mode'ask' | 'after_brief' | 'silent' nullable

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

    • info

      added the new optional request property /

    • info

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

    • info

      added the new optional request property ///

    • info

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