Upscale with Topaz Bloom 2
Creatively upscale an image to 2x, 4x, or 8x its original resolution,
optionally guided by a prompt. Upload the source image using
multipart/form-data.
Returns results directly by default; set async or supply a
webhook_url to get a generation_id and poll
GET /v2/generations/{generation_id}.
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
A request to upscale one image with Topaz Bloom 2. Upload the source image using multipart/form-data.
How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
An optional prompt guiding the detail the model regenerates while enlarging the image. Leave empty to enhance the source image as-is.
How strongly the model reinterprets the source while enlarging it, from 1 (most faithful) to 9 (most creative).
When true (the default), the output keeps the source image's colors. Set to false to let the model adjust colors while enhancing.
When false (the default), the request blocks until the upscaled image is ready and returns it in data. When true, the request returns as soon as it is accepted; poll GET /v2/generations/{generation_id} for the result.
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 upscaled image (synchronous requests), or an acknowledgement to poll with GET /v2/generations/{generation_id} (async requests).
The generation ID to poll with GET /v2/generations/{generation_id}.
The upscaled image. Present only for synchronous requests (async omitted or false).