Sign in
edit-workflow

Render a fashion sketch as product photography

Converts one fashion sketch into photorealistic garment or product imagery while preserving its silhouette, construction, colors, and visible design details.

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

Supply exactly one sketch transport: an existing AssetIdentifier in sketch_asset_identifier, or raw sketch_image bytes in a multipart request. Supplying both or neither is rejected with a 400.

post/v2/tool/sketch-to-render

Request body

sketch_imagestring binary

Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported, up to 50 MB. Multipart requests only. Mutually exclusive with sketch_asset_identifier.

instructionstring required

Required material and rendering direction, plus any construction or design details that are not legible in the sketch.

aspect_ratiostring

Aspect ratio of each output image. Defaults to 1:1 when omitted.

quality'LOW' | 'MEDIUM' | 'HIGH'

The quality tier for the image edit. Higher tiers may improve detail and take longer to complete.

seedinteger

Optional seed for repeatable results.

num_imagesinteger

Number of product renders to create.

privateboolean

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.

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

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

Response

Sketch rendering accepted for asynchronous processing.

generation_idstring required

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

Example response

{
  "generation_id": "generation_id"
}

Changes