Skip to main content
POST
Edit your footage

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required durable retry key. Reuse only for the identical logical request; a different payload returns conflict.

Required string length: 1 - 255

Body

application/json
projectId
string
required

Existing project that owns the edited video.

Required string length: 1 - 200
instruction
string
required

What to change, in plain language.

Required string length: 1 - 4000
footageContentId
string

The source clip: a ready video in the workspace Library. Send this or footageUrl.

Required string length: 1 - 256
footageUrl
string

The source clip as a public HTTPS URL.

Maximum string length: 4096
workflow
enum<string>
default:object-swap

object-swap changes one thing; motion-transfer rebuilds the scene around the motion; edit is text-only and takes no references.

Available options:
object-swap,
motion-transfer,
edit
references
object[]

1-30 role-tagged reference images. A person must be a consented presenter; uploaded faces are refused.

Maximum array length: 30
resolution
enum<string>

Output resolution; defaults to 720p. Each step up costs more, and it cannot be combined with preview.

Available options:
480p,
720p,
1080p
preview
boolean

Run only the first 4 seconds at 480p first.

quoteOnly
boolean

Return the live price and charge nothing.

maxCredits
integer

Refuse, charging nothing, if the live price is higher.

Required range: x <= 9007199254740991
{key}
any

Response

Success.

success
boolean
required
projectId
string
jobId
string
kind
string
Allowed value: "video.footage"
workflow
string
status
enum<string>
Available options:
queued,
done
reused
boolean
quote
object
credits
number
reconciliationRequired
boolean
{key}
any