---
title: "Get Batch Session Status"
method: GET
path: "/v1/batch-sessions/{batch_id}"
tags: ["Batch Sessions"]
---

# Get Batch Session Status

`GET /v1/batch-sessions/{batch_id}`

## Request

- Base URL: `https://api.anchorbrowser.io`
- URL: `https://api.anchorbrowser.io/v1/batch-sessions/{batch_id}`
- Auth: API key in header `anchor-api-key`

Retrieves detailed status information for a specific batch, including progress,
individual session details, and any errors that occurred.

## Path parameters

- `batch_id` string, uuid, required

## Response `200`

Batch status retrieved successfully

- object
  - `data` BatchSessionStatusResponseSchema
    - `batch_id` string, uuid: Unique identifier for the batch
    - `status` 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled': Current status of the batch
    - `total_requests` integer: Total number of sessions requested
    - `completed_requests` integer: Number of sessions successfully created
    - `failed_requests` integer: Number of sessions that failed to create
    - `processing_requests` integer: Number of sessions currently being processed
    - `pending_requests` integer: Number of sessions waiting to be processed
    - `created_at` string, date-time: Timestamp when the batch was created
    - `actual_completion_time` string, date-time: Timestamp when the batch completed (if completed)
    - `error` string: Error message if batch failed
    - `sessions` BatchSessionItemSchema[]: Array of individual session details
      - `item_index` integer: Index of this session within the batch (0-based)
      - `session_id` string, uuid: Unique identifier for the browser session (if created successfully)
      - `status` 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled': Current status of this individual session
      - `cdp_url` string: CDP websocket connection URL (if session is ready)
      - `live_view_url` string: Live view URL for the session (if session is ready)
      - `error` string: Error message if session creation failed
      - `retry_count` integer: Number of times this session creation has been retried
      - `started_at` string, date-time: Timestamp when session creation started
      - `completed_at` string, date-time: Timestamp when session creation completed
      - `metadata` object: Session-specific metadata
    - `progress` object
      - `percentage` number: Completion percentage (0-100)
      - `current_phase` 'queued' | 'provisioning' | 'configuring' | 'ready': Current processing phase

## Other responses

- `401`: Invalid API Key
- `404`: Batch not found
- `500`: Internal server error

## Changes

- **2026-10-16** `b3bfdb98c79e`: 1 info
  - endpoint added
- **2025-12-11** `5289c2bb1c5c`: 1 breaking
  - api path removed without deprecation
- **2025-10-19** `c1801bdad04f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/anchorbrowser/apis/anchorbrowser-api/changes/v1/batch-sessions/:batch_id/get.md)

---

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