chat-ai
chat_agents

Get Chat Agent

Changed on

Get a single Chat Agent by ID.

get/api/v1/chat-ai/chat-agents/{chat_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/chat-ai/chat-agents/{chat_agent_id}
  • Auth: none declared

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.

is_resolver_agentboolean required

True for the tenant's Resolver (Actions task chats).

Task chats bind to it directly; the main chat must never pick it, so the client excludes it the same way it excludes the guide and website agents.

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