Skip to main content
POST
Start Batch

Overview

Starts a paused batch, enqueuing all episode jobs for processing. The batch must be in paused status.

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 successfully enqueued for processing
string
New batch status (processing)

Example

Error Responses

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