Sign in
Sources

Get a source's processing status

Returns whether a source from POST /v1/sources is ready to use, however it was placed (clip, b-roll, overlay, background, background music or sound effect). Poll it after placing a newly uploaded source: while it is processing, frames and previews of videos that use it answer not-ready instead of rendering.

get/v1/sources/{sourceId}

Path parameters

sourceIdstring required

Source ID

Example:su_abc

Source ID

Response

OK

idstring required

Source ID

status'pending' | 'processing' | 'ready' | 'failed' required

pending: not placed yet; conversion starts once a clip, layout, overlay, background, background music or sound effect references the source. processing: still uploading or converting; frames and previews of videos using it answer not-ready until it is ready, so poll this every few seconds. ready: usable everywhere. failed: conversion failed or the recording was cancelled; upload the file again as a new source.

Example response

{
  "id": "su_abc",
  "status": "processing"
}

Changes

Changed in 1 of the 19 revisions of this API.1

Of the 19 revisions, 1 has no diff computed.