Create a download job
get_ajax_download_phpSubmits a new download job for the given url in the requested format.
Returns a unique id you can pass to the Progress endpoint to poll for
completion and retrieve the final download URL. Billing per call: 1 Credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The URL-encoded URL of the video to download (YouTube and other supported sources). | |
| apikey | No | Your personal API key. | |
| format | No | The output format to download. Accepted values: `mp3`, `m4a`, `webm_audio`, `aac`, `flac`, `opus`, `ogg`, `wav`, `144`, `240`, `360`, `480`, `720`, `1080`, `1440`, `4k`, `8k`. Audio formats have a 120-minute base duration limit; video formats have format-specific limits (1080p=90m, 1440p=60m, 4k/8k=15m, everything else=120m). | |
| add_info | No | Set to `1` to include the `info` object (title + thumbnail) in the response. Defaults to `0` when omitted. | |
| end_time | No | Optional. End time (in seconds) of a cut/segment download. | |
| no_merge | No | If set to `1`, audio and video streams are **not** merged. The client receives a zip file containing the separate streams. Defaults to `0` (streams are merged into a single file). | |
| start_time | No | Optional. Start time (in seconds) of a cut/segment download. When `start_time`/`end_time` are supplied, progress is not reported — the Progress endpoint only returns initialization and the final success / failure status. | |
| audio_quality | No | Audio bitrate in kbps. Common values include `128`, `192`, `256`, `320`. | |
| audio_language | No | YouTube only. Selects the audio track language by BCP-47 / YouTube language code. If the requested track is not available on the video, the default track is used instead. No additional cost. Supported codes: `af, az, id, ms, bs, ca, cs, da, de, et, en-IN, en-GB, en, es, es-419, es-US, eu, fil, fr, fr-CA, gl, hr, zu, is, it, sw, lv, lt, hu, nl, no, uz, pl, pt-PT, pt, ro, sq, sk, sl, sr-Latn, fi, sv, vi, tr, be, bg, ky, kk, mk, mn, ru, sr, uk, el, hy, iw, ur, ar, fa, ne, mr, hi, as, bn, pa, gu,… | |
| allow_extended_duration | No | Set to `1` to permit downloads whose video duration exceeds the format's base duration limit. Extended-duration jobs are charged a multiplier of the base price (see the `ExtendedDuration` response object). Defaults to `0` when omitted. |