{ "openapi": "3.1.0", "info": { "title": "Runware API - GPT Image 1", "summary": "GPT Image 1 high fidelity image generation for GPT-4o", "description": "GPT Image 1 is OpenAI’s native GPT 4o image model. It creates detailed visuals from text prompts. It supports diverse styles and precise layouts. It can edit existing images with masks. It renders readable text in scenes. It suits design tools and production workflows.", "version": "1.0.0", "x-model-id": "openai-gpt-image-1", "x-air-id": "openai:1@1", "x-status": "live", "x-creator": { "id": "openai", "name": "OpenAI", "logo": "https://assets.runware.ai/45bf4bd1-b10a-4da4-9f8b-c08c5d7aed2d.png" }, "x-capabilities": [ "text-to-image", "image-to-image", "image-editing" ], "x-released-at": "2025-03-25T00:00:00Z", "x-cover-image": "https://assets.runware.ai/9d6e21d5-1dc5-43e0-ace7-c26e74cb506c.jpg" }, "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": { "const": "authentication", "title": "Task Type", "description": "The type of task to perform." }, "apiKey": { "title": "API Key", "description": "Your Runware API key.", "type": "string" }, "connectionSessionUUID": { "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": "openai:1@1" }, "inputs": { "title": "Inputs", "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.", "type": "object", "properties": { "referenceImages": { "title": "Reference Images", "description": "List of reference images (UUID, URL, Data URI, or Base64).", "type": "array", "minItems": 1, "items": { "title": "Image", "description": "Image input (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+/=]+$" } ] }, "maxItems": 16 } }, "additionalProperties": false }, "positivePrompt": { "title": "Positive Prompt", "description": "Text prompt describing elements to include in the generated output.", "type": "string", "minLength": 1, "maxLength": 32000 }, "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" }, "providerSettings": { "title": "Provider Settings", "description": "Provider-specific configuration settings.", "type": "object", "properties": { "openai": { "title": "OpenAI Settings", "description": "Provider-specific settings for OpenAI.", "type": "object", "properties": { "background": { "title": "Background", "description": "Background handling in generated images.", "type": "string", "oneOf": [ { "const": "auto", "description": "Automatically determines the most appropriate background based on content." }, { "const": "opaque", "description": "Solid background, no transparency." }, { "const": "transparent", "description": "Transparent background areas where applicable." } ], "default": "auto" }, "quality": { "title": "Quality", "description": "Image quality level.", "type": "string", "oneOf": [ { "const": "auto", "description": "Automatically selects optimal quality based on context." }, { "const": "high", "description": "Maximum quality with enhanced detail and refinement." }, { "const": "medium", "description": "Balanced quality suitable for most use cases." }, { "const": "low", "description": "Faster generation with acceptable quality for rapid iteration." } ], "default": "auto" } }, "additionalProperties": false } }, "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", "default": false }, "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/openai-gpt-image-1#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\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/openai-gpt-image-1#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. When enabled, defaults to `fast` mode.", "type": "boolean", "default": false }, "mode": { "description": "Safety checking mode for image generation.", "type": "string", "oneOf": [ { "const": "none", "title": "None", "description": "Disables checking." }, { "const": "fast", "title": "Fast", "description": "Performs a single check." } ], "default": "none" } }, "additionalProperties": false } }, "required": [ "positivePrompt", "width", "height", "taskType", "taskUUID", "model" ], "allOf": [ { "dependentRequired": { "width": [ "height" ], "height": [ "width" ] } }, { "oneOf": [ { "title": "1K (1:1)", "properties": { "width": { "const": 1024 }, "height": { "const": 1024 } } }, { "title": "1K (3:2)", "properties": { "width": { "const": 1536 }, "height": { "const": 1024 } } }, { "title": "1K (2:3)", "properties": { "width": { "const": 1024 }, "height": { "const": 1536 } } } ] } ], "additionalProperties": false }, "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 GPT Image 1", "description": "GPT Image 1 is OpenAI’s native GPT 4o image model. It creates detailed visuals from text prompts. It supports diverse styles and precise layouts. It can edit existing images with masks. It renders readable text in scenes. It suits design tools and production workflows.", "operationId": "run_openai_gpt_image_1", "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": [] } ] }