---
title: "Update Agent"
method: PATCH
path: "/v1/task-agents/{agent_id}"
tags: ["Web Search Agents (public)"]
---

# Update Agent

`PATCH /v1/task-agents/{agent_id}`

## Path parameters

- `agent_id` string, uuid, required

## Request body

- JsonPatchOp[] — A JSON Patch document per RFC 6902 — a JSON array of patch operations.
  - `from` string, nullable
  - `op` 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test', required
  - `path` string, required
  - `value` unknown

## Response `200`

Successful Response

- WebSearchExtractTemplateResponse
  - `account_id` string, nullable
  - `agent_name` string, nullable
  - `created_at` string, date-time, required
  - `description` string, required
  - `display_name` string, required
  - `domain_expertise` string, required
  - `effort` 'low' | 'medium' | 'high' | 'x-high' | 'max', required — Canonical effort tier names for the research graph.
  - `goals` WebSearchAgentGoalResponse[], required
    - `goal` string, required
    - `id` string, required
    - `order` integer, required
  - `icon` string, required
  - `id` string, required
  - `is_active` boolean, required
  - `output_schema` object, nullable, required
  - `sources` AgentSourcesResponse, required — Response variant of AgentSources — preserves per-row id on allow rows.
    - `allow` WebSearchAgentSourceResponse[]
      - `domains` string[], required
      - `id` string, required
      - `order` integer, required
      - `title` string, required
    - `avoid` string, nullable
    - `block` SourceGroupResponse[]
      - `domains` string[], required
      - `order` integer, required
      - `title` string, required
    - `prioritize` string, nullable
  - `suggested_questions` WebSearchAgentSuggestedQuestionResponse[], required
    - `id` string, required
    - `order` integer, required
    - `question` string, required
  - `updated_at` string, date-time, required
  - `use_case` 'research' | 'enrichment' | 'dataset_building', required
  - `workspace_id` string, uuid, nullable

## Other responses

- `422` — Validation Error

## Changes

- **2026-07-12** `e8a97dc9fce2` — 1 breaking, 7 warning, 16 info
  - for the `path` request parameter `agent_id`, the type/format was changed from `string`/`` to `string`/`uuid`
  - deleted the `cookie` request parameter `token`
  - removed the optional property `workspace_name` from the response with the `200` status
  - added the new `high` enum value to the `effort` response property for the response status `200`
  - …20 more
- **2026-06-18** `2562e655b8f2` — 1 breaking, 4 info
  - the `sources` response's property type/format changed from `array`/`` to `object`/`` for status `200`
  - added the optional property `sources/allow` to the response with the `200` status
  - added the optional property `sources/avoid` to the response with the `200` status
  - added the optional property `sources/block` to the response with the `200` status
  - …1 more
- **2026-06-10** `421a9851d61b` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/nimbleway/apis/api-gateway/changes/v1/task-agents/:agent_id/patch.md)

---

[API](https://skmtc.dev/nimbleway/apis/api-gateway.md) · [All operations](https://skmtc.dev/nimbleway/apis/api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nimbleway/api-gateway/revisions/e8a97dc9fce2/schema)