Skip to navigation

Model Pose Variants

Changes the model’s pose or camera angle in a fashion image while preserving the model, garment, styling, and scene. Upload the source_image using multipart/form-data and describe the new pose in instruction. Returns a generation_id; poll GET /v2/generations/{generation_id} or supply a webhook_url.

Authentication

Api-Keystring

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

Request

The fashion image to edit and the pose direction.
source_imagefileRequired

Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart requests only.

instructionstringRequired1-4000 characters

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

aspect_ratiostringOptionalformat: "^(1:1|3:4|4:3|16:9|9:16)$"

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.

qualityenumOptional
The quality tier for the edit. Higher tiers may improve detail and take longer to complete.
Allowed values:
seedintegerOptional0-2147483647
Optional seed for repeatable results.
num_imagesintegerOptional1-8Defaults to 1
Number of pose variants to create.
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

Pose-variant generation accepted for asynchronous processing.

generation_idstring

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

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error