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

Changed in 4 of the 28 revisions of this API.17

  • 6b978a5172251See the full diff
    • ○

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

      response-optional-property-added

  • 704de2d43c751See the full diff
    • ○

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

      response-optional-property-added

  • 34f2d9e81b0b1See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • d65b8fefae3414See the full diff
    • ▲

      added to the // response property oneOf list for the response status

      response-property-one-of-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      mapped value for discriminator key integration_tool_action changed from to for // response property for the response status

      response-property-discriminator-mapping-changed

    • ○

      removed from the // response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 28 revisions, 1 has no diff computed.