--- title: "Upscale an image with Topaz Redefine, by asset id or by uploaded bytes" method: POST path: "/v2/image/upscale/topaz-redefine" tags: ["images-upscale"] --- # Upscale an image with Topaz Redefine, by asset id or by uploaded bytes `POST /v2/image/upscale/topaz-redefine` Creatively upscale one image to 2x, 4x, or 8x its original resolution, up to a maximum output of 8192px per side. Supply the source either as an `image_asset_identifier` reference (an image already stored with Ideogram) or as raw `image` bytes (multipart requests only) — callers are never required to upload the asset first. If both are supplied, the reference wins and the bytes are ignored. Uploaded bytes are used for this request only and are not stored as an asset; upscales of a referenced asset keep a visible link to their source image. An optional `prompt` guides the regenerated detail, or `autoprompt` lets the model describe the image itself. `creativity` controls how strongly the model reinterprets the source, `texture` how much fine texture it adds, and the precision knobs (sharpen, denoise, detail, face enhancement, subject detection) refine the result. By default the request blocks until the upscaled image is ready and returns it in `data`. Set `async` to true to return immediately after the request is accepted, then poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`. Supplying a `webhook_url` makes the request asynchronous whatever `async` says: the response returns as soon as the request is accepted, and the finished result is POSTed to that URL. ## Query parameters - `dry_run` boolean ## Request body - UpscaleImageTopazRedefineRequest — Supply the source image either as an `image_asset_identifier` reference or (multipart requests only) as raw `image` bytes. Exactly one source is required; if both forms are given, the reference is used and the bytes are ignored. - `image_asset_identifier` AssetIdentifier — An identifier for an ideogram asset. - `asset_type` 'ASSET' | 'CANVAS_ASSET' | 'LAYERED_ASSET' | 'RESPONSE' | 'UPLOAD', required - `asset_id` string, required - `image` string, binary — The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. - `upscale_factor` 'x2' | 'x4' | 'x8' — 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. - `prompt` string — An optional prompt guiding the detail the model regenerates while enlarging the image. Leave empty to enhance the source image as-is. - `creativity` integer — How strongly the model reinterprets the source while enlarging it, from 1 (most faithful) to 9 (most creative). - `autoprompt` boolean — When true, the model describes the image itself and any `prompt` is ignored. - `texture` integer — How much fine texture the model adds, from 1 to 5. Keep it low at low creativity. - `detail` boolean — Apply a detail adjustment after rendering. When true, `detail_strength` sets how much. - `detail_strength` number, float — Detail adjustment intensity, from 0 to 10. - `sharpen` number, float — Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. - `denoise` number, float — Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. - `face_enhancement` boolean — Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. - `face_enhancement_strength` number, float — How strongly faces are recovered, from 0 to 1. - `face_enhancement_creativity` number, float — How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). - `subject_detection` 'all' | 'foreground' | 'background' — Where enhancements apply. Omit to let Topaz choose per image. - `seed` integer — Random seed. Set for reproducible generation. - `async` boolean — 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 for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`. - `webhook_url` string, uri — 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. - `private` boolean, nullable — When true or omitted, the output is kept private to your account. Set to false to publish the output to the public feed. Enterprise accounts always generate privately. - `target_collection_id` string — A collection you can write to, by its URL-safe base64 collection id. The output images are added to it when the request completes. ## Response `200` The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests). - UpscaleImageTopazRedefineResponse — Response returned by `POST /v2/image/upscale/topaz-redefine`. Synchronous requests (the default) include the upscaled image in `data`. Requests with `async` set to true omit `data`; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`. The seed reports the value the request resolved to when the caller left it unset; width and height report the output dimensions. - `generation_id` string, required — URL-safe base64 ID of the accepted generation. Accepted by the `GET /v1/generations/{generation_id}` polling endpoint. - `data` UpscaleImageObject[] — The upscaled image. Present only for synchronous requests (`async` omitted or false). - `url` string, uri, nullable — The direct link to the upscaled image. Empty when the image did not pass safety checks. - `resolution` string, required — The resolution of the upscaled image, formatted as "WIDTHxHEIGHT". - `is_image_safe` boolean, required — Whether the image passed safety checks. If false, `url` is empty. - `seed` integer, required — Random seed. Set for reproducible generation. - `seed` integer, required — Random seed. Set for reproducible generation. - `width` integer, required — The output width in pixels. - `height` integer, required — The output height in pixels. ## Other responses - `400` — Invalid input provided, or the output would exceed the 8K limit. - `401` — Unauthorized. - `402` — Insufficient credits or quota. - `404` — The referenced source asset was not found. - `422` — The prompt did not pass safety checks. - `429` — Too many requests. - `500` — Internal server error. - `503` — The endpoint is temporarily unavailable. ## Changes - **2026-09-19** `4e95197be44a` — 6 breaking, 8 info - removed the enum value `X2` of the request property `upscale_factor` (media type: multipart/form-data) - removed the enum value `X2` of the request property `upscale_factor` (media type: application/json) - removed the enum value `X4` of the request property `upscale_factor` (media type: multipart/form-data) - removed the enum value `X4` of the request property `upscale_factor` (media type: application/json) - …10 more - **2026-09-18** `cb077a6ff580` — 1 info - endpoint added [Change history](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/changes/v2/image/upscale/topaz-redefine/post.md) --- [API](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0.md) · [All operations](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/revisions/cdaa218128ba?raw)