Sign in
images-upscale

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

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.

post/v2/image/upscale/topaz-redefine

Query parameters

dry_runboolean

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

promptstring

An optional prompt guiding the detail the model regenerates while enlarging the image. Leave empty to enhance the source image as-is.

creativityinteger

How strongly the model reinterprets the source while enlarging it, from 1 (most faithful) to 9 (most creative).

autopromptboolean

When true, the model describes the image itself and any prompt is ignored.

textureinteger

How much fine texture the model adds, from 1 to 5. Keep it low at low creativity.

detailboolean

Apply a detail adjustment after rendering. When true, detail_strength sets how much.

detail_strengthnumber float

Detail adjustment intensity, from 0 to 10.

sharpennumber float

Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image.

denoisenumber float

Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image.

face_enhancementboolean

Recover detail in faces. When true, face_enhancement_strength and face_enhancement_creativity are required.

face_enhancement_strengthnumber float

How strongly faces are recovered, from 0 to 1.

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

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 3 of the 33 revisions of this API.613

  • 987f73fc82de4See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 4e95197be44a68See the full diff
    • ▲

      removed the enum value X2 of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value X2 of the request property (media type: application/json)

      request-property-enum-value-removed

    • ▲

      removed the enum value X4 of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value X4 of the request property (media type: application/json)

      request-property-enum-value-removed

    • ▲

      removed the enum value X8 of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value X8 of the request property (media type: application/json)

      request-property-enum-value-removed

    • ○

      the request property default value changed from X2 to x2 (media type: multipart/form-data)

      request-property-default-value-changed

    • ○

      the request property default value changed from X2 to x2 (media type: application/json)

      request-property-default-value-changed

    • ○

      added the new x2 enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new x2 enum value to the request property (media type: application/json)

      request-property-enum-value-added

    • ○

      added the new x4 enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new x4 enum value to the request property (media type: application/json)

      request-property-enum-value-added

    • ○

      added the new x8 enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new x8 enum value to the request property (media type: application/json)

      request-property-enum-value-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cb077a6ff5801See the full diff
    • ○

      endpoint added

      endpoint-added