images-upscale

Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes

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.

Upscaling takes no prompt: the model enhances the source image as-is.

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.

post/v2/images/upscale/topaz-text-refine

Request body

imagestring 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.

seedinteger

Random seed. Set for reproducible generation.

asyncboolean

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_urlstring 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.

privateboolean 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_idstring

A collection you can write to, by its URL-safe base64 collection id. The output images are added to it when the request completes.

Example request

{
  "image_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "seed": 12345,
  "webhook_url": "https://api.example.com/webhooks/ideogram"
}

Response

The upscaled image (synchronous requests), or an acknowledgement to poll with GET /v1/generations/{generation_id} (async requests).

generation_idstring required

URL-safe base64 ID of the accepted generation. Accepted by the GET /v1/generations/{generation_id} polling endpoint.

seedinteger required

Random seed. Set for reproducible generation.

widthinteger required

The output width in pixels.

heightinteger required

The output height in pixels.

Example response

{
  "data": [
    {
      "seed": 12345,
      "resolution": "2048x2048",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    },
    {
      "seed": 12345,
      "resolution": "2048x2048",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    }
  ],
  "seed": 12345,
  "generation_id": "generation_id",
  "width": 0,
  "height": 6
}

Changes

Changed in 2 of the 16 revisions of this API.3

Aug 27, 20263eb3216eed392See the full diff
- ○
  added the new optional request property webhook_url (media type: multipart/form-data)
  new-optional-request-property
- ○
  added the new optional request property webhook_url (media type: application/json)
  new-optional-request-property
Aug 26, 2026204996bf317a1See the full diff
- ○
  endpoint added
  endpoint-added

Full history