Skip to main content
POST
https://app.pixy.art
/
api
/
v1
/
{designId}
/
generate-ai
cURL
curl --request POST \
  --url https://app.pixy.art/api/v1/{designId}/generate-ai \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "Black Friday sale for a minimalist skincare brand"
}
'
{
  "id": "run_123",
  "designId": "tpl_123",
  "duration": 1842,
  "files": [
    {
      "url": "https://assets.example.com/generated/template-output-1.jpeg",
      "previewUrl": null,
      "size": 182441,
      "width": 1080,
      "height": 1920,
      "mimetype": "image/jpeg"
    }
  ],
  "ai": {
    "prompt": "Black Friday sale for a minimalist skincare brand",
    "thumbnailUrls": [
      "https://assets.example.com/templates/template-preview.jpeg"
    ],
    "modifications": [
      {
        "id": "title-text",
        "text": "Glow More This Black Friday",
        "autoFitText": true
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Organization API key passed as a bearer token.

Path Parameters

​
designId
string
required

Public Pixy template identifier.

Body

application/json
​
prompt
string
required

Prompt describing the campaign, offer, audience, product, or message to generate into the public template.

Minimum string length: 1
Example:

"Black Friday sale for a minimalist skincare brand"

​
format
enum<string>
default:jpeg

Output format. Defaults to jpeg. jpg is also accepted and normalized to jpeg.

Available options:
png,
jpeg,
pdf

Response

Successfully generated copy and rendered one or more output files.

​
id
string
required

Render run identifier.

​
designId
string
required

Public template identifier used for the render.

​
duration
integer
required

Total AI generation and render duration in milliseconds.

​
files
object[]
required

Rendered output files, one per generated page. When format is pdf, each page is returned as a separate PDF file.

​
ai
object
required