Skip to main content
GET
cURL

Authorizations

X-Api-Key
string
header
required

Your Pikzels API key (prefix: pkz_)

Path Parameters

id
string
required

Response

Success

name
string
required
failure_code
string | null
required

Why processing failed (status failed only): a stable code such as SUBJECT_NOT_SUPPORTED or CONTENT_POLICY. Null otherwise

failure_message
string | null
required

The user-facing message for failure_code. Null unless status is failed

id
string
required
mode
enum<string>
required

Allowed values: "persona", "style".

Available options:
persona,
style
portrait_url
string | null
required

Portrait image URL (null until completed)

progress
number
required

0-100

reference
string[] | null
required

Reference image URLs (null until completed)

special_instructions
string | null
required
status
enum<string>
required

Allowed values: "processing", "completed", "failed".

Available options:
processing,
completed,
failed
subject_kind
enum<string> | null
required

Personas only: what the reference images show, decided at creation; object means the persona was refused. Null for styles and until classified Allowed values: "human", "animal", "character", "object".

Available options:
human,
animal,
character,
object
subject_medium
enum<string> | null
required

Personas only: the medium of the reference images. Null for styles and until classified Allowed values: "photo", "drawn", "3d".

Available options:
photo,
drawn,
3d