---
title: "Batch counters and child job ids"
method: GET
path: "/v1/batches/{id}"
tags: ["batches"]
---

# Batch counters and child job ids

`GET /v1/batches/{id}`

## Request

- Base URL: `https://api.transcriptdock.com`
- URL: `https://api.transcriptdock.com/v1/batches/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `sb-access-token`

## Path parameters

- `id` string, uuid, required

## Response `200`

Aggregate status derived from child counts

- Batch
  - `id` string, uuid, required: Batch id; use with GET /v1/batches/{id}.
  - `status` 'queued' | 'processing' | 'succeeded' | 'partial_success' | 'failed' | 'cancelled', required: Aggregate of the child jobs: partial_success when some succeeded and some failed.
  - `total_items` integer, required: Number of submitted items; duplicate URLs share one child job.
  - `succeeded_items` integer, required: Items whose child job succeeded.
  - `failed_items` integer, required: Items whose child job failed.
  - `cancelled_items` integer, required: Items whose child job was cancelled.
  - `child_job_ids` string[], required: Distinct child job ids, in item order.
  - `items` BatchItem[], required: One entry per submitted item with its job id and status.
    - `job_id` string, uuid, required
    - `item_index` integer, required
    - `status` 'queued' | 'processing' | 'awaiting_provider' | 'succeeded' | 'failed' | 'cancelled', required
  - `created_at` string, date-time, required: Submission time, UTC.

## Other responses

- `404`: Unknown id, or an id from another workspace

---

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