Sign in
chat-ai
chat_agents

Get Chat Agent

Get a single Chat Agent by ID.

get/api/v1/chat-ai/chat-agents/{chat_agent_id}

Path parameters

chat_agent_idstring uuid required

Response

Successful Response

idstring uuid required
namestring required
system_promptstring nullable
modelstring
timezonestring nullable
tenant_idstring uuid required
enabledboolean required
is_default_chat_agentboolean
canonical_kindstring nullable
is_guide_agentboolean required

True for the tenant's Knowledge Agent (the AI Guide Agent).

Derived from canonical_kind, NOT from the name. The name is operator-editable, so when it was the identity a rename turned this flag off and pickMainChatAgent stopped excluding the agent — putting the guide agent in front of someone asking about bookings. Exposing the derived flag keeps the kind string out of the client either way.

is_website_agentboolean required

True for the tenant's Website Agent.

Same shape and same purpose as is_guide_agent: this agent is scoped to the Website workspace, so the main chat must not pick it. That matters more than it looks — agents are listed created_at DESC and this one is seeded last, so without the exclusion it would win main-chat selection on any tenant with no designated default.

Changes

Changed in 2 of the 4 revisions of this API.16

  • 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

  • fbb95eac39652See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added