generate_listing_image
Generate listing photography for an existing product — an on-model shot, a detail crop, a flat lay, or the product in a real setting.
HOW IT WORKS: this EDITS the product's own rendered mockup. It is not text-to-image, and that is the point — the photo shows the actual colourway and the actual printed design, so it depicts the product a shopper will receive.
⚠️ A PRODUCT WITH NO MOCKUP IS REFUSED, not silently generated from scratch. A from-scratch product photo invents a product that does not exist and publishes it as photography of one that does — a listing-takedown and chargeback risk, not merely a quality problem. On product_has_no_mockup, render a mockup preview first (ship_product / create_product do this) and call again. Raw print artwork does not count as a mockup.
guidance is EXTRA wording folded in on top of the chosen preset — it does NOT replace it, and it cannot override the constraint that keeps the garment, colour and artwork unchanged. Use it for setting or mood ("outdoors at golden hour"), not to restate the product.
COST: this spends an image generation from the account's quota, like any other. Four styles across thirty products is 120 generations — more than some plans allow in total. Check the plan before looping over a catalogue.
By default the image is generated and RETURNED, not attached: putting a machine-made photo on a live storefront is a separate decision from making one. Pass attach: true to append it to the gallery — appended, so existing images are kept, unlike set_product_images which replaces the whole gallery.
[#b24313]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| style | Yes | Which preset to use. `on_model` = worn by a person; `detail` = close crop showing fabric and print texture; `flat_lay` = styled flat, shot from above; `lifestyle` = the product in a real setting. The preset supplies the prompt. | |
| attach | No | Append the result to the product's listing gallery (default false). Existing images are kept. Leave false to review the image before it reaches a storefront. | |
| guidance | No | Optional extra direction layered on top of the preset (setting, mood, lighting). Truncated at 500 characters by the platform. | |
| workspace | No | Workspace uuid (agency accounts). | |
| product_uuid | Yes | The product to photograph. Its existing mockup is what gets edited. | |
| set_as_cover | No | When attaching, also make it the listing cover. Ignored unless `attach` is true. | |
| source_image_url | No | Which of the product's existing listing images to edit. Must be one of them and must not be raw print artwork. Defaults to the product's best mockup — usually leave unset. |