{ "openapi": "3.1.0", "info": { "title": "Runware API - Ideogram 4.0", "summary": "Open-weight design-focused text-to-image model with strong typography, layout control, transparent backgrounds, and 2K output", "description": "Ideogram 4.0 is Ideogram's most capable text-to-image model for design-heavy image generation. It is built for frontier text rendering across languages, structured prompt control through natural language or JSON, bounding-box layout control, transparent background generation, and high-fidelity 2K output. It is well suited to posters, branded graphics, packaging, product visuals, typography-led compositions, and other workflows where design precision matters as much as visual quality.", "version": "1.0.0", "x-model-id": "ideogram-4-0", "x-air-id": "ideogram:4@0", "x-status": "live", "x-creator": { "id": "ideogram", "name": "Ideogram", "logo": "https://assets.runware.ai/74d83fcd-ee79-4c06-b923-a7300ca35c17.png" }, "x-capabilities": [ "text-to-image", "checkpoint" ], "x-released-at": "2026-06-03T00:00:00Z", "x-cover-image": "https://assets.runware.ai/covers/ideogram-4-0.jpg", "x-pricing": { "overview": "Pricing is $0.03 per image for Turbo, $0.06 per image for Default, and $0.10 per image for Quality\n", "examples": [ { "price": "$0.03", "configuration": "Turbo" }, { "configuration": "Default", "price": "$0.06" }, { "configuration": "Quality", "price": "$0.10" } ] } }, "servers": [ { "url": "https://api.runware.ai/v1", "description": "Runware REST API" } ], "components": { "securitySchemes": { "apiKeyAuth": { "type": "http", "scheme": "bearer", "description": "Runware API Key (e.g., Bearer )" } }, "schemas": { "AuthenticationTask": { "title": "Authentication", "description": "Authenticates a connection using an API key. Can be sent as the first element of the request array as an alternative to using the Authorization header.", "type": "object", "x-response-schema": "https://schemas.runware.ai/responses/utilities/authentication.json", "properties": { "taskType": { "$id": "https://schemas.runware.ai/requests/parameters/api/task-type.json", "title": "Task Type", "description": "Identifier for the type of task being performed", "type": "string", "const": "authentication" }, "apiKey": { "$id": "https://schemas.runware.ai/requests/parameters/authentication/api-key.json", "title": "API Key", "description": "Your Runware API key.", "type": "string" }, "connectionSessionUUID": { "$id": "https://schemas.runware.ai/requests/parameters/authentication/connection-session-uuid.json", "title": "Connection Session UUID", "description": "Optional session UUID to resume a previous connection and receive any buffered results.", "type": "string", "format": "uuid" } }, "required": [ "taskType", "apiKey" ], "additionalProperties": false }, "RequestBody": { "type": "array", "items": { "type": "object", "properties": { "model": { "title": "Model", "description": "Identifier of the model to use for generation.", "type": "string", "const": "ideogram:4@0" }, "positivePrompt": { "title": "Positive Prompt", "description": "Text prompt describing elements to include in the generated output. Automatically expanded into a structured prompt before generation.", "type": "string", "minLength": 2 }, "width": { "title": "Width", "description": "Width of the generated media in pixels.", "type": "integer" }, "height": { "title": "Height", "description": "Height of the generated media in pixels.", "type": "integer" }, "settings": { "title": "Settings", "description": "Global inference settings.", "type": "object", "properties": { "copyrightDetection": { "type": "boolean", "title": "Copyright Detection", "description": "Opt into post-generation copyright detection using Hive likeness and logo checks." }, "renderingSpeed": { "title": "Rendering Speed", "description": "Generation speed/quality tradeoff.", "type": "string", "oneOf": [ { "const": "TURBO", "title": "Turbo", "description": "Fastest generation." }, { "const": "DEFAULT", "title": "Default", "description": "Balanced speed and quality." }, { "const": "QUALITY", "title": "Quality", "description": "Best quality." } ], "default": "DEFAULT" }, "structuredPrompt": { "type": "object", "title": "Structured Prompt", "description": "`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.\n\nA few rules the field definitions don't capture:\n\n- **Include exactly one of `art_style` or `photo`** in `style_description`, depending on whether the image is illustrated or photographic.\n- **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.\n- **`bbox` is row-first** — `[ymin, xmin, ymax, xmax]` on a 0–1000 top-left canvas, so build it as `[top, left, bottom, right]`.\n\n**Examples**:\n\n```json\n\"settings\": {\n \"structuredPrompt\": {\n \"high_level_description\": \"A vintage travel poster of a coastal town at sunset.\",\n \"style_description\": {\n \"aesthetics\": \"Retro mid-century travel poster\",\n \"lighting\": \"Warm golden-hour glow\",\n \"medium\": \"Screen-printed poster\",\n \"art_style\": \"Flat vector illustration\",\n \"color_palette\": [\"#E8A33D\", \"#2E5E78\", \"#F2E9D8\"]\n },\n \"compositional_deconstruction\": {\n \"background\": \"Mediterranean harbor under a warm sunset sky with soft golden light.\",\n \"elements\": [\n {\"type\": \"obj\", \"bbox\": [400, 120, 760, 880], \"desc\": \"White sailboats moored along the stone pier\"},\n {\"type\": \"text\", \"bbox\": [60, 100, 200, 900], \"text\": \"VISIT THE COAST\", \"desc\": \"Bold retro headline across the top\"}\n ]\n }\n }\n}\n```\n\n[Read full documentation](https://runware.ai/docs/models/ideogram-4-0#structuredPrompt)", "properties": { "compositional_deconstruction": { "type": "object", "title": "Compositional Deconstruction", "description": "Scene breakdown into background and individual elements.", "properties": { "background": { "type": "string", "title": "Background", "description": "Environment, framing, and lighting context." }, "elements": { "type": "array", "title": "Elements", "description": "Objects and text to place in the scene.", "items": { "type": "object", "properties": { "type": { "type": "string", "title": "Type", "description": "Element type. Use 'obj' for a visual object and 'text' for rendered text.", "enum": [ "obj", "text" ] }, "bbox": { "type": "array", "title": "Bounding Box", "description": "Element placement as [ymin, xmin, ymax, xmax].", "items": { "type": "integer", "minimum": 0, "maximum": 1000 }, "minItems": 4, "maxItems": 4 }, "color_palette": { "type": "array", "title": "Color Palette", "description": "Hex colors for this element.", "items": { "type": "string", "pattern": "^#[0-9A-F]{6}$" }, "maxItems": 5 }, "desc": { "type": "string", "title": "Description", "description": "Detailed description of the element." }, "text": { "type": "string", "title": "Text", "description": "Text content to render. Only applies when `type` is 'text'." } }, "additionalProperties": true } } }, "additionalProperties": true, "required": [ "elements" ] }, "high_level_description": { "type": "string", "title": "High-Level Description", "description": "One or two sentences describing the full image, including subject and style." }, "style_description": { "type": "object", "title": "Style Description", "description": "Styling guidance for the image.", "properties": { "aesthetics": { "type": "string", "title": "Aesthetics", "description": "Overall aesthetic direction." }, "art_style": { "type": "string", "title": "Art Style", "description": "Art style for non-photographic images." }, "color_palette": { "type": "array", "title": "Color Palette", "description": "Hex colors guiding the overall palette.", "items": { "type": "string", "pattern": "^#[0-9A-F]{6}$" }, "maxItems": 16 }, "lighting": { "type": "string", "title": "Lighting", "description": "Lighting setup and mood." }, "medium": { "type": "string", "title": "Medium", "description": "Artistic medium or capture format." }, "photo": { "type": "string", "title": "Photo", "description": "Photographic style for photo-realistic images." } }, "additionalProperties": true } }, "additionalProperties": true, "required": [ "compositional_deconstruction", "high_level_description" ] } }, "additionalProperties": false }, "taskType": { "title": "Task Type", "description": "Identifier for the type of task being performed", "type": "string", "const": "imageInference" }, "taskUUID": { "title": "Task UUID", "description": "UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.", "type": "string", "format": "uuid" }, "webhookURL": { "title": "Webhook URL", "description": "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.", "type": "string", "format": "uri" }, "includeCost": { "title": "Include Cost", "description": "Include task cost in the response.", "type": "boolean" }, "numberResults": { "title": "Number of Results", "description": "Number of results to generate. Each result uses a different seed, producing variations of the same parameters.", "type": "integer", "minimum": 1, "default": 1, "maximum": 20 }, "uploadEndpoint": { "title": "Upload Endpoint", "description": "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.\n\n**Common use cases:**\n\n- **Cloud storage**: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.\n- **CDN integration**: Upload to content delivery networks for immediate distribution.\n\n```text\n// S3 presigned URL for secure upload\nhttps://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600\n\n// Google Cloud Storage presigned URL\nhttps://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789\n\n// Custom storage endpoint\nhttps://storage.example.com/uploads/generated-image.jpg\n```\n\nThe content data will be sent as the request body to the specified URL when generation is complete.\n\n[Read full documentation](https://runware.ai/docs/models/ideogram-4-0#uploadEndpoint)", "type": "string", "format": "uri" }, "ttl": { "title": "TTL", "description": "Time-to-live (TTL) in seconds for generated content. Only applies when `outputType` is `URL`.", "type": "integer", "minimum": 60 }, "outputType": { "title": "Output Type", "description": "Image output type.", "type": "string", "enum": [ "URL", "base64Data", "dataURI" ], "default": "URL" }, "outputFormat": { "title": "Output Format", "description": "Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.\n\n- \\`JPG\\`: Best for photorealistic images with smaller file sizes (no transparency).\n- \\`PNG\\`: Lossless compression, supports high quality and transparency (alpha channel).\n- \\`WEBP\\`: Modern format providing superior compression and transparency support.\n- \\`MP4\\`: Widely supported video container (H.264), recommended for general use.\n- \\`WEBM\\`: Optimized for web delivery.\n- \\`MOV\\`: QuickTime format, common in professional workflows (Apple ecosystem).\n- \\`GIF\\`: Animated image format (no audio), suitable for short loops or previews.\n- \\`MP3\\`: Compressed audio, smaller file size.\n- \\`WAV\\`: Uncompressed, high-quality audio.\n- \\`FLAC\\`: Lossless compression.\n- \\`OGG\\`: Open-source compressed audio format (Vorbis codec).\n- \\`SVG\\`: Scalable Vector Graphics.\n- \\`TIFF\\`: High-quality output supporting layers.\n- \\`GLB\\`: Binary glTF format for 3D models, including geometry, textures, and PBR materials.\n\n> [!NOTE]\n> \\*\\*Transparency\\*\\*: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., \\`PNG\\`, \\`WEBP\\`, \\`TIFF\\`). \\`JPG\\` does not support transparency.\n\n[Read full documentation](https://runware.ai/docs/models/ideogram-4-0#outputFormat)", "type": "string", "enum": [ "JPG", "PNG", "WEBP" ], "default": "JPG" }, "outputQuality": { "title": "Output Quality", "description": "Compression quality of the output. Higher values preserve quality but increase file size.", "type": "integer", "minimum": 20, "maximum": 99, "default": 95 }, "deliveryMethod": { "title": "Delivery Method", "description": "Determines how the API delivers task results.", "type": "string", "oneOf": [ { "const": "sync", "description": "Returns complete results directly in the API response." }, { "const": "async", "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse." } ], "default": "sync" }, "safety": { "type": "object", "title": "Safety Settings", "description": "Content safety checking configuration for image generation.", "properties": { "checkContent": { "title": "Check Content", "description": "Enable or disable content safety checking.", "type": "boolean" } }, "additionalProperties": false }, "watermark": { "title": "Watermark", "description": "Configuration object for adding watermarks to generated videos. Watermarks can be applied using either text or image content with customizable positioning and appearance. You must provide either `text` or `image` content for the watermark, but not both.\n\n**Text watermark**:\n\n```json\n\"advancedFeatures\": {\n \"watermark\": {\n \"text\": \"© 2025 Company\",\n \"displayPosition\": \"bottom-right\",\n \"opacity\": 0.6,\n \"fontColor\": \"#ffffff\",\n \"bgColor\": \"#000000\"\n }\n}\n```\n\n**Image watermark**:\n\n```json\n\"advancedFeatures\": {\n \"watermark\": {\n \"image\": \"c64351d5-4c59-42f7-95e1-eace013eddab\",\n \"displayPosition\": \"top-left\",\n \"opacity\": 0.6\n }\n}\n```\n\n**Tiled watermark**:\n\n```json\n\"advancedFeatures\": {\n \"watermark\": {\n \"text\": \"PREVIEW\",\n \"tiled\": true,\n \"opacity\": 0.4,\n \"fontColor\": \"#cccccc\"\n }\n}\n```\n\n[Read full documentation](https://runware.ai/docs/models/ideogram-4-0#watermark)", "type": "object", "properties": { "text": { "title": "Watermark Text", "description": "Watermark text.", "type": "string", "minLength": 2, "maxLength": 32 }, "image": { "title": "Watermark Image", "description": "Watermark image (UUID, URL, Data URI, or Base64).", "type": "string", "anyOf": [ { "format": "uuid" }, { "format": "uri" }, { "pattern": "^data:image\\/[a-zA-Z]+;base64,[a-zA-Z0-9+/=]+$" }, { "pattern": "^[a-zA-Z0-9+/=]+$" } ] }, "displayPosition": { "title": "Display Position", "description": "Watermark position.", "type": "string", "enum": [ "top-left", "top-center", "top-right", "center-left", "center-center", "center-right", "bottom-left", "bottom-center", "bottom-right" ] }, "tiled": { "title": "Watermark Tiled", "description": "Enable tiled watermark.", "type": "boolean" }, "opacity": { "title": "Watermark Opacity", "description": "Watermark opacity.", "type": "number", "multipleOf": 0.01, "minimum": 0.1, "maximum": 1 }, "fontColor": { "title": "Font Color", "description": "Text color in hex format.", "type": "string", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" }, "bgColor": { "title": "Background Color", "description": "Background color in hex format.", "type": "string", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" } }, "oneOf": [ { "required": [ "text" ] }, { "required": [ "image" ] } ], "additionalProperties": false } }, "allOf": [ { "dependentRequired": { "width": [ "height" ], "height": [ "width" ] } }, { "if": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] }, "then": { "required": [ "width", "height" ], "oneOf": [ { "title": "2K (1:1)", "properties": { "width": { "const": 2048 }, "height": { "const": 2048 } } }, { "title": "2K (1:2)", "properties": { "width": { "const": 1440 }, "height": { "const": 2880 } } }, { "title": "2K (2:1)", "properties": { "width": { "const": 2880 }, "height": { "const": 1440 } } }, { "title": "2K (2:3)", "properties": { "width": { "const": 1664 }, "height": { "const": 2496 } } }, { "title": "2K (3:2)", "properties": { "width": { "const": 2496 }, "height": { "const": 1664 } } }, { "title": "2K (4:5)", "properties": { "width": { "const": 1792 }, "height": { "const": 2240 } } }, { "title": "2K (5:4)", "properties": { "width": { "const": 2240 }, "height": { "const": 1792 } } }, { "title": "2K (9:16)", "properties": { "width": { "const": 1440 }, "height": { "const": 2560 } } }, { "title": "2K (16:9)", "properties": { "width": { "const": 2560 }, "height": { "const": 1440 } } }, { "title": "2K (5:8)", "properties": { "width": { "const": 1600 }, "height": { "const": 2560 } } }, { "title": "2K (8:5)", "properties": { "width": { "const": 2560 }, "height": { "const": 1600 } } }, { "title": "2K (3:4)", "properties": { "width": { "const": 1728 }, "height": { "const": 2304 } } }, { "title": "2K (4:3)", "properties": { "width": { "const": 2304 }, "height": { "const": 1728 } } }, { "title": "2K (9:22)", "properties": { "width": { "const": 1296 }, "height": { "const": 3168 } } }, { "title": "2K (22:9)", "properties": { "width": { "const": 3168 }, "height": { "const": 1296 } } }, { "title": "2K (9:23)", "properties": { "width": { "const": 1152 }, "height": { "const": 2944 } } }, { "title": "2K (23:9)", "properties": { "width": { "const": 2944 }, "height": { "const": 1152 } } }, { "title": "2K (3:8)", "properties": { "width": { "const": 1248 }, "height": { "const": 3328 } } }, { "title": "2K (8:3)", "properties": { "width": { "const": 3328 }, "height": { "const": 1248 } } }, { "title": "2K (5:12)", "properties": { "width": { "const": 1280 }, "height": { "const": 3072 } } }, { "title": "2K (12:5)", "properties": { "width": { "const": 3072 }, "height": { "const": 1280 } } }, { "title": "2K (1:3)", "properties": { "width": { "const": 1024 }, "height": { "const": 3072 } } }, { "title": "2K (3:1)", "properties": { "width": { "const": 3072 }, "height": { "const": 1024 } } } ] } }, { "oneOf": [ { "required": [ "positivePrompt" ] }, { "properties": { "settings": { "required": [ "structuredPrompt" ] } }, "required": [ "settings" ] } ] } ], "additionalProperties": false, "required": [ "taskType", "taskUUID", "model" ] }, "description": "You must always POST an array of task objects." }, "ResponseBody": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "description": "Unknown response structure" } } } }, "ErrorResponse": { "title": "Error Response", "description": "Standard error response returned by the Runware API.", "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "additionalProperties": true, "properties": { "code": { "type": "string", "description": "A short identifier for the error (e.g., invalidApiKey, timeoutProvider)." }, "message": { "type": "string", "description": "A human-readable explanation of what went wrong." }, "parameter": { "type": "string", "description": "The request parameter related to the error, if applicable." }, "taskType": { "type": "string", "description": "The task type of the request that failed." }, "taskUUID": { "type": "string", "description": "The unique identifier of the failed request." }, "documentation": { "type": "string", "description": "A link to relevant documentation." } } } } }, "required": [ "errors" ], "additionalProperties": false } } }, "paths": { "/": { "post": { "summary": "Run Ideogram 4.0", "description": "Ideogram 4.0 is Ideogram's most capable text-to-image model for design-heavy image generation. It is built for frontier text rendering across languages, structured prompt control through natural language or JSON, bounding-box layout control, transparent background generation, and high-fidelity 2K output. It is well suited to posters, branded graphics, packaging, product visuals, typography-led compositions, and other workflows where design precision matters as much as visual quality.", "operationId": "run_ideogram_4_0", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBody" } } } }, "400": { "description": "Bad Request — Missing or invalid parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized — No valid API key provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "Payment Required — Insufficient account balance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden — The API key lacks permissions for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests — Rate limit exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server Error — Something went wrong on Runware's end.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable — Temporarily unavailable (maintenance or capacity).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "security": [ { "apiKeyAuth": [] } ] }