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

# Update an agent

`PATCH /agents/{agent_id}`

## Request

- Base URL: `/api/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/agents/{agent_id}`
- Auth: API key in header `X-Axilio-Api-Key`
- TypeScript: <https://skmtc.dev/axilioai/apis/axilio-api/docs/agents/:agent_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Changes an agent's name, model, output schema, limits or data toggles; omitted fields are left unchanged. Its revisions change through POST /agents/{agent_id}/revisions.

## Path parameters

- `agent_id` string, uuid, required: The agent's id.

## Request body

- AgentUpdateRequest: Request body for updating an agent. Omitted fields are left unchanged.
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `accessibility_enabled` boolean: Use accessibility mode for runs. true needs your organization's access to accessibility mode (a 403 whose message starts with accessibility_unavailable without it).
  - `capture_enabled` boolean: Capture the media runs produce into the file library.
  - `max_cost_microdollars` integer: Most a run's model steps may cost, in microdollars.
  - `max_steps` integer: Most model steps a run may take.
  - `model` string: The model instruction runs call, one of GET /models.
  - `name` string: The agent's new name.
  - `output_schema` object, nullable: The JSON Schema a run's result must satisfy. null clears it, so runs take any result.
  - `pause_timeout_seconds` integer: Longest a run waits paused for an answer, in seconds, 60 to 3600.
  - `recording_enabled` boolean: Record the screen of runs.
  - `telemetry_enabled` boolean: Emit telemetry for runs.
  - `timeout_seconds` integer: Longest a run may take, in seconds, at most 3600.

## Response `200`

OK

- Agent: An agent: a task for a phone, as instructions the agent works through a model or as code, with the settings its runs use.
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `accessibility_enabled` boolean, required: Runs use accessibility mode, which needs a phone that supports it.
  - `capture_enabled` boolean, required: Runs capture the media they produce on the phone into the file library.
  - `created_at` string, date-time, required: When the agent was created.
  - `current_revision_id` string, uuid: The revision runs of the agent use. Absent until the agent has one.
  - `id` string, uuid, required: The agent's id.
  - `last_run_at` string, date-time: When a run of the agent last started.
  - `max_cost_microdollars` integer, required: Most a run's model steps may cost, in microdollars.
  - `max_steps` integer, required: Most model steps a run may take.
  - `model` string, required: The model an instructions revision's runs call, one of GET /models.
  - `name` string, required: The agent's name, unique within the organization.
  - `output_schema` object: The JSON Schema a run's result must satisfy. Absent takes any result.
  - `pause_timeout_seconds` integer, required: Longest a run waits paused for an answer, in seconds, before it fails with input_timeout. A pause also ends with the session.
  - `recording_enabled` boolean, required: Runs record the screen.
  - `telemetry_enabled` boolean, required: Runs emit telemetry, live and stored.
  - `timeout_seconds` integer, required: Longest a run may take, in seconds, within the one-hour session cap.
  - `updated_at` string, date-time, required: When the agent was last changed.

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `422`: Unprocessable Entity
- `500`: Internal Server Error

## Changes

- **2026-11-01** `80de09d0e643`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/axilioai/apis/axilio-api/changes/agents/:agent_id/patch.md)

---

[API](https://skmtc.dev/axilioai/apis/axilio-api.md) - [All operations](https://skmtc.dev/axilioai/apis/axilio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/axilioai/apis/axilio-api/revisions/80de09d0e643?raw)