Replace background with Ideogram 3.0
Replace the background of an image from a text prompt with Ideogram 3.0,
keeping the automatically detected foreground subject; no mask is
needed. Upload the source image using multipart/form-data.
Returns a generation_id; poll GET /v2/generations/{generation_id}
or supply a webhook_url.
Authentication
API key for access control. Use in the header with the name "Api-Key"
Query parameters
When true, the request is validated and priced but not run: nothing is
generated, stored, or billed, and no safety review is performed. The
response is a PriceQuote object instead of the usual response for this
endpoint. Send exactly the request you would send to generate, so the
quote reflects the same options.
Request
The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported, up to 50 MB. Multipart requests only. The longer side must be at most 3 times the shorter side; wider aspect ratios are rejected with a 400.
Plain-language description of the desired new background.
HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a
JSON POST to this URL once all images for the request have finished
generating. The body mirrors the synchronous generate response:
request_id, created, and a data array
containing every generated image (url, prompt, resolution, seed,
is_image_safe). Each delivery is signed with Ed25519 and verifiable
against the public keys at https://api.ideogram.ai/v1/.well-known/jwks.json. Must be HTTPS;
private and loopback hosts and the cloud metadata service are rejected.
Response
The generation ID to poll with GET /v2/generations/{generation_id}.