---
title: "Update an agent session"
method: PATCH
path: "/api/v0beta1/rigs/{id}/sessions/{sessionId}"
tags: ["Sandboxes"]
---

# Update an agent session

`PATCH /api/v0beta1/rigs/{id}/sessions/{sessionId}`

## Request

- Base URL: `https://app.amika.dev` (the document declares no server; this is the origin it was published from)
- URL: `https://app.amika.dev/api/v0beta1/rigs/{id}/sessions/{sessionId}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `wos-session`

## Path parameters

- `id` string, required
- `sessionId` string, required

## Query parameters

- `sandbox_by` 'name' | 'id' | 'ref' | 'name_or_id': How to interpret the sandbox `{id}` path param: ref/name_or_id (default; matches an id or a name and rejects an ambiguous match with 409 `resource_ref_ambiguous`), name, or id.

## Request body

- UpdateSessionRequest
  - `status` 'active' | 'completed' | 'failed'
  - `metadata` object

## Response `200`

Updated session.

- AgentSessionDetail
  - `session_id` string, required
  - `sandbox_id` string, required
  - `sandbox_name` string, nullable, required
  - `agent` string, required
  - `status` string, required
  - `preview` string, nullable, required
  - `model` string, nullable, required
  - `effort` string, nullable, required
  - `started_at` union, required
    - string
    - string, date-time
  - `ended_at` union, required
    - string
    - string, date-time
    - unknown
  - `created_at` union, required
    - string
    - string, date-time
  - `updated_at` union, required
    - string
    - string, date-time
  - `messages` AgentSessionMessage[], required
    - `role` string, required
    - `content` string, required
    - `timestamp` string, required
    - `is_error` boolean

## Other responses

- `400`: Error
- `401`: Error
- `403`: Error
- `404`: Error
- `409`: Error

## Changes

- **2026-10-23** `c46868fd7b41`: 2 info
  - added the new optional `query` request parameter `sandbox_by`
  - added the non-success response with the status `409`
- **2026-09-16** `25ba06b40ead`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/amika/apis/amika-api/changes/api/v0beta1/rigs/:id/sessions/:sessionId/patch.md)

---

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