Skip to main content
POST
video.avatar.look.get

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

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

Required string length: 1 - 255
look
string
required

Stable opaque catalogue key.

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

Response

The result

avatar
string
required

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

Required string length: 1 - 255
look
string
required

Stable opaque catalogue key.

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

Look name.

kind
enum<string>
required

Kind of appearance.

Available options:
studio,
photo,
twin
state
enum<string>
required

Current readiness; unknown means no readiness evidence was returned.

Available options:
processing,
awaiting_consent,
ready,
failed,
unknown
tiers
enum<string>[]
required

Supported rendering tiers.

Available options:
economical,
standard,
premium