Skip to main content
Every example uses the same headers:

Upload, edit, render, deliver

  1. Upload. Request an upload URL, PUT the bytes, confirm.
upload_id is the item’s id from here on.
  1. Transcribe. Media under five minutes is transcribed within the call. Longer media returns a job, and once get_jobs reports it done, the same call returns the stored words.
  1. Build a timeline. Create one, then add the clip. source is the part of the file to use, in seconds. Leaving out from places the clip after the last one on that track, and a fresh timeline has one visual track, visual-main. A fresh document nobody has edited accepts a write without if_revision.
  1. Check, then render. check_timeline is free and reports problems a render would show. The render accepts an idempotency key made for this call.
  1. Get the result. By polling, or from a webhook.
With a webhook registered, the same result arrives as a POST to your URL:

One call over many items

The CLI is the same API from a shell, and --json returns { ok, data } with the tool’s data. A read tool also answers GET with query parameters.
update_items applies each item separately. A failure on one item is reported alongside the results for the others, and set names what changed on each. A page’s next_cursor, sent back with the same filters, returns the next page.

A charged call, retried

A generation is charged when it starts, so the idempotency key is what makes a retry safe.
After a 503 unavailable or a dropped connection, a retry with the same body and the same key returns the job already started, and nothing is charged twice. A 402 insufficient_credits won’t succeed on a retry. get_balance shows what is left and where more can be added, and get_checkout_link returns a link where the user can pay.
estimate_cost gives the price of the same call before it runs, for free, from the same rates.