platform-api

Create an image job (Idempotency-Key required): text or reference images to one image, billed per image; 202 with the image

post/v1/images

Request

  • Base URL: https://api.cuddler.ai
  • URL: https://api.cuddler.ai/v1/images
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Required. One key per logical request (e.g. ep03-shot042-take1), never reusable: the same key and body answer with the original object and Idempotent-Replayed: true; the same key with a different body is 409 (and so is any reuse once the job's request trace was removed, 180 days after it finished).

Request body

model'seedream-5' | 'seedream-5-pro' | 'qwen-image-3' | 'z-image-turbo' | 'grok-imagine-2.0' | 'ideogram-4' | 'ideogram-4.5' | 'recraft-4.1' | 'nano-banana-2.1' | 'nano-banana-2' | 'nano-banana-2-lite' | 'nano-banana-pro' | 'imagen-4-ultra' | 'imagen-4' | 'imagen-4-fast' | 'imagen-3' | 'imagen-3-fast' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-flare' | 'gpt-image-2' | 'gpt-image-1.5' | 'gpt-image-1-mini' | 'gpt-image-1' required
mode'text' | 'reference' | 'edit'
variant'default' | 'fast' | 'pro' | 'standard' | 'turbo' | '4k' | 'base' | 'utility' | 'utility-pro'
max_usdstring

Maximum USD this job may charge; creation refuses a larger hold and settlement never exceeds this ceiling

promptstring required
resolution'0.5K' | '1K' | '2K' | '4K'
aspect_ratio'1:1' | '4:3' | '3:4' | '16:9' | '9:16'
reference_imagesstring[]
seedinteger
webhook_urlstring uri
metadataobject

Response

Replay: this Idempotency-Key already created this image

object'image' required
idstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
model'seedream-5' | 'seedream-5-pro' | 'qwen-image-3' | 'z-image-turbo' | 'grok-imagine-2.0' | 'ideogram-4' | 'ideogram-4.5' | 'recraft-4.1' | 'nano-banana-2.1' | 'nano-banana-2' | 'nano-banana-2-lite' | 'nano-banana-pro' | 'imagen-4-ultra' | 'imagen-4' | 'imagen-4-fast' | 'imagen-3' | 'imagen-3-fast' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-flare' | 'gpt-image-2' | 'gpt-image-1.5' | 'gpt-image-1-mini' | 'gpt-image-1' required
promptstring required
resolution'0.5K' | '1K' | '2K' | '4K' required
aspect_ratio'1:1' | '4:3' | '3:4' | '16:9' | '9:16' required
created_atstring required
started_atstring nullable required
completed_atstring nullable required
queue_positioninteger nullable required
metadataobject required
price_versionstring required
api_key_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.