Web Search Agents (public)
Update Agent
patch/v1/task-agents/{agent_id}
Path parameters
agent_idstring uuid required
Request body
fromstring nullable
op'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' required
pathstring required
{"stackTrail":"components:schemas:JsonValue","oasType":"schema","type":"unknown"}
Response
Successful Response
agent_namestring nullable
Stable agent name.
created_atstring date-time required
When the agent was created.
descriptionstring required
Agent description shown to users.
display_namestring required
Human-friendly agent name shown to users.
domain_expertisestring required
Domain expertise or operating context for the agent.
effort'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max' required
Canonical effort tier names for the research graph.
iconstring required
Icon identifier used when presenting the agent.
idstring required
Unique web search agent identifier (wsa_<uuid>).
is_activeboolean required
Whether the agent can be used to start new runs.
output_schemaobject nullable required
JSON schema describing the structured output the agent should produce.
updated_atstring date-time required
When the agent was last updated.
use_case'research' | 'enrichment' | 'dataset_building' required