Quickstart

This quickstart uses a public media URL so you can run your first job without an upload step.

1. Create a job

curl -X POST https://ffmpeg-api.cloud/v1/jobs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "binary": "ffprobe",
    "input": [
      {
        "type": "url",
        "url": "https://example.com/input.mp4"
      }
    ],
    "ffmpegArgs": [
      "-v",
      "error",
      "-show_format",
      "-show_streams",
      "-of",
      "json",
      "input0"
    ]
  }'

The API returns a queued job immediately:

{
  "id": "JOB_ID",
  "binary": "ffprobe",
  "status": "queued",
  "mode": "raw"
}

2. Poll the job

curl https://ffmpeg-api.cloud/v1/jobs/JOB_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Wait until status becomes completed or another terminal state.

3. Fetch the result

curl https://ffmpeg-api.cloud/v1/jobs/JOB_ID/result \
  -H "Authorization: Bearer YOUR_API_KEY"

For FFprobe jobs, the result payload includes JSON output metadata.

Examples

See more request patterns.

Webhooks

Stop polling and receive callbacks instead.

Files and outputs

Learn the upload and output model.

API Reference

Browse endpoint fields and response schemas.

Get started

1. Create a job

2. Poll the job

3. Fetch the result

Next

Examples

Webhooks

Files and outputs

API Reference

​1. Create a job

​2. Poll the job

​3. Fetch the result

​Next

Examples

Webhooks

Files and outputs

API Reference

1. Create a job

2. Poll the job

3. Fetch the result

Next