Skip to navigation
Tools

Sketch to Render

Turns a fashion sketch into photorealistic garment or product imagery, preserving its silhouette, construction, colors, and design details. Upload the sketch_image using multipart/form-data and describe materials and rendering 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 source sketch and the material and rendering direction to apply.
sketch_imagefileRequired
The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests only.
instructionstringRequired1-4000 characters
Material and rendering direction, plus any construction or design details that are not legible in the sketch.
aspect_ratiostringOptionalformat: "^(1:1|3:4|4:3|16:9|9:16)$"

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

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 product renders 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

Sketch rendering 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