edit_image_set
Change how an existing image set is delivered, without generating again: its width and height (both, one, or neither, exactly as on the set tools), its canvas when no size is fixed (one canvas for the whole set, or each image wrapped around its own subject), its minimum margin, its sizing (relative or fill), its format and quality, and for a transparent set the background color it is composed over. The set is delivered again from its full-resolution source and its download is replaced in place: the same download URL now serves the new delivery, and get_generations reports the new levers. Free; no credits are spent. Style, subjects and references are generation and cannot be edited - a different picture is a new set.
A lever left out keeps its current value, so one call can change one thing. Any earlier state, the original delivery included, is one edit away: nothing is kept as history because the same levers always produce the same bytes. Editing never extends a set's download window.
jpg has no alpha: asking for jpg on a transparent set composes the images over white unless the same call gives a background color; jpg together with background "transparent" is rejected. background applies to transparent sets only. Not available for illustrations, or for sets generated before this tool existed (they have no source).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reset | No | true restores every lever to the first delivery's (the set as it was generated), read from the set's own record; any other lever given in the same call is applied on top of that. | |
| width | No | New delivered width in pixels, or 0 to stop fixing the width. Left out, the current width stays. Width and height combine exactly as on the set tools: both fixed is an exact box, one fixed lets the other hug each subject, neither is native size. | |
| canvas | No | With NEITHER width nor height fixed, what the images land on: uniform (the default) puts the whole set on one canvas, the size it was generated at, every image alike; subject wraps each image around its own subject, so the images differ in size the way the subjects do. Says nothing when a size is fixed. Left out, the current value stays. | |
| format | No | New format: png, webp, or jpg. Left out, the current format stays. jpg has no alpha: on a transparent set it composes the images over white unless a background color is given in the same call. | |
| height | No | New delivered height in pixels, or 0 to stop fixing the height. Left out, the current height stays. | |
| sizing | No | New sizing: relative keeps the sizes the model gave the subjects in relation to one another (one scale for the set); fill scales each subject on its own to fill the frame less the margin, so every image reads at the same visual weight, at the cost of relative size and of enlarging subjects smaller than the frame (the result reports by how much). Left out, the current sizing stays. | |
| quality | No | New quality (1-100) for webp and jpg; ignored for png. Left out, the current quality stays. | |
| background | No | Transparent sets only: a #RRGGBB color composes every image over it and delivers an opaque set; "transparent" restores the alpha. Left out, the current background stays. Rejected on a solid-background set, whose color is in its pixels and cannot change. | |
| generation | Yes | The id of the set to edit - the random segment of its download URL, as list_recent_generations returns it. One batch of a set per call; a set that grew over several calls is edited batch by batch. | |
| minimumMargin | No | New minimum margin in pixels around each subject, with the set tools' bounds. Left out, the current margin stays. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | ||
| height | No | ||
| images | No | ||
| levers | No | The delivery levers now in force: width, height, canvas, minimumMargin, sizing, format, quality, background. | |
| zipURL | No | The set's download, unchanged, now serving the new delivery. | |
| expiresAt | No | ||
| generation | No | ||
| deliveredAt | No | ||
| iconCeiling | No | The largest base size, in pixels, at which export_icons keeps every density of this set crisp at these levers; absent when no base size does. |