Skip to main content
POST
https://app.pixy.art
/
api
/
v1
/
{designId}
/
generate
cURL
curl --request POST \
  --url https://app.pixy.art/api/v1/{designId}/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": "run_123",
  "designId": "des_123",
  "duration": 842,
  "files": [
    {
      "url": "https://assets.example.com/generated/design-output-1.png",
      "previewUrl": null,
      "size": 237993,
      "width": 1080,
      "height": 1920,
      "mimetype": "image/png"
    },
    {
      "url": "https://assets.example.com/generated/design-output-2.png",
      "previewUrl": null,
      "size": 236102,
      "width": 1080,
      "height": 1920,
      "mimetype": "image/png"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.pixy.art/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Organization API key passed as a bearer token.

Path Parameters

​
designId
string
required

Pixy design or template identifier.

Body

application/json
​
format
enum<string>
default:jpeg

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

Available options:
png,
jpeg,
pdf
​
modifications
object[]

Optional object-level overrides applied before rendering.

Supported overrides are inferred from the current implementation: text replacement for text objects, fill/stroke color replacement for text, image, and SVG objects, and source image replacement for image objects.

Response

Successfully rendered one or more output files.

​
id
string
required

Render run identifier.

​
designId
string
required

Design identifier used for the render.

​
duration
integer
required

Total 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.