Skip to main content
POST
Create Job

Overview

Creates a new download job. For single videos, returns a job_id. For Spotify shows and YouTube playlists, automatically creates a batch and returns a batch_id with all episode/video job IDs.
If url contains a YouTube playlist ID, this endpoint downloads the ENTIRE playlist, not just one video. This applies even if you only meant to download a single video — see Playlist Auto-Detection below before you’re surprised by a batch of thousands of jobs from what looked like a single-video request.

Header Parameters

string
required
Your API key for authentication

Request

string
required
The video or show URL to download. If this URL contains a genuine YouTube playlist ID (list=PL..., UU..., or OL...) or is a Spotify show, the request downloads the WHOLE playlist/show as a batch — see Playlist Auto-Detection.
string
Output container format. Video: mp4, mkv, webm, mov. Audio: m4a, mp3, ogg, opus. Default: mp4 (or m4a when audio_only is true)
string
Video codec: copy (no re-encode), h264, h265, vp9. Default: copy
string
Audio codec: copy (no re-encode), aac, opus, mp3. Default: copy with automatic fallback to aac if incompatible
string
Audio bitrate when transcoding: 64k, 128k, 192k, 256k, 320k. Default: 192k
integer
Video quality CRF (0-51, lower = better quality). Only used when video_codec is not copy. Default: 23
string
Custom filename (without extension). Max 255 characters. Cannot contain .., /, \, or null bytes.
string
S3 folder prefix for organizing files. Max 200 characters. Cannot contain .., start with / or \, or be empty/whitespace-only.
string
URL to receive completion notification via POST request.
boolean
default:"false"
Extract audio track only. Outputs m4a (native AAC, no re-encoding) by default. Set format to mp3, ogg, or opus for other audio formats. Supports audio_codec and audio_bitrate for transcoding control.
boolean
default:"false"
Download subtitles if available. Returns subtitle URL in job response.
boolean
default:"false"
Download video thumbnail. Returns thumbnail URL in job response.
Known gap (2026-07-08): currently only implemented for Spotify shows. For YouTube — the vast majority of requests — setting this to true is accepted without error but does not currently produce a thumbnail; no thumbnail_url/thumbnail_key will appear in the job response or completion webhook. Tracked as a fix; not yet shipped. If you need YouTube thumbnails today, fetch them yourself from https://i.ytimg.com/vi/<video_id>/maxresdefault.jpg.
string
Quality preset that overrides video_quality. Options: highest, high, medium, low, lowest.
string
Video resolution preference. Options: best (default), lowest, 2160 (4K), 1440, 1080, 720, 480, 360, 240, 144. Resolution uses the shorter dimension for both horizontal and vertical videos.lowest selects the smallest available video format. A numeric value selects the highest available resolution at or below that value. If every available format exceeds it, the smallest available format is used; the video is not resized. For example, 240 selects 144p when the source offers 144p and 360p, or 360p when the source starts at 360p.For 144 and lowest, separate audio defaults to the lowest available AAC track. Explicit audio codec preferences are respected. A higher bitrate may remain when no lower AAC track is available or when audio is embedded in the selected HLS stream. Check actual_quality in the completed job status for the delivered resolution.
string
Start timestamp for video clipping. Format: HH:MM:SS, MM:SS, or seconds (e.g., 00:01:30 or 90).
string
End timestamp for video clipping. Format: HH:MM:SS, MM:SS, or seconds (e.g., 00:05:00 or 300). Must be greater than clip_start.
boolean
default:"false"
Enable live stream recording mode. Auto-detected for live URLs.
boolean
default:"false"
For live streams: record from the beginning (VOD mode) instead of the live point.
integer
Maximum recording duration in seconds. Recommended for live streams as a safety cap. Example: 7200 for 2 hours.
boolean
default:"false"
Wait for scheduled/upcoming streams to start before downloading.
boolean
default:"false"
Enable progress webhooks during processing. Sends updates at each stage: downloading, muxing, uploading.
object
Inline storage credentials. Required for marketplace users (RapidAPI, Apify, Zyla). Optional for direct API users (overrides pre-configured storage). Supports 4 providers via the provider field. See Inline Storage examples below. Mutually exclusive with storage_provider.
string
Deliver this job to one of your saved storage destinations, selected by provider: "s3", "blob" (Azure), "gcs", "oss". Resolved against the destinations configured on your API key first, then on your organization. Returns 400 storage_provider_not_configured if no destination of that provider exists. Mutually exclusive with storage (both present → 400). Omit it to use your default destination. See Choosing a saved destination.
boolean
default:"false"
For Spotify show batches only. Creates the batch in paused mode: jobs are not enqueued for processing immediately. Use PATCH /batch/{id}/jobs to rename episodes, then POST /batch/{id}/start to launch.

Single Job Response

string
UUID of the created job
Response

Batch Response (Spotify Shows)

When the URL is a Spotify show, a batch is created automatically:
string
UUID of the batch job
integer
Number of episodes in the show
boolean
Whether the batch was created in paused mode
array
List of episode details with job IDs, URLs, titles, descriptions, and release dates
array
List of job IDs for each episode (legacy field)
Response (default mode)
Response (paused mode)

Examples

Choosing a saved destination

If you configured several storage destinations (one per provider) in the dashboard, pick the one a job should use with storage_provider:
  • Accepted values: "s3", "blob" (Azure Blob), "gcs", "oss" — the provider of a destination you saved.
  • Resolution order: destinations on the API key, then on the organization. Omit the field to use your default destination (the one marked default, else the most recently saved).
  • 400 storage_provider_not_configured — no saved destination of that provider on the key or the organization.
  • 400 storage_and_storage_provider_are_exclusive — you sent both storage (inline credentials) and storage_provider.
  • If the destination cannot be resolved when the worker uploads (credentials revoked in between), the job is marked Failed — it is never silently delivered elsewhere.

Inline Storage

The storage field lets you provide cloud storage credentials directly in the request. This is required for marketplace users and optional for direct API users.
Inline storage credentials take priority over pre-configured storage and are validated before the job is accepted, in three steps — each failure returns 400 with the reason:
  1. Shape — bucket/container name, keys, endpoint (Invalid storage configuration: …), no network call.
  2. Backend construction — provider-specific requirements (e.g. GCS project_id).
  3. Live probe — a small test object is uploaded then deleted with your credentials (Storage credentials validation failed: …). The result is cached for 5 minutes per credential set, so repeated jobs with the same storage don’t pay the probe again.
A 201 Created therefore means the destination is reachable and writable. If, despite that, the backend cannot be initialised at upload time, the job is marked Failed with storage_unreachable — it is never silently delivered to another bucket.Credentials are never logged. For direct API keys they live only in the encrypted job payload until the job completes. For marketplace users (RapidAPI, Apify, Zyla) they are saved so later requests can omit storage — see the marketplace section.

Provider Fields

Success Response

Playlist Auto-Detection

POST /jobs inspects url and automatically creates a batch (one job per video) instead of a single job whenever it detects a genuine YouTube playlist. There is no separate “batch” endpoint or flag to opt into this — it happens automatically based on the URL you send.

Which URLs trigger it

This is the #1 source of “I asked for one video and got thousands of jobs” confusion. YouTube’s own UI automatically appends &list=RD<video_id>&start_radio=1 to the URL bar any time you open a video from an autoplay queue, the homepage, related videos, or a “Radio”/Mix button — not because you’re viewing a playlist. If you’re integrating by copy-pasting URLs from a browser, always double-check for a list= parameter before sending it here. As of 2026-07-08, list=RD.../WL/LL URLs are correctly treated as single-video requests (this was previously a real bug that caused two production incidents) — but if you’re on an older integration or unsure, strip any list=/start_radio= query parameters from the URL yourself before calling this endpoint to be safe.

Size limit

Even a genuine playlist (PL/UU/OL) is capped at 500 videos per request (configurable server-side via MAX_PLAYLIST_BATCH_SIZE). A playlist larger than that is rejected outright with a 413 Payload Too Large — it is never silently truncated. If you need to download a larger playlist, split it into smaller batches or contact support.

Response

string
UUID of the batch job
integer
Number of videos in the playlist
array
List of job IDs for each video
Genuine Playlist (downloads all videos)
Response
Radio/Mix URL (downloads only the one video)
Response
413 Payload Too Large (playlist exceeds the cap)

Error Responses

Notes

The 429 Too Many Requests and 503 Service Unavailable responses include a Retry-After header indicating how many seconds to wait before retrying.
Codec auto-correction: Incompatible codec/format combinations are automatically corrected to ensure valid output:
  • webm + h264 → video codec changed to vp9
  • webm + aac → audio codec changed to opus
  • ogg/opus + aac → audio codec changed to opus
  • mp3 + aac → audio codec changed to mp3
  • Setting audio_bitrate without audio_codec → audio codec defaults to aac
Invalid format values are silently replaced with mp4.