FFmpeg Extract Frame

Endpoint

POST https://api.roasos.com/v1/assembly/extract-frame

Send your API key as a bearer token. The key needs the scope api:write. Every paid request also needs an Idempotency-Key header.

The envelope fields quote_only, quote_id, webhook_url and wait_timeout_seconds behave the same on each model endpoint. Refer to Jobs and Quotes and credits.

Good at

Grab a last frame to start the next shot from, or a first frame to use as a thumbnail. This is the one assembly operation whose result is an image rather than a video, so the job reports the image kind.

The price is one credit, flat.

Pricing

The unit is one operation. Pricing key: extract-frame.

The credits come from the roasOS pricing table. No other field changes the price. To get the exact price of your request, send it with quote_only: true first.

Modes

• extract-frame

Provider endpoints: fal-ai/ffmpeg-api/extract-frame.

Request fields

The schema is strict. A field that is not in this table gets 400 unsupported_option. The field names are the roasOS role names. One role has one name in every family.

Media

This endpoint accepts these media roles:

• video_url — the source video

Every other role is refused: avatar_id, elements, product_id, product_images, references, reference_images, image_url, end_image_url, scene_id, scene_image, video_urls, audio_urls, audio_url, voice_id. A refused role gets 400 unsupported_option.

Prompt

None. This operation takes no prompt.

frame_type is first, middle or last, and it defaults to first. Set last to continue a clip: the frame this returns is the first frame of the next generation.

Not exposed

roasOS pins no provider field for this model.

Result

The result kind is image. Always present: nothing. Present when the run makes it: avatar_id, full_body_url, images, portrait_url, provider_seed, reference_sheet, url.

{
  "data": {
    "id": "gen_…",
    "kind": "video",
    "model": "extract-frame",
    "status": "completed",
    "result": {
      "avatar_id": "00000000-0000-4000-8000-000000000000",
      "full_body_url": "https://cdn.roasos.com/workspaces/ws_01/full_body_url",
      "images": [
        "https://cdn.roasos.com/workspaces/ws_01/images-1.png"
      ],
      "portrait_url": "https://cdn.roasos.com/workspaces/ws_01/portrait_url",
      "provider_seed": 0,
      "reference_sheet": "https://cdn.roasos.com/workspaces/ws_01/reference_sheet",
      "url": "https://cdn.roasos.com/workspaces/ws_01/result"
    }
  }
}

The files are immutable objects on https://cdn.roasos.com. A result URL is a valid media input for your next request.

Example

The three steps are always the same: quote, run, poll.

# 1. Quote. Nothing is spent.
curl -X POST https://api.roasos.com/v1/assembly/extract-frame \
  -H "Authorization: Bearer roasos_sk_live_..." \
  -H "Idempotency-Key: 0f1c9e2a-extract-frame-0001" \
  -H "Content-Type: application/json" \
  -d '{"quote_only":true,"video_url":"https://cdn.roasos.com/workspaces/ws_01/uploads/video_url.mp4"}'
# 200 { "data": { "kind": "quote", "quote_id": "q_7Hk...", "credits": 1, "expires_at": "...",
#        "confirmation": { "model": "extract-frame", "example": "per_operation" } } }

# 2. Run. Same body, same Idempotency-Key, quote_id in place of quote_only.
curl -X POST https://api.roasos.com/v1/assembly/extract-frame \
  -H "Authorization: Bearer roasos_sk_live_..." \
  -H "Idempotency-Key: 0f1c9e2a-extract-frame-0001" \
  -H "Content-Type: application/json" \
  -d '{"quote_id":"q_7Hk...","video_url":"https://cdn.roasos.com/workspaces/ws_01/uploads/video_url.mp4"}'
# 201 { "data": { "id": "gen_...", "status": "queued", "credits_reserved": 1 } }

# 3. Poll, then read the result.
curl https://api.roasos.com/v1/jobs/gen_.../status -H "Authorization: Bearer roasos_sk_live_..."
curl https://api.roasos.com/v1/jobs/gen_.../result -H "Authorization: Bearer roasos_sk_live_..."

Today

The endpoint is POST /v1/assembly/extract-frame.

It is live.

See also

• llms.txt for this model — the same facts as one plain-text file for an agent.
• GET https://api.roasos.com/v1/catalog/extract-frame — the machine-readable form: enums, defaults, limits and prices. Refer to the API reference.
• Jobs — how to poll a job and read its result.
• Provider endpoints: fal-ai/ffmpeg-api/extract-frame.