{ "openapi": "3.1.0", "info": { "title": "Runware API - HunyuanImage-3.0", "summary": "Open‑source 80B MoE text to image model by Tencent", "description": "HunyuanImage-3.0 is an 80B parameter MoE model for high fidelity text to image generation. It uses an autoregressive multimodal framework for strong world knowledge reasoning and sharp text rendering. It targets complex long prompts and precise layout control for production workloads.", "version": "1.0.0", "x-model-id": "tencent-hunyuanimage-3-0", "x-air-id": "runware:180@1", "x-status": "live", "x-capabilities": [ "text-to-image" ], "x-released-at": "2025-09-28T00:00:00.000Z", "x-cover-image": "https://assets.runware.ai/38e8834c-e87e-496b-9ee8-bfda62c742bc.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": "runware:180@1" }, "positivePrompt": { "title": "Positive Prompt", "description": "Text prompt describing elements to include in the generated output.", "type": "string", "minLength": 2, "maxLength": 3000 }, "negativePrompt": { "title": "Negative Prompt", "description": "Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1).", "type": "string", "minLength": 2, "maxLength": 3000 }, "width": { "title": "Width", "description": "Width of the generated media in pixels.", "type": "integer", "default": 1024, "multipleOf": 16 }, "height": { "title": "Height", "description": "Height of the generated media in pixels.", "type": "integer", "default": 1024, "multipleOf": 16 }, "seed": { "title": "Seed", "description": "Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range.", "type": "integer", "minimum": 0, "maximum": 9223372036854776000 }, "steps": { "title": "Steps", "description": "Total number of denoising steps. Higher values generally produce more detailed results but take longer.", "type": "integer", "minimum": 1, "default": 20, "maximum": 100 }, "scheduler": { "title": "Scheduler", "description": "Scheduler to use for the diffusion process.", "type": "string", "enum": [ "DDIM", "DDIMScheduler", "DDPMScheduler", "DEISMultistepScheduler", "Default", "DPM++", "DPM++ 2M", "DPM++ 2M Beta", "DPM++ 2M Exponential", "DPM++ 2M Karras", "DPM++ 2M SDE", "DPM++ 2M SDE Beta", "DPM++ 2M SDE Exponential", "DPM++ 2M SDE Karras", "DPM++ 2M SDE Uniform", "DPM++ 2M Uniform", "DPM++ 3M", "DPM++ 3M Beta", "DPM++ 3M Exponential", "DPM++ 3M Karras", "DPM++ 3M SDE Uniform", "DPM++ 3M Uniform", "DPM++ Beta", "DPM++ Exponential", "DPM++ Karras", "DPM++ SDE", "DPM++ SDE Beta", "DPM++ SDE Exponential", "DPM++ SDE Karras", "DPM++ Uniform", "DPM++ Uniform Beta", "DPM++ Uniform Exponential", "DPM++ Uniform Karras", "DPMSolverMultistepInverse", "DPMSolverMultistepScheduler", "DPMSolverSinglestepScheduler", "EDMDPMSolverMultistepScheduler", "EDMEulerScheduler", "Euler", "Euler a", "Euler Beta", "Euler DiscreteScheduler", "Euler Exponential", "Euler Karras", "EulerAncestralDiscreteScheduler", "FlowMatchEulerDiscreteScheduler", "Heun", "HeunDiscreteScheduler", "Heun Karras", "IPNDMScheduler", "IPNDM Uniform", "IPNDM Uniform Beta", "IPNDM Uniform Exponential", "IPNDM Uniform Karras", "KDPM2AncestralDiscreteScheduler", "KDPM2DiscreteScheduler", "LCM", "LCMScheduler", "LMS", "LMSDiscreteScheduler", "LMS Karras", "PNDMScheduler", "TCDScheduler", "UniPC", "UniPC 2M", "UniPC 2M Karras", "UniPC 2M Uniform", "UniPC 3M", "UniPC 3M Karras", "UniPC 3M Uniform", "UniPC Karras", "UniPC Uniform", "UniPC Uniform Beta", "UniPC Uniform Exponential", "UniPC Uniform Karras" ] }, "CFGScale": { "title": "CFG Scale", "description": "Guidance scale representing how closely the output will resemble the prompt. Higher values produce results more aligned with the prompt.", "type": "number", "multipleOf": 0.01, "minimum": 1.1, "default": 7, "maximum": 50 }, "acceleration": { "title": "Acceleration Option", "description": "Optimization level.", "type": "string", "enum": [ "none", "high" ], "default": "medium" }, "acceleratorOptions": { "title": "Accelerator Options", "description": "Advanced caching mechanisms to speed up generation.", "type": "object", "properties": { "cacheEndStep": { "title": "Cache End Step", "description": "Absolute step number to end caching. Must be greater than `cacheStartStep` and less than or equal to `steps`.", "type": "integer", "minimum": 1 }, "cacheEndStepPercentage": { "title": "Cache End Step Percentage", "description": "Percentage of steps to end caching. Alternative to `cacheEndStep`. Must be greater than `cacheStartStepPercentage`.", "type": "integer", "minimum": 1, "maximum": 100 }, "cacheMaxConsecutiveSteps": { "title": "Cache Max Consecutive Steps", "description": "Limits the maximum number of consecutive steps that can use cached computations before forcing a fresh computation.", "type": "integer", "minimum": 1, "maximum": 5, "default": 3 }, "cacheStartStep": { "title": "Cache Start Step", "description": "Absolute step number to start caching. Must be less than `cacheEndStep`.", "type": "integer", "minimum": 0 }, "cacheStartStepPercentage": { "title": "Cache Start Step Percentage", "description": "Percentage of steps to start caching. Alternative to `cacheStartStep`. Must be less than `cacheEndStepPercentage`.", "type": "integer", "minimum": 0, "maximum": 99 }, "fbCache": { "title": "FB Cache", "description": "First Block Cache (FBCache) acceleration. Reuses feature block computations across steps.", "type": "boolean", "default": false }, "fbCacheThreshold": { "title": "FB Cache Threshold", "description": "Controls the sensitivity threshold for determining when to reuse cached computations. Lower values reuse more aggressively.", "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 1, "default": 0.25 }, "teaCache": { "title": "TeaCache", "description": "TeaCache acceleration for transformer-based models. Estimates step differences to skip redundant computations.", "type": "boolean", "default": false }, "teaCacheDistance": { "title": "TeaCache Distance", "description": "Controls the aggressiveness of the TeaCache feature. Lower values prioritize quality, higher values prioritize speed.", "type": "number", "multipleOf": 0.01, "minimum": 0, "maximum": 1, "default": 0.5 } }, "allOf": [ { "not": { "required": [ "cacheStartStep", "cacheStartStepPercentage" ] } }, { "not": { "required": [ "cacheEndStep", "cacheEndStepPercentage" ] } } ], "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/tencent-hunyuanimage-3-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\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/tencent-hunyuanimage-3-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. 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", "taskType", "taskUUID", "model" ], "allOf": [ { "dependentRequired": { "width": [ "height" ], "height": [ "width" ] } }, { "oneOf": [ { "title": "1K (3:1)", "properties": { "width": { "const": 1536 }, "height": { "const": 512 } } }, { "title": "1K (23:9)", "properties": { "width": { "const": 1472 }, "height": { "const": 576 } } }, { "title": "1K (11:5)", "properties": { "width": { "const": 1408 }, "height": { "const": 640 } } }, { "title": "1K (21:11)", "properties": { "width": { "const": 1344 }, "height": { "const": 704 } } }, { "title": "1K (5:3)", "properties": { "width": { "const": 1280 }, "height": { "const": 768 } } }, { "title": "1K (19:13)", "properties": { "width": { "const": 1216 }, "height": { "const": 832 } } }, { "title": "1K (9:7)", "properties": { "width": { "const": 1152 }, "height": { "const": 896 } } }, { "title": "1K (17:15)", "properties": { "width": { "const": 1088 }, "height": { "const": 960 } } }, { "title": "1K (1:1)", "properties": { "width": { "const": 1024 }, "height": { "const": 1024 } } }, { "title": "1K (15:17)", "properties": { "width": { "const": 960 }, "height": { "const": 1088 } } }, { "title": "1K (7:9)", "properties": { "width": { "const": 896 }, "height": { "const": 1152 } } }, { "title": "1K (13:19)", "properties": { "width": { "const": 832 }, "height": { "const": 1216 } } }, { "title": "1K (3:5)", "properties": { "width": { "const": 768 }, "height": { "const": 1280 } } }, { "title": "1K (11:21)", "properties": { "width": { "const": 704 }, "height": { "const": 1344 } } }, { "title": "1K (5:11)", "properties": { "width": { "const": 640 }, "height": { "const": 1408 } } }, { "title": "1K (9:23)", "properties": { "width": { "const": 576 }, "height": { "const": 1472 } } }, { "title": "1K (1:3)", "properties": { "width": { "const": 512 }, "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 HunyuanImage-3.0", "description": "HunyuanImage-3.0 is an 80B parameter MoE model for high fidelity text to image generation. It uses an autoregressive multimodal framework for strong world knowledge reasoning and sharp text rendering. It targets complex long prompts and precise layout control for production workloads.", "operationId": "run_tencent_hunyuanimage_3_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": [] } ] }