Skip to main content
POST
Start Batch

Overview

Starts eligible children of a paused batch. A batch already marked processing can be started again to recover children left paused by a partial attempt; children already started or terminal are not republished. Current account/quota checks still apply, and admission limits can park jobs until capacity is available.

Header Parameters

string
required
Your API key for authentication

Path Parameters

string
required
The batch UUID returned from POST /jobs

Response

string
The batch UUID
integer
Number of jobs newly resumed or parked by this call; can be zero on a repeated start
string
New batch status (processing)

Example

Error Responses

A 503 can report started_jobs and failed_jobs when only part of the batch was started. Retry the same batch-start request. Missing stored job payloads can also return 503 with a reconciliation error. Marketplace batch access returns 403.

Workflow

The typical paused batch workflow is:
  1. POST /jobs with paused: true - Create batch, get episode titles
  2. PATCH /batch/{id}/jobs - Rename episodes as needed
  3. POST /batch/{id}/start - Start downloading
  4. GET /batch/{id} - Poll for progress