Layerize text with Ideogram 3.0 | Ideogram

{
  "generation_id": "generation_id",
  "seed": 12345,
  "data": [
    {
      "resolution": "1024x1024",
      "is_image_safe": true,
      "seed": 12345,
      "text_blocks": [
        {
          "x": 0,
          "y": 6,
          "width": 1,
          "height": 5,
          "text": "Hello World",
          "alignment": "left",
          "formatting": [
            "bold",
            "bold"
          ],
          "angle": 5.637377,
          "font_name": "font_name",
          "font_alternatives": [
            "font_alternatives",
            "font_alternatives"
          ],
          "font_size": 2,
          "line_height": 7.0614014,
          "color": "#212121",
          "role": "heading"
        },
        {
          "x": 0,
          "y": 6,
          "width": 1,
          "height": 5,
          "text": "Hello World",
          "alignment": "left",
          "formatting": [
            "bold",
            "bold"
          ],
          "angle": 5.637377,
          "font_name": "font_name",
          "font_alternatives": [
            "font_alternatives",
            "font_alternatives"
          ],
          "font_size": 2,
          "line_height": 7.0614014,
          "color": "#212121",
          "role": "heading"
        }
      ],
      "url": "https://openapi-generator.tech",
      "base_image_url": "https://openapi-generator.tech",
      "object_type": "layerized_image"
    },
    {
      "resolution": "1024x1024",
      "is_image_safe": true,
      "seed": 12345,
      "text_blocks": [
        {
          "x": 0,
          "y": 6,
          "width": 1,
          "height": 5,
          "text": "Hello World",
          "alignment": "left",
          "formatting": [
            "bold",
            "bold"
          ],
          "angle": 5.637377,
          "font_name": "font_name",
          "font_alternatives": [
            "font_alternatives",
            "font_alternatives"
          ],
          "font_size": 2,
          "line_height": 7.0614014,
          "color": "#212121",
          "role": "heading"
        },
        {
          "x": 0,
          "y": 6,
          "width": 1,
          "height": 5,
          "text": "Hello World",
          "alignment": "left",
          "formatting": [
            "bold",
            "bold"
          ],
          "angle": 5.637377,
          "font_name": "font_name",
          "font_alternatives": [
            "font_alternatives",
            "font_alternatives"
          ],
          "font_size": 2,
          "line_height": 7.0614014,
          "color": "#212121",
          "role": "heading"
        }
      ],
      "url": "https://openapi-generator.tech",
      "base_image_url": "https://openapi-generator.tech",
      "object_type": "layerized_image"
    }
  ]
}

Turn a flat image into an editable design: detected text is returned as positioned text blocks with matched fonts, sizes, and colors, alongside a text-free base image. Upload the image as 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-Keystring

API key for access control. Use in the header with the name "Api-Key"

Query parameters

dry_runbooleanOptionalDefaults to false

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 layerize the text in one image. Send it as multipart/form-data with the source image.

imagefileRequired

The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only.

promptstring or nullOptional<=10000 characters

A description of the image, used to guide text detection. When omitted, detection runs on the image alone.

seedintegerOptional0-2147483647

Random seed. Set for reproducible generation.

font_candidate_filesfilesOptional

Candidate font files to make available for text style matching. Supported formats .ttf, .otf, .woff, .woff2 (max 5MB each, maximum 5 files). Multipart requests only.

asyncbooleanOptionalDefaults to false

When false (the default), the request waits until layerization is complete and returns the result in data. When true, the request returns as soon as it is accepted; poll GET /v2/generations/{generation_id} with the returned generation_id for the result.

webhook_urlstringOptionalformat: "uri"<=2048 characters

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 layerized design (synchronous requests), or an acknowledgement to poll with GET /v2/generations/{generation_id} (async requests).

generation_idstring

URL-safe base64 ID of the generation. Use it to poll GET /v2/generations/{generation_id}.

seedinteger0-2147483647

Random seed. Set for reproducible generation.

datalist of objectsOptional

The layerized design. Present only for synchronous requests (async omitted or false).

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error