Updates an agent's settings: its name, description, authentication, observability, guardrail violation message, or dataset. All body fields are optional.

When to use it

Use it to rename an agent or change its settings. To change the agent's configuration, such as its model or guardrails, create a new version instead.

Required parameters

• agent_id (path): the ID of the agent.

Optional body fields: name, description, authentication_enabled, observability_enabled, guardrails_violation_message, dataset_id.

Response

A successful call returns 200 OK with the updated Agent object, including its status and url.

Related: Get an agent, Create an agent version, Regenerate an agent API token