Skip to main content
GET
https://api.pikzels.com
/
v1
/
persona
curl --location --request GET 'https://api.pikzels.com/v1/persona?id=abc123def456' \
--header 'X-Api-Key: YOUR_API_KEY'

{
  "id": "abc123def456",
  "created": 1704067200,
  "name": "My Character",
  "status": "Ready",
  "progress": 100,
  "temp_portrait_url": "https://media.pikzels.com/temp/portrait_abc123.jpg"
}
​
id
string
required
The persona ID returned from the training request

​
Status Values

Training request is in the queue and will begin processing soon.
Images are being analyzed and prepared for training.
The AI model is actively learning from images. This can take up to 3 minutes.
Training is complete! Your persona 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/persona?id=abc123def456' \
--header 'X-Api-Key: YOUR_API_KEY'

{
  "id": "abc123def456",
  "created": 1704067200,
  "name": "My Character",
  "status": "Ready",
  "progress": 100,
  "temp_portrait_url": "https://media.pikzels.com/temp/portrait_abc123.jpg"
}

​
Using Your Persona

Once status is “Ready”, use the persona ID in generation requests: 
{
  "prompt": "epic gaming moment",
  "format": "16:9",
  "model": "pkz-3", 
  "persona": "abc123def456"
}

​
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