generate_image
Generate or edit a single image via a configurable relay, applying explicit output parameters and verifying the returned bytes meet the requested constraints.
Instructions
Generate or edit one image through the configured relay; send explicit output parameters and verify original returned bytes. No retries, resizing, model substitution or fallback.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | auto edits when references exist; generate uses references as inspiration. edit requires an input image. | auto |
| size | No | max, auto, source, or WIDTHxHEIGHT. Max resolves the largest documented legal request canvas. Returned dimensions are checked; no resampling. | max |
| prompt | Yes | ||
| strict | No | Return isError when requested constraints are unmet or model/quality metadata is insufficient; keep image and report. | |
| quality | No | Explicit quality field. Higher levels require model support; returned metadata is checked separately from visual quality. | high |
| preserve | No | Content that must remain unchanged when editing; requires visual review. | |
| background | No | auto, opaque or transparent. Real alpha pixels are inspected after full decoding. | auto |
| image_model | No | Explicit image model; availability and supported quality depend on the provider. No automatic substitution. | gpt-image-2.5-sunburst |
| aspect_ratio | No | auto, source, or W:H e.g. 16:9, 9:16, 1:1. Must agree with explicit size. API derives a compatible size. Checked against actual output. | auto |
| output_format | No | PNG, WebP or JPEG; transparent output requires PNG or WebP. Actual file format is verified. | png |
| reference_roles | No | One role per input image in order, e.g. edit target, lighting reference, object to insert. | |
| reference_image_paths | No |