Sign in
latestOpenAPI 3.0.22026-08-22136296577.7 KB

015774bae5bc

edit-workflow

Generate pose variants of a fashion image

Changes the model's pose or camera presentation while preserving the source model, garment, styling, and scene. An optional pose-reference image supplies body pose and gaze only; it does not supply identity, clothing, or styling.

The request is processed asynchronously. Poll GET /v1/generations/{generation_id} with the returned generation_id until the generation is completed or failed.

Supply the source as either an AssetIdentifier reference (source_asset_identifier) or raw image bytes (source_image, multipart requests only). Provide exactly one source form; supplying both, or neither, is rejected with a 400.

post/v2/workflow/model-pose-variants

Request body

source_imagestring binary

Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart requests only. Provide exactly one of source_asset_identifier or source_image.

instructionstring required

Required plain-language pose or camera direction, such as a front-facing catalog stance or right-facing walking profile.

aspect_ratiostring

Output aspect ratio. When omitted, the nearest supported ratio is derived from the source image. Supported values are 1:1, 3:4, 4:3, 16:9, and 9:16.

seedinteger

Optional seed for repeatable results.

num_imagesinteger

Number of pose variants to create.

privateboolean

If true, the user is requesting private generation. If omitted, this defaults to the user's plan entitlement. Enterprise generations are always private.

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

{
  "source_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "pose_reference_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "webhook_url": "https://api.example.com/webhooks/ideogram"
}

Response

Pose-variant generation accepted for asynchronous processing.

generation_idstring required

URL-safe base64 ID accepted by the generation polling endpoint.

Example response

{
  "generation_id": "generation_id"
}