Sign in
chat-ai
chat_agents

Update Chat Agent

Update an existing Chat Agent (partial update supported).

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

Path parameters

chat_agent_idstring uuid required

Request body

namestring nullable
system_promptstring nullable
modelstring nullable
enabledboolean nullable
timezonestring nullable

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.