Skip to main content
POST
Animate a UGC frame

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
x-sigmora-quote-only
string

Send 1 to get the price and balance without running anything.

Allowed value: "1"
x-sigmora-max-credits
string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json
projectId
string
required

Existing project this call is made for; the clip itself is filed in the workspace Library.

Required string length: 1 - 200
frameId
string
required

frame.id from POST /v1/video/ugc/frame.

Required string length: 1 - 200
motion
string
required

What happens in the clip; a quoted line is spoken when the model makes sound.

Required string length: 3 - 600
model
string
required

Clip model key that animates images at 9:16; an unknown key is refused.

Required string length: 1 - 80
durationSec
integer
required

Clip length in seconds, one the model offers. A frame of an AI creator runs as long as its dialogue.

Required range: x <= 60
dialogue
string

The line an AI creator says; required when the frame shows one, ignored otherwise.

Required string length: 1 - 400
camera
enum<string>

Where the phone is in an AI creator clip. Defaults to propped.

Available options:
propped,
selfie,
car
{key}
any

Response

Success.

success
boolean
required
quote
object
required
{key}
any