Skip to main content
POST
cURL

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. A YouTube watch URL resolves to that video's current thumbnail

Pattern: ^https://\S+$
prompt
string
required

Cannot contain URLs. Prompts longer than 750 characters may be automatically shortened before generation; the response reports this via prompt_compacted

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. A YouTube watch URL resolves to that video's current thumbnail. 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

model
string
required

The model that generated this thumbnail

output
string
required

URL to generated thumbnail (expires in 24h)

prompt_compacted
boolean
required

True when the prompt was shortened automatically before generation

request_id
string
required