v34

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-215423105.7 KB

Update an Agent

Update an existing agent. Only the fields provided in the body are modified; omitted fields are left unchanged.

patch/v1/agents/{agentId}

Path parameters

agentIdstring required

The agent ID.

Request body

namestring

Human-readable name for the agent. Used to identify the agent in the dashboard and API responses.

systemPromptstring

New system prompt that steers the agent's behavior on every run that uses this agent.

resultSchemaobject

An optional JSON Schema object. If provided, runs that reference this agent will aim to return a result that conforms to this schema when they complete. Can be overridden per run by passing resultSchema on the run request.

Response

The updated agent.

agentIdstring required

Unique identifier for the agent. Use this value as agentId when creating an agent run.

namestring required

Human-readable name for the agent. Used to identify the agent in the dashboard and API responses.

systemPromptstring

System prompt applied to every run that uses this agent.

resultSchemaobject

JSON Schema that runs referencing this agent will aim to conform their result to. Can be overridden per run by passing resultSchema on the run request.

createdAtstring date-time required

updatedAtstring date-time required