Update Agent
Update an agent with a JSON Patch document — an array of {op, path, value} operations applied to the agent, e.g. [{"op": "replace", "path": "/display_name", "value": "My agent"}]. Returns the updated agent.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Web Search Agent ID, format wsa_<uuid>.
Body
Response
Successful Response
When the agent was created.
Agent description shown to users.
Human-friendly agent name shown to users.
"Company News Tracker"
Default effort level for this agent's runs.
low, medium, high, x-high, max "high"
Ordered goals for the agent to follow.
Icon identifier used when presenting the agent.
Unique web search agent identifier (wsa_).
"wsa_2af5b0e2-58b8-4b60-a1a4-9e57e4d33f00"
Whether the agent can be used to start new runs.
JSON schema describing the structured output the agent should produce.
Skill or operating context for the agent.
Source guidance for the agent.
Suggested prompts users can run with this agent.
When the agent was last updated.
Primary use case supported by the agent.
research, enrichment, dataset_building "research"
Stable agent name.