Skip to main content
POST
Make 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 frame itself is filed in the workspace Library.

Required string length: 1 - 200
presenter
string
required

catalog:: or saved: (a saved presenter needs a verified likeness consent).

Required string length: 1 - 200
productImage
string
required

Public HTTPS image URL or Content Engine content id.

Required string length: 1 - 2000
instruction
string
required

The shot, in a few words.

Required string length: 4 - 600
productRights
boolean
required

Send true only after confirming rights to use the supplied product image.

Send true only after confirming approval to use the selected presenter likeness.

format
enum<string>
default:talking-head

Vertical UGC framing. Defaults to talking-head.

Available options:
talking-head,
product-in-hands
quality
enum<string>
default:standard

Image model tier. Defaults to standard; the price is the same.

Available options:
standard,
pro
{key}
any

Response

Success.

success
boolean
required
projectId
string
required
frame
object
required
credits
number
required
{key}
any