Skip to main content

​
Base URL

All API requests should be made to: 
https://api.pikzels.com

​
Get Your API Key

1

Sign Up

Sign up for a Pikzels account to receive your API key at Pikzels Dashboard
2

Make Your First Call

Follow the example below to make your first API request
3

Explore Endpoints

Check out our API reference for all available features

​
Your First API Call

Let’s generate your first thumbnail! We’ll create a vibrant thumbnail with a simple text prompt. 
curl -X POST https://api.pikzels.com/v1/thumbnail \
  -H "X-Api-Key: pkz_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "adorable puppy playing in a sunny garden",
    "format": "16:9",
    "model": "pkz-2"
  }'

​
Response

A successful response will look like this: 
{
  "output": "https://media.pikzels.com/temp/pikzels_1234567890.jpeg"
}
The output field contains the URL of your generated image.
Generated images are available for approximately 24 hours. Download and host them yourself for permanent storage.

​
Understanding the Parameters

Let’s break down what each parameter does:
​
prompt
string
required
The text description of the thumbnail you want to generate. Be specific and descriptive for best results.
​
format
string
required
The aspect ratio of your image. Options:
  • 16:9 - Landscape (long form content)
  • 9:16 - Portrait (short form content)
  • 1:1 - Square (Instagram posts)
​
model
string
required
The AI model to use. Options:
  • pkz-1 - Legacy model: Great for gaming and vivid thumbnails (Roblox, Fortnite, GTA 5, FAR CRY, Minecraft, Pubg)
  • pkz-2 - Go-to model: Most versatile and consistent for realistic images, photorealism, and detailed content
  • pkz-3 - Latest model with the best output quality

​
What’s Next?

Now that you’ve made your first API call, explore more features:

Edit

Transform existing images with smart edits

FaceSwap

Seamlessly swap faces between images

Recreate

Recreate images with your own creative spin

Title

Transform your ideas into titles that work

​
Best Practices

  • Be specific and descriptive
  • Include style keywords (realistic, cartoon, minimalist)
  • Mention colors, lighting, and mood
  • Avoid contradictory descriptions
  • See our Rate Limits guide for detailed information
  • Implement exponential backoff for retries
  • Stay within the 10 concurrent request limit
  • Never expose your API key in client-side code
  • Use environment variables for API keys
  • Rotate keys regularly

​
Need Help?

Join Our Community

Get help, share ideas, and connect with the community

Contact Support

Reach out to our support team for assistance