latestOpenAPI 3.0.22026-08-22136296577.7 KB

015774bae5bc

images-inpaint

Repaint a masked region with a consistent character with Ideogram 3.0

Repaint the masked region of a source image so it features a consistent character, 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.

Supply the character as a saved character (character_reference_collection_id), as character_reference_asset_identifiers references (an image already stored with Ideogram), or as raw character_reference_images bytes (multipart requests only, with an optional character_reference_mask marking where the character is in the reference). 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.

post/v2/images/inpaint/ideogram-v3-character

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.

character_reference_collection_idstring

A saved character to feature, by its URL-safe base64 collection id. Takes priority over character_reference_asset_identifiers and character_reference_images if more than one is supplied.

character_reference_collection_version_idstring

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

character_reference_imagesstring[]

An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied.

character_reference_maskstring binary

Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with character_reference_images.

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' | 'REALISTIC' | 'FICTION'

The style type to repaint the character with. Defaults to AUTO.

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.

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"
  },
  "character_reference_asset_identifiers": [
    {
      "asset_type": "RESPONSE",
      "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
    }
  ],
  "magic_prompt": "ON",
  "seed": 12345
}

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
}