For Developers

API Documentation

Integrate professional AI product staging directly into your e-commerce platform, CMS, or mobile app.

Authentication

The API uses Bearer token authentication. Pass your keys in the Authorization header. To obtain an API key, please contact [email protected].

Authorization: Bearer YOUR_API_KEY

Generate Product Image

POST/api/v1/generate

Generate a photography-grade background for a product. Optimized for Amazon, Etsy, and Shopify listing requirements.

Request Body Parameters

Parameter	Type	Description
image	File \| URL	Product image file (multipart) or public URL.
prompt	string	Visual context (e.g. "on a rustic shelf").
style	slug	Available: `studio`, `lifestyle`, `nature`.
platform	slug	Presets: `etsy`, `amazon`, `shopify`.

Example Request

curl -X POST https://productstage.ai/api/v1/generate \
  -H "Authorization: Bearer ${API_KEY}" \
  -F "[email protected]" \
  -F "prompt=placed on a wooden podium in a sunny garden" \
  -F "style=nature" \
  -F "platform=etsy"

Example Response

{
  "status": "completed",
  "data": {
    "url": "https://cdn.productstage.ai/v/image_123.jpg",
    "metadata": { "width": 2000, "height": 2000 }
  },
  "credits": 1
}

Handling Errors

HTTP Status	Description
401 Unauthorized	Invalid or missing API key.
402 Payment Required	Insufficient credits in account.
429 Rate Limit	Too many requests. Back off and retry.
500 Server Error	Internal processing failure.