Web Search Agents (public)

Update Agent

patch/v1/task-agents/{agent_id}

Request

agent_idstring uuid required

fromstring nullable

pathstring required

valueunknown

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.

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

Aug 17, 202622c2a2291146 Revision changes
- warning
  added the new 5x-high enum value to the response property for the response status
Jul 20, 2026d4e4f170f4f4 Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  api operation id update_agent_api_v2_public_web_search_agents__agent_id__patch removed and replaced with update_agent_public_v1_api_v1_public_web_search_agents__agent_id__patch
- info
  endpoint deprecated
- info
  the response's property default value was removed for the status
- info
  the response's property default value was removed for the status
- info
  added the required property /// to the response with the status