Sign in
edit-workflow

Text Layerizer

Changed on

Turns a flat image into an editable design asynchronously: detected text is returned as positioned text blocks with matched fonts, sizes, and colors, alongside a text-free base image and a standalone HTML page of the editable design. Returns a generation_id; poll GET /v2/generations/{generation_id} or supply a webhook_url.

post/v2/tool/text-layerizer

Request

  • Base URL: (relative, and it does not resolve against the document’s source URL)
  • URL: /v2/tool/text-layerizer
  • Auth: one of:
    • API key in header Api-Key
    • HTTP bearer

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

JPEG, PNG or WEBP source; at most 50 MB. Multipart only.

promptstring nullable

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

seedinteger

Random seed. Set for reproducible generation.

font_candidate_filesstring[]

Candidate font files to make available for text style matching and to embed in the standalone HTML page. Supported formats .ttf, .otf, .woff, .woff2 (max 5 MB each, at most 5 files). Multipart only. You are responsible for holding the rights to embed and redistribute the fonts you upload.

privateboolean

Outputs are private by default. Enterprise outputs are always private.

target_collection_idstring

URL-safe base64 ID of a writable destination collection.

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.

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

Layerization accepted; dry runs return the shared PriceQuote response.

generation_idstring required

URL-safe base64 generation ID.

Example response

{
  "generation_id": "generation_id"
}

Changes