Sign in
chat-ai
chat_agents

Set Default Chat Agent

Designate this Chat Agent as the tenant's default (main-chat) agent.

Superadmin-only: binding Ask AI to an agent is Cleon-owned config, same as chat-agent-group mutations and chat-agent delete. Tenant admins cannot change which agent Ask AI uses.

Clears the flag on any other agent so at most one default exists per tenant. The guide agent cannot be the main-chat agent.

put/api/v1/chat-ai/chat-agents/{chat_agent_id}/default

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
is_guide_agentboolean required

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

The guide agent is just another ChatAgent row, identified only by its canonical name. Exposing this derived flag lets the main-chat UI exclude it from agent selection without leaking that name string into the client.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.