Sign in
images-inpaint

Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes

Repaint the masked region of a source image from a text prompt with Ideogram 3.0. For each of the source image and the mask, supply either an AssetIdentifier reference (image_asset_identifier / mask_asset_identifier) or the raw image bytes directly (image / mask, multipart requests only). If both a reference and bytes are supplied for the same input, the reference wins and the bytes are ignored.

Optional style controls: style codes, a style preset, or style reference images. Supply style references as a saved style (style_reference_collection_id), as style_reference_asset_identifiers references (images already stored with Ideogram), or as raw style_reference_images bytes (multipart requests only). If more than one form is supplied, the collection wins over the identifiers, and the identifiers win over the bytes.

The output matches the size of the source image (snapped to the nearest resolution the model renders). By default the request blocks until the images are ready and returns them 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/inpaint/ideogram-3

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

promptstring required

The prompt describing the repainted result.

imagestring binary

The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if image_asset_identifier is also supplied.

maskstring binary

A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if mask_asset_identifier is also supplied.

magic_prompt'auto' | 'on' | 'off'

Determine if MagicPrompt should be used in generating the request or not.

num_imagesinteger

The number of images to generate.

seedinteger

Random seed. Set for reproducible generation.

rendering_speed'turbo' | 'default' | 'quality'

The rendering speed to use.

style_type'auto' | 'general' | 'realistic' | 'design' | 'custom' | 'fiction' | 'stylized'

The style type to generate with.

style_preset'80s_illustration' | '90s_nostalgia' | 'abstract_organic' | 'analog_nostalgia' | 'art_brut' | 'art_deco' | 'art_poster' | 'aura' | 'avant_garde' | 'bauhaus' | 'blueprint' | 'blurry_motion' | 'bright_art' | 'c4d_cartoon' | 'childrens_book' | 'collage' | 'coloring_book_i' | 'coloring_book_ii' | 'cubism' | 'dark_aura' | 'doodle' | 'double_exposure' | 'dramatic_cinema' | 'editorial' | 'emotional_minimal' | 'ethereal_party' | 'expired_film' | 'flat_art' | 'flat_vector' | 'forest_reverie' | 'geo_minimalist' | 'glass_prism' | 'golden_hour' | 'graffiti_i' | 'graffiti_ii' | 'halftone_print' | 'high_contrast' | 'hippie_era' | 'iconic' | 'japandi_fusion' | 'jazzy' | 'long_exposure' | 'magazine_editorial' | 'minimal_illustration' | 'mixed_media' | 'monochrome' | 'nightlife' | 'oil_painting' | 'old_cartoons' | 'paint_gesture' | 'pop_art' | 'retro_etching' | 'riviera_pop' | 'spotlight_80s' | 'stylized_red' | 'surreal_collage' | 'travel_poster' | 'vintage_geo' | 'vintage_poster' | 'watercolor' | 'weird' | 'woodblock_print'

A predefined style preset that applies a specific artistic style to the generated image.

style_codesStyleCode[]

A list of 8-character hexadecimal codes representing the style of the image. Refer to each endpoint for supported combinations with style types, presets, and reference images.

style_reference_collection_idstring

A saved style to apply, by its URL-safe base64 collection id. Takes priority over style_reference_asset_identifiers and style_reference_images if more than one is supplied.

style_reference_collection_version_idstring

Optional URL-safe base64 version id pinning a specific version of the style_reference_collection_id collection. Ignored without it.

style_reference_imagesstring[]

Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied.

enable_copyright_detectionboolean nullable

Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with is_image_safe: false.

asyncboolean

When false (the default), the request blocks until the repainted images are ready and returns them 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"
  },
  "mask_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "magic_prompt": "on",
  "seed": 12345,
  "style_type": "general",
  "style_preset": "bright_art",
  "style_codes": [
    "AAFF5733",
    "0133FF57",
    "DE3357FF"
  ],
  "style_reference_asset_identifiers": [
    {
      "asset_type": "RESPONSE",
      "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
    }
  ],
  "webhook_url": "https://api.example.com/webhooks/ideogram"
}

Response

The repainted images (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 this request resolved to.

heightinteger required

The output height in pixels this request resolved to.

Example response

{
  "data": [
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    },
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "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.24431

  • 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

  • 4e95197be44a24426See the full diff
    • ▲

      added to the request property allOf list (media type: multipart/form-data)

      request-property-all-of-added

    • ▲

      added to the request property allOf list (media type: application/json)

      request-property-all-of-added

    • ▲

      added to the request property allOf list (media type: multipart/form-data)

      request-property-all-of-added

    • ▲

      added to the request property allOf list (media type: application/json)

      request-property-all-of-added

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ▲

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

      request-property-enum-value-removed

    • ●

      removed from the request property allOf list (media type: multipart/form-data)

      request-property-all-of-removed

    • ●

      removed from the request property allOf list (media type: application/json)

      request-property-all-of-removed

    • ●

      removed from the request property allOf list (media type: multipart/form-data)

      request-property-all-of-removed

    • ●

      removed from the request property allOf list (media type: application/json)

      request-property-all-of-removed

    • ○

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

      request-property-default-value-changed

    • ○

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

      request-property-default-value-changed

    • ○

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

      request-property-default-value-changed

    • ○

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

      request-property-default-value-changed

    • ○

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

      request-property-default-value-changed

    • ○

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

      request-property-default-value-changed

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

      added the new turbo 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

  • 9d3ff2d98e271See the full diff
    • ○

      endpoint added

      endpoint-added