Skip to main content
POST
Create a video edit

Authorizations

Authorization
string
header
required

API key from Developer dashboard (Bearer token).

Body

application/json
video_url
string<uri>
required

Direct https media URL of the video (MP4/MOV/WebM).

title
string
Maximum string length: 255
language
string
default:auto

Spoken language: a code from GET /v1/languages, or "auto".

settings
object

How the edit looks. Every key is optional; GET /v1/edits/options lists them with their defaults and allowed values. An unknown key or value is a 422 naming it (e.g. settings.caption_style).

webhook_url
string<uri>

Public https URL told when the edit is ready, exported or failed (job.completed / job.failed), signed with this edit's webhook_secret.

auto_export
boolean
default:false

Export as soon as the edit is ready (export minutes are billed then).

Response

Accepted: the edit is queued.

success
enum<boolean>
Available options:
true
data
object
meta
object