Skip to main content
POST
Quick reel

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
clipIds
string[]
required

Library content ids, in play order: videos and photos (at most 50).

Required array length: 1 - 50 elements
Pattern: ^[A-Za-z0-9._-]{1,256}$
projectId
string
required

Existing project the output is filed in (POST /v1/projects).

Required string length: 1 - 200
mode
enum<string>
default:reel

reel: every clip and photo into one short. photo-dump: photos only, a beat-synced montage.

Available options:
reel,
photo-dump
hook
string

Optional one-line hook or caption. Videos only: it is the title and brief. Photos with videos: it is shown on screen (required to mix them).

Maximum string length: 150
captionLines
string[]

photo-dump: optional on-screen lines, one per beat.

Maximum array length: 50
Maximum string length: 120
order
enum<string>

photo-dump: order by when each photo was taken (EXIF), the default, or as sent.

Available options:
as-sent,
capture-time
recipe
object

The look and the edits; omitted takes the Quick defaults (every chip on, no brand finish).

Response

Success.

success
boolean
required
projectId
string
required
parentJobId
string
childJobIds
string[]
credits
number
creditBalance
number
{key}
any