Skip to main content
POST
video.product-ugc.generate

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
characterImageFileId
string
required

Id of an uploaded file holding the character image, with width/height between 0.4 and 4, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
productImageFileId
string
required

Id of an uploaded file holding the product image, with width/height between 0.4 and 4, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
productInfo
string
default:""

Product details; default empty.

Maximum string length: 2500
concept
string
default:""

Tone, message or spoken script; default empty.

Maximum string length: 3500
resolution
enum<string>
default:720p

Output size; 1080p costs more and must be chosen explicitly. Default 720p.

Available options:
720p,
1080p
durationSeconds
integer
default:10

Output duration in seconds, 4–15; default 10.

Required range: 4 <= x <= 15
audio
boolean
default:false

Generate sound; default false.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.