Skip to main content
POST
/
v2
/
thumbnail
/
edit
cURL
curl -X POST "https://api.pikzels.com/v2/thumbnail/edit" \
  -H "X-Api-Key: pkz_yourapikey" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "I bought my own island",
  "format": "16:9",
  "image_url": "https://cdn.pikzels.com/example.png"
}'
{
  "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+$
​
prompt
string
required

Cannot contain URLs

Required string length: 1 - 3000
Pattern: ^(?!.*[Hh][Tt][Tt][Pp]).+$
​
format
enum<string>
required

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

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

Base64 data URL -- provide this or image_url

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

Mask for inpainting area, HTTPS URL -- provide this or mask_base64

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

Mask for inpainting area, base64 data URL -- provide this or mask_url

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

Reference image, 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, 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,

Response

Success

​
output
string
required

URL to generated thumbnail (expires in 24h)

​
request_id
string
required