Make a UGC frame
Make one UGC frame: a vertical still of a presenter with the product. The image-first UGC step: show the frame to the person and animate it with POST /v1/video/ugc/animate only after they approve it. Synchronous; charged only once the image exists, and the same idempotency key returns the same frame at 0 credits.
Authorizations
A workspace API key.
Headers
Required durable retry key. Reuse only for the identical logical request; a different payload returns conflict.
1 - 255Send 1 to get the price and balance without running anything.
"1"The approved price; a call that would cost more is refused and nothing is charged.
^\d+$Body
Existing project this call is made for; the frame itself is filed in the workspace Library.
1 - 200catalog:: or saved: (a saved presenter needs a verified likeness consent).
1 - 200Public HTTPS image URL or Content Engine content id.
1 - 2000The shot, in a few words.
4 - 600Send true only after confirming rights to use the supplied product image.
Send true only after confirming approval to use the selected presenter likeness.
Vertical UGC framing. Defaults to talking-head.
talking-head, product-in-hands Image model tier. Defaults to standard; the price is the same.
standard, pro