About this endpoint
What it does
Submits a video file for asynchronous audio extraction and returns a job identifier immediately. The job can be checked later using that job_id.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| persistent | Boolean | No | Whether the job result should be kept persistently. |
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| video | String | Yes | The input video file to extract audio from. Binary upload. |
| duration | String | No | Clip length in seconds. Default 2 unless full_audio is true. |
| full_audio | String | No | Set to true or 1 to extract from start_time to the end of the file. |
| start_time | String | No | Seek offset in seconds. Default 0. |
| output_format | ENUM | No | Output audio format. Allowed values: mp3, wav, aac, ogg, flac, wma, ac3. Default mp3. |
Response
Returns a JSON object with a job_id string field, formatted as a UUID. This job_id is the identifier to use for status polling.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| job_id | String | Yes | Job identifier for status polling. Format: UUID. |
Notes
This endpoint kicks off an async job and returns immediately with a job identifier; the actual work runs in the background. Pair this call with the corresponding job_check endpoint — poll that until the status reaches a terminal state to retrieve the result. Use the returned job_id for polling.