Skip to main content
POST
Create an FFmpeg job

Authorizations

Authorization
string
header
required

Send your FFmpeg API Cloud API key as a bearer token.

Body

application/json

Create an asynchronous FFmpeg or FFprobe job. Use either input or inputs, and provide raw arguments in ffmpegArgs.

binary
enum<string>
default:ffmpeg
required

The execution binary used for the job.

Available options:
ffmpeg,
ffprobe
input
(AssetInput · object | UrlInput · object)[]
Minimum array length: 1

Reference an uploaded asset by ID.

inputs
object
outputs
object
ffmpegArgs
string[]
webhookUrl
string<uri>

Response

Job accepted for processing.

The accepted response returned after a job is queued.

id
string<uuid>
required

A UUID value.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"3f0e9cfd-4e56-4c0b-8df0-2bfa88c40f50"

binary
enum<string>
required

The execution binary used for the job.

Available options:
ffmpeg,
ffprobe
status
enum<string>
required

The current lifecycle state of the job.

Available options:
queued,
running,
completed,
failed,
canceled,
rejected
mode
enum<string>
required

The job execution mode.

Available options:
preset,
raw