Skip to main content
POST
video.avatar.render

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
avatar
string
required

The caller's chosen avatar name or a stable catalogue key.

Required string length: 1 - 255
look
string

Stable opaque catalogue key.

Pattern: ^k_[A-Za-z0-9_-]{43}$
script
string

Spoken text, at most 5,000 characters; script and fileId are mutually exclusive.

Required string length: 1 - 5000
fileId
string

Uploaded audio to speak instead of script; needs measured audio support.

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

Optional public voice catalogue key.

Pattern: ^k_[A-Za-z0-9_-]{43}$
background
string

Optional solid background colour.

Pattern: ^#[0-9a-fA-F]{6}$
aspectRatio
enum<string>
default:16:9

Frame shape.

Available options:
16:9,
9:16,
1:1,
4:5,
5:4,
auto
resolution
enum<string>
default:720p

Output resolution.

Available options:
720p,
1080p,
4k
tier
enum<string>
default:economical

Rendering tier; economical is the default and premium is explicit.

Available options:
economical,
standard,
premium

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.