---
title: "Update agent configuration"
method: PATCH
path: "/agents/{agent_id}"
tags: ["Agents"]
---

# Update agent configuration

`PATCH /agents/{agent_id}`

## Request

- Base URL: `https://api-docs.jackhamr.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.jackhamr.ai/agents/{agent_id}`
- Auth: none declared

Update agent metadata and context-engine fields.

Updatable: name, description, tags, metadata, soul_override,
identity_override, user_override, skill_id, timezone, agent_memory
(set to null to clear). Uses ``exclude_unset`` so omitted fields
are left untouched.

## Path parameters

- `agent_id` string, required

## Request body

- AgentUpdate: Request body for ``PATCH /api/v1/agents/{id}``.
  - `name` string, nullable
  - `description` string, nullable
  - `tags` object, nullable
  - `metadata` object, nullable
  - `soul_override` string, nullable
  - `identity_override` string, nullable
  - `user_override` string, nullable
  - `skill_id` string, nullable
  - `timezone` string, nullable
  - `agent_memory` string, nullable
  - `subtitle` string, nullable
  - `subagent_max_iterations` integer, nullable

## Response `200`

Successful Response

- AgentOut: An agent as returned by ``GET/POST /api/v1/agents``.
  - `id` string, required
  - `organization_id` string, required
  - `name` string, required
  - `description` string, nullable
  - `status` string, required
  - `owner_user_id` string, nullable
  - `allow_cloning` boolean
  - `visible_to_org` boolean
  - `cores` integer, nullable
  - `memory` integer, nullable
  - `disk_size` integer, nullable
  - `template_id` string, nullable
  - `os_template` string, nullable
  - `size_preset_id` string, nullable
  - `sort_order` integer
  - `is_board_clone` boolean
  - `clone_of_agent_id` string, nullable
  - `avatar_image_url` string, nullable
  - `avatar_color` string, nullable
  - `subtitle` string, nullable
  - `tags` object, nullable
  - `metadata` object, nullable
  - `subagent_max_iterations` integer, nullable
  - `error_message` string, nullable
  - `last_error_at` string, date-time, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `provisioned_at` string, date-time, nullable
  - `started_at` string, date-time, nullable
  - `stopped_at` string, date-time, nullable
  - `hibernated_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/jackhamr/apis/jackhamr-api.md) · [All operations](https://skmtc.dev/jackhamr/apis/jackhamr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/jackhamr/apis/jackhamr-api/revisions/f75d221481d8?raw)