Skip to main content
GET
https://api.pikzels.com
/
v1
/
style
curl --location --request GET 'https://api.pikzels.com/v1/style?id=xyz789ghi012' \
--header 'X-Api-Key: YOUR_API_KEY'
{
  "id": "xyz789ghi012",
  "created": 1704067200,
  "name": "Cyberpunk Aesthetic",
  "status": "Ready",
  "progress": 100,
  "temp_portrait_url": "https://media.pikzels.com/temp/style_preview_abc123.jpg"
}
id
string
required
The style ID returned from the training request

Status Values

Training request is in the queue and will begin processing soon.
Reference images are being analyzed for style elements.
The AI model is learning the artistic style. This can take up to 3 minutes.
Training is complete! Your style is ready to use in generation requests.
The temp_portrait_url is only available for 12 hours after training completes. Download and host this image yourself if you want to keep it permanently.
curl --location --request GET 'https://api.pikzels.com/v1/style?id=xyz789ghi012' \
--header 'X-Api-Key: YOUR_API_KEY'
{
  "id": "xyz789ghi012",
  "created": 1704067200,
  "name": "Cyberpunk Aesthetic",
  "status": "Ready",
  "progress": 100,
  "temp_portrait_url": "https://media.pikzels.com/temp/style_preview_abc123.jpg"
}

Using Your Style

Once status is “Ready”, use the style ID in generation requests:
{
  "prompt": "epic battle scene",
  "format": "16:9",
  "model": "pkz-3", 
  "style": "xyz789ghi012"
}

Common Errors

All errors return this JSON structure:
{
  "error": {
    "code": "ERROR_CODE_HERE",
    "message": "Human readable message",
    "details": "Additional context"
  }
}
Status CodeCodeDescription
400BAD_REQUESTInvalid or missing fields
400CONTENT_POLICY_VIOLATIONRequest violates content policy
401INVALID_AUTH_HEADERInvalid API Key
402INSUFFICIENT_BALANCENot enough credits
429CONCURRENT_LIMIT_EXCEEDEDToo many concurrent requests
500INTERNAL_ERRORServer problem
503MAINTENANCE_ACTIVEUnder maintenance

Endpoint-Specific Errors

Status CodeCodeDescription
404NOT_FOUNDModel does not exist or is not available