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
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