Quickstart - Pikzels Public API

Base URL

https://api.pikzels.com

Get Your API Key

You need a Pikzels account to create an API key.

Create an account or log in at app.pikzels.com/dashboard.
Create an API key in your dashboard.
API keys always start with pkz_.

Authentication

Send your API key in the X-Api-Key header. Use this as an example key (not valid):

X-Api-Key: pkz_example_a1b2c3d4e5f6

Make Your First Request

cURL

curl -X POST https://api.pikzels.com/v2/thumbnail/text \
  -H "X-Api-Key: pkz_example_a1b2c3d4e5f6" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "I bought my first island",
    "model": "pkz_4_5",
    "format": "16:9"
  }'

Response

{
  "output": "https://cdn.pikzels.com/example.png",
  "model": "pkz_4_5",
  "prompt_compacted": false,
  "request_id": "18b2ad5e-2a9e-4d3f-b9a8-9f2a1e0b1234"
}

model is the model that actually generated the thumbnail. Prompts longer than 750 characters may be automatically shortened before generation; the response reports this via prompt_compacted.