Replace images on a site
regenerate_imagesFind or make new images for the given image_ids: first matches from the account's image library, then professional stock photography, then AI generation. By default the top find replaces each image on the site (recorded in version history); apply: false returns candidates to choose from instead, committed with apply_image_replacements. May SPEND Creative Credits, only for images that need AI generation: call plan_image_regeneration first and send its credits as expected_credit_cost with a stable idempotency_key. A different price is refused with nothing charged.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"site_id": "<site_id>",
"image_ids": "<image_ids>",
"expected_credit_cost": "<expected_credit_cost>",
"idempotency_key": "<idempotency_key>"
},
"name": "regenerate_images"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| apply | No | Default true: put the top find on the site. false: only return candidates to choose from, then apply_image_replacements. | |
| site_id | Yes | The site to act on | |
| image_ids | Yes | The image_id values from plan_image_regeneration to replace. | |
| user_goal | No | Optional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details. | |
| style_hint | No | VIBE: how the images should feel ("warm photography"), not what they show. | |
| user_prompt | No | SUBJECT, when the user named one ("a red sports car"): every image will depict it. Their literal words. | |
| variation_id | No | The design to work on. Omit for the site's live design. | |
| idempotency_key | Yes | Stable key for this attempt; reuse it on a retry so nothing is charged twice | |
| expected_credit_cost | Yes | `credits` from plan_image_regeneration for these images (0 when the plan uses its image allowance) |