Partner API
Scenes, runs and review
A run photographs products in scenes for one brand. Every image is checked, reviewed and delivered in the brand's output spec.
/v1/partner/scenesA scene is a shot you want, written for "the product" rather than one SKU; we adapt it to each product. reference_image_url is optional: the model sees it as a style reference. You can also use any ProductAI template id as a scene. GET /partner/scenes lists yours.
curl -X POST "https://api.productai.photo/v1/partner/scenes" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{
"name": "Concrete plinth, hard light",
"prompt": "The product on a raw concrete plinth, hard sunlight from the left, long shadow, bone background",
"reference_image_url": "https://cdn.example.com/moodboard/plinth.jpg"
}'/v1/partner/runsBody
productsstring[]requiredscenesinteger[]requiredbrandstringmodestringdefault: spreadspread: one fitting scene per product. all: every fitting scene. plan [{ "product", "scene" }] sets exactly which product gets which scene.modelstringGET /partner/account.external_idstringmetadataobjectThe whole run is priced up front and refused when your balance cannot cover it; failed images are refunded. GET /partner/runs/{id} returns the run and its items: state, review, job.imageUrl and the fidelity verdict.
curl -X POST "https://api.productai.photo/v1/partner/runs" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{
"external_id": "ck-ss27-batch-1",
"brand": "ck-footwear",
"products": ["CK-SNK-01", "CK-SNK-02"],
"scenes": [90211, 90212],
"model": "NANOBANANAPRO",
"mode": "spread"
}'/v1/partner/runs/{id}/items/{item_id}/reviewApprove or reject an image. A rejection's note goes into the redo's prompt; remember keeps a note on the product for every later prompt.
POST …/items/{item_id}/regenerateredoes one image (costs one image);POST /partner/runs/{id}/regenerate-rejectedredoes all rejected ones.run.reviewUrlis a page where someone without a login approves or rejects. Share it like a password.POST /partner/runs/{id}/download{ "review": "approved" }returns a zip in the brand's output spec.POST /partner/runs/{id}/canceland/resume.
curl -X POST "https://api.productai.photo/v1/partner/runs/88/items/1201/review" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{
"review": "rejected",
"note": "Heel logo is garbled",
"remember": { "text": "Heel logo reads Calvin Klein in thin caps" }
}'