---
title: "Update an agent session status"
method: PATCH
path: "/api/workspaces/{workspaceId}/agent-sessions/{sessionId}"
tags: ["Agent Sessions"]
---

# Update an agent session status

`PATCH /api/workspaces/{workspaceId}/agent-sessions/{sessionId}`

## Request

- Base URL: `https://hiveship.app/api`
- URL: `https://hiveship.app/api/api/workspaces/{workspaceId}/agent-sessions/{sessionId}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `hiveship_access`

## Path parameters

- `workspaceId` string, required
- `sessionId` string, required

## Request body

- object
  - `status` 'QUEUED' | 'WORKING' | 'WAITING_INPUT' | 'ERRORED' | 'COMPLETED', required
  - `errorMessage` string
  - `externalUrls` string[]
  - `tokenUsage` integer
  - `modelUsed` string
  - `modelUsage` object[]
    - `model` string, required
    - `inputTokens` integer
    - `outputTokens` integer
    - `cacheReadTokens` integer
    - `cacheWriteTokens` integer

## Response `200`

Session updated

- object
  - `success` boolean, required
  - `data` object, required
    - `id` string, cuid, required
    - `status` 'QUEUED' | 'WORKING' | 'WAITING_INPUT' | 'ERRORED' | 'COMPLETED', required
    - `issueId` string, cuid, required
    - `agentId` string, cuid, required
    - `startedAt` string, date-time, nullable, required
    - `completedAt` string, date-time, nullable, required
    - `errorMessage` string, nullable, required
    - `externalUrls` string[], required
    - `tokenUsage` integer, nullable, required
    - `modelUsed` string, nullable, required
    - `modelUsage` object[], required
      - `model` string, required
      - `inputTokens` integer, required
      - `outputTokens` integer, required
      - `cacheReadTokens` integer, required
      - `cacheWriteTokens` integer, required
      - `totalTokens` integer, required
    - `createdAt` string, date-time, required

## Other responses

- `400`: Validation error
- `403`: Insufficient permissions
- `404`: Session not found
- `409`: Session was transitioned concurrently (e.g. by the stale-session sweep) — re-fetch and retry

---

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