---
title: "GET /api/v1/agent/swarms/{id}/live"
method: GET
path: "/api/v1/agent/swarms/{id}/live"
tags: ["agent"]
---

# GET /api/v1/agent/swarms/{id}/live

`GET /api/v1/agent/swarms/{id}/live`

## Request

- Base URL: `https://composal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://composal.com/api/v1/agent/swarms/{id}/live`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

One page response for the swarm live view

- AgentSwarmLivePage
  - `swarm` AgentSwarmLiveHeader, required
    - `id` string, required
    - `number` integer, required
    - `slug` string, required
    - `goal` string, nullable, required
    - `phase` 'planning' | 'executing' | 'landing' | 'releasing' | 'terminal', nullable, required
    - `outcome` 'succeeded' | 'partially_succeeded' | 'failed' | 'canceled' | 'budget_exhausted', nullable, required
    - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled', required
    - `launched_at` string, date-time, nullable, required
    - `started_at` string, date-time, nullable, required
    - `finished_at` string, date-time, nullable, required
    - `active_workers` integer, required
    - `tasks_done` integer, required
    - `tasks_total` integer, required
    - `stacks_landed` integer, required
    - `budget` AgentSwarmLiveBudget, required
      - `usd_spent_nanodollars` integer, nullable, required
      - `usd_cap_nanodollars` integer, nullable, required
      - `tokens_used` integer, nullable, required
      - `tokens_cap` integer, nullable, required
      - `vcpu_seconds_used` integer, nullable, required
      - `vcpu_seconds_cap` integer, nullable, required
      - `gb_seconds_used` integer, nullable, required
      - `wall_clock_cap_seconds` integer, nullable, required
    - `machine` AgentSwarmLiveMachine, required
      - `cpu_millicores` integer, required
      - `memory_mb` integer, required
    - `master_tip` string, nullable, required
    - `platform` 'composal' | 'github', required
    - `github` object, nullable, required
      - `commits` integer, required
      - `prs_opened` integer, required
      - `prs_merged` integer, required
    - `base_bookmark` string, nullable, required
    - `repository_slug` string, nullable, required
    - `organization_slug` string, required
  - `tasks` AgentSwarmLiveTask[], required
    - `id` string, required
    - `number` integer, required
    - `role` 'planner' | 'subplanner' | 'worker' | 'restack' | 'release_watch', required
    - `status` 'queued' | 'blocked' | 'running' | 'succeeded' | 'failed' | 'canceled' | 'skipped', required
    - `title` string, nullable, required
    - `depth` integer, required
    - `position` integer, required
    - `iteration` integer, required
    - `failure_code` string, nullable, required
    - `blocked_reason` string, nullable, required
    - `parent_task_id` string, nullable, required
    - `current_attempt_id` string, nullable, required
    - `short_label` string, required
    - `change_numbers` integer[], required
    - `pull_requests` AgentSwarmPullRequest[], required
      - `number` integer, required
      - `url` string, nullable, required
      - `state` 'opened' | 'open' | 'closed' | 'merged' | 'failed', required
    - `landing_state` string, nullable, required
    - `plan_summary` string, nullable, required
    - `plan_reason` string, nullable, required
    - `started_at` string, date-time, nullable, required
    - `finished_at` string, date-time, nullable, required
    - `updated_at` string, date-time, required
  - `landing` AgentSwarmLiveLanding, required
    - `entries` AgentSwarmLiveLandingEntry[], required
      - `task_id` string, required
      - `short_label` string, required
      - `state` string, required: held | released | requested | validating | ready | restack | landed | failed | revoked
      - `change_numbers` integer[], required
      - `pull_requests` AgentSwarmPullRequest[], required
        - `number` integer, required
        - `url` string, nullable, required
        - `state` 'opened' | 'open' | 'closed' | 'merged' | 'failed', required
      - `entry_id` string, nullable, required
      - `queue_position` integer, nullable, required: The entry's place in the merge queue while it is still in it.
      - `landed_commit` string, nullable, required: The first twelve characters of the commit the closure landed as.
      - `at` string, date-time, required
    - `master_tip` string, nullable, required
  - `events` AgentSwarmLiveEvent[], required
    - `id` integer, required
    - `kind` string, required
    - `reason` string, nullable, required
    - `task_id` string, nullable, required
    - `attempt_id` string, nullable, required
    - `ts` string, date-time, required
    - `at_ms` integer, required
    - `payload` object, required
    - `landing_entry` AgentSwarmLiveLandingEntry, required
      - `task_id` string, required
      - `short_label` string, required
      - `state` string, required: held | released | requested | validating | ready | restack | landed | failed | revoked
      - `change_numbers` integer[], required
      - `pull_requests` AgentSwarmPullRequest[], required
        - `number` integer, required
        - `url` string, nullable, required
        - `state` 'opened' | 'open' | 'closed' | 'merged' | 'failed', required
      - `entry_id` string, nullable, required
      - `queue_position` integer, nullable, required: The entry's place in the merge queue while it is still in it.
      - `landed_commit` string, nullable, required: The first twelve characters of the commit the closure landed as.
      - `at` string, date-time, required
  - `activity` AgentSwarmLiveActivityEvent[], required
    - `seq` integer, required
    - `kind` 'shell' | 'shell_exit' | 'read_file' | 'write_file' | 'commit' | 'export' | 'stack_post' | 'acceptance' | 'notice' | 'harness' | 'thought' | 'message', required
    - `summary` string, required
    - `exit_code` integer, nullable, required
    - `duration_ms` integer, nullable, required
    - `path` string, nullable, required
    - `task_id` string, nullable, required
    - `attempt_id` string, nullable, required
    - `ts` string, date-time, required
    - `at_ms` integer, required
    - `payload` object, required
  - `activity_retained` integer, required
  - `server_time` string, date-time, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Swarm not visible to the current user
- `422`: Unprocessable entity
- `502`: Bad gateway

---

[API](https://skmtc.dev/composal/apis/vex-api.md) - [All operations](https://skmtc.dev/composal/apis/vex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/composal/apis/vex-api/revisions/74298a24e040?raw)
