Skip to main content
POST
/
v2
/
thumbnail
/
image
cURL
curl -X POST "https://api.pikzels.com/v2/thumbnail/image" \
  -H "X-Api-Key: pkz_yourapikey" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "Make the cat fur white",
  "model": "pkz_4",
  "format": "16:9",
  "image_url": "https://example.com/reference.jpg"
}'
{
  "output": "https://cdn.pikzels.com/example.png",
  "request_id": "18b2ad5e-2a9e-4d3f-b9a8-9f2a1e0b1234"
}

Authorizations

​
X-Api-Key
string
header
required

Your Pikzels API key (prefix: pkz_)

Body

application/json
​
image_url
string
required

HTTPS URL -- provide this or image_base64

Pattern: ^https://\S+$
​
model
enum<string>
required

Allowed values: "pkz_2", "pkz_3", "pkz_4", "pkz_4_5".

Available options:
pkz_2,
pkz_3,
pkz_4,
pkz_4_5
​
format
enum<string>
required

Allowed values: "16:9", "9:16", "1:1".

Available options:
16:9,
9:16,
1:1
​
prompt
string

Optional instructions for the image. Ignored for pkz_2. Cannot contain URLs

Required string length: 1 - 3000
Pattern: ^(?!.*[Hh][Tt][Tt][Pp]).+$
​
image_base64
string

Base64 data URL -- provide this or image_url

Pattern: ^data:image/[a-zA-Z0-9.+-]+;base64,
​
support_image_url
string

Reference image (pkz_4 and pkz_4_5 only), HTTPS URL. If both support_image_url and support_image_base64 are provided, support_image_url is used.

Pattern: ^https://\S+$
​
support_image_base64
string

Reference image (pkz_4 and pkz_4_5 only), base64 data URL. If both support_image_url and support_image_base64 are provided, support_image_url is used.

Pattern: ^data:image/[a-zA-Z0-9.+-]+;base64,
​
image_weight
enum<string>
default:medium

Only applies to pkz_2 model Allowed values: "low", "medium", "high".

Available options:
low,
medium,
high
​
persona
string

Persona ID

​
style
string

Style ID

Response

Success

​
output
string
required

URL to generated thumbnail (expires in 24h)

​
request_id
string
required