Ideogram 4.0

Identifier for the type of task being performed

UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

Image output type.

Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.

• `JPG`: Best for photorealistic images with smaller file sizes (no transparency).
• `PNG`: Lossless compression, supports high quality and transparency (alpha channel).
• `WEBP`: Modern format providing superior compression and transparency support.

Compression quality of the output. Higher values preserve quality but increase file size.

Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.

Determines how the API delivers task results.

Specifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.

Common use cases:

• Cloud storage: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.
• CDN integration: Upload to content delivery networks for immediate distribution.

// S3 presigned URL for secure upload
https://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600

// Google Cloud Storage presigned URL
https://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789

// Custom storage endpoint
https://storage.example.com/uploads/generated-image.jpg

The content data will be sent as the request body to the specified URL when generation is complete.

Content safety checking configuration for image generation.

Time-to-live (TTL) in seconds for generated content. Only applies when outputType is URL.

Include task cost in the response.

Number of results to generate. Each result uses a different seed, producing variations of the same parameters.

Identifier of the model to use for generation.

Text prompt describing elements to include in the generated output. Automatically expanded into a structured prompt before generation.

Width of the generated media in pixels.

Height of the generated media in pixels.

Opt into post-generation copyright detection using Hive likeness and logo checks.

Generation speed/quality tradeoff.

settings.structuredPrompt is a structured prompt passed to the model directly. A natural-language positivePrompt is automatically expanded into this structured form before generation, so use settings.structuredPrompt when you want explicit control over the result. It must include compositional_deconstruction. Other fields are optional, and extra fields beyond the documented ones are accepted.

A few rules the field definitions don't capture:

• Include exactly one of art_style or photo in style_description, depending on whether the image is illustrated or photographic.
• Key order matters — keep fields in the order the model expects, as shown in the example. The style_description order also differs between photo and non-photo images.
• bbox is row-first — [ymin, xmin, ymax, xmax] on a 0–1000 top-left canvas, so build it as [top, left, bottom, right].

"settings": {
  "structuredPrompt": {
    "high_level_description": "A vintage travel poster of a coastal town at sunset.",
    "style_description": {
      "aesthetics": "Retro mid-century travel poster",
      "lighting": "Warm golden-hour glow",
      "medium": "Screen-printed poster",
      "art_style": "Flat vector illustration",
      "color_palette": ["#E8A33D", "#2E5E78", "#F2E9D8"]
    },
    "compositional_deconstruction": {
      "background": "Mediterranean harbor under a warm sunset sky with soft golden light.",
      "elements": [
        {"type": "obj", "bbox": [400, 120, 760, 880], "desc": "White sailboats moored along the stone pier"},
        {"type": "text", "bbox": [60, 100, 200, 900], "text": "VISIT THE COAST", "desc": "Bold retro headline across the top"}
      ]
    }
  }
}