Partner API
Products, feeds and brands
Your catalogue is shared by all your brands. Fill it product by product or from an XML feed; give each brand its look and the format its images must have.
/v1/partner/products/{external_id}Creates or updates the product with your id. Sending the same product again changes nothing.
Body
namestringrequiredimagesstring[]requiredsizestringH 28 cm. It goes into every prompt, and the fidelity check judges scale against it.placementstringwall | tabletop | standing. Decides which scenes fit. Read off the photos when left out.sold_asstringpair for shoes and other left/right pairs; single removes it.exact_textstring | string[]null removes it.sku, descriptionstringAlso: GET /partner/products, GET and DELETE /partner/products/{id}, and POST /partner/products/{id}/notes { "text": "The cap is matte" } for anything else every prompt should know.
curl -X PUT "https://api.productai.photo/v1/partner/products/CK-SNK-01" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{
"name": "Leather Sneaker White",
"sku": "CK-SNK-01",
"description": "Low-top leather sneaker, embossed logo on the heel",
"images": [
"https://cdn.example.com/snk-01-side.jpg",
"https://cdn.example.com/snk-01-heel-closeup.jpg"
],
"sold_as": "pair",
"exact_text": "Calvin Klein"
}'/v1/partner/feedsAdds an XML product feed in Google Merchant format (RSS or Atom) and starts reading it.
- Rows sharing a
g:item_group_id, such as the sizes of one shoe, become one product with that id. A row without a group is its own product. - Photos: every row's
g:image_linkandg:additional_image_link, main photos first, up to 10. - Sizes, colours, GTINs, prices and links of every row are kept on the product.
- Footwear is marked as a pair automatically.
- Read again every 24 hours; photos download again only when they changed.
POST /partner/feeds/{id}/importreads it now. Up to 10 feeds, 5,000 products each.
curl -X POST "https://api.productai.photo/v1/partner/feeds" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{ "url": "https://shop.example.com/google-feed.xml", "name": "EU footwear" }'{
"status": "OK",
"data": {
"feed": {
"id": 7,
"status": "idle",
"lastImportedAt": "2026-11-17T09:12:40Z",
"lastResult": {
"ok": true, "rows": 3184, "products": 412,
"created": 412, "updated": 0, "failed": 0
}
}
}
}/v1/partner/brands/{external_id}A brand holds its colors, voice and guidelines (set up moodboards in the dashboard under Brand) and an output spec: the format every image you download for the brand is guaranteed to have.
output_spec
aspectstring1:1, 4:5, 3:4, 2:3, 9:16, 4:3, 16:9 or original. Runs for the brand are generated in it.min_edgeintegerformatstringjpg, png, webp or original.An image a few pixels off the ratio is trimmed; one further off is padded, never cut through the product. Also GET /partner/brands and DELETE /partner/brands/{id}.
curl -X PUT "https://api.productai.photo/v1/partner/brands/ck-footwear" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{
"name": "Calvin Klein Footwear",
"colors": [{ "hex": "#111111", "name": "Ink" }],
"voice": "Minimal, confident.",
"output_spec": { "aspect": "1:1", "min_edge": 1080, "format": "jpg" }
}'