---
title: "Progress of a bulk job"
method: GET
path: "/api/v1/bulk/{run_id}"
---

# Progress of a bulk job

`GET /api/v1/bulk/{run_id}`

## Request

- Base URL: `https://bulktranscripts.co`
- URL: `https://bulktranscripts.co/api/v1/bulk/{run_id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Free. Poll no sooner than check_again_in_seconds; 0 means finished.

## Path parameters

- `run_id` string, required

## Response `200`

OK

- BulkJob
  - `run_id` string
  - `status` 'running' | 'completed' | 'stopped' | 'failed'
  - `phase` 'discovering' | 'extracting' | 'finished'
  - `source` object
    - `url` string
    - `type` string, nullable
    - `title` string, nullable
  - `videos_found` integer, nullable: null until the listing has finished.
  - `total` integer
  - `completed` integer
  - `cached` integer
  - `failed` integer
  - `skipped` integer: Videos without captions.
  - `quota` integer: Not attempted for lack of credits.
  - `interrupted` integer
  - `remaining` integer
  - `error` object, nullable
    - `code` string
    - `message` string
  - `check_again_in_seconds` integer: Minimum wait before the next poll; 0 when finished.
  - `billing` Billing: Present on every credited response. When billing is disabled on a self-hosted install only enabled/unlimited are set.
    - `enabled` boolean
    - `unlimited` boolean
    - `kind` 'anon' | 'license' | 'admin'
    - `remaining` integer
    - `used` integer
    - `granted` integer
    - `freeLimit` integer
    - `creditsCharged` integer

## Other responses

- `401`: Unauthorized (missing_api_key, invalid_api_key, or invalid_token)
- `404`: Not found (no_transcript (video has no captions; not charged) or not_found)
- `429`: Rate limited (rate_limited; honour the Retry-After header (seconds))

---

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