Sign in

v1

latestOpenAPI 3.1.02026-07-2658119246.0 KB
Public API

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.

patch/v2/agents/{agent_id}

Path parameters

agent_idstring uuid required

Web Search Agent ID, format wsa_<uuid>.

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.

effort'low' | 'medium' | 'high' | 'x-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.

skillstring required

Skill or operating context for the agent.

updated_atstring date-time required

When the agent was last updated.

use_case'research' | 'enrichment' | 'dataset_building' required

Example response

{
  "display_name": "Company News Tracker",
  "id": "wsa_2af5b0e2-58b8-4b60-a1a4-9e57e4d33f00",
  "sources": {
    "allow": [
      {
        "domains": [
          "linkedin.com",
          "crunchbase.com"
        ],
        "title": "Professional networks"
      }
    ],
    "block": [
      {
        "domains": [
          "linkedin.com",
          "crunchbase.com"
        ],
        "title": "Professional networks"
      }
    ]
  }
}