{ "openapi": "3.1.0", "info": { "title": "Runware API - Ideogram Vector 1.0", "summary": "Scalable, editable SVG artwork from text prompts or existing images", "description": "Ideogram Vector 1.0 is Ideogram's vector model, generating SVG artwork from text prompts, optionally guided by up to five reference images, and converting existing images into SVG. Each shape stays editable, so colors can be matched to a brand and individual elements refined in a vector editor. It suits logos, typography, illustrations, print designs, and labels or stickers.", "version": "1.0.0", "x-model-id": "ideogram-vector-1-0", "x-air-id": "ideogram:vector@1.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", "image-to-image", "vectorize", "checkpoint" ], "x-modes": [ { "id": "text", "inputs": [] }, { "id": "image", "inputs": [ "image" ] }, { "id": "reference-images", "inputs": [ "referenceImages" ] } ], "x-released-at": "2026-10-22T00:00:00Z", "x-cover-image": "https://assets.runware.ai/covers/ideogram-vector-1-0.jpg", "x-examples": "https://runware.ai/docs/models/ideogram-vector-1-0/examples.json", "x-pricing": { "currency": "USD", "docs": "https://runware.ai/docs/models-api/pricing", "rates": [ { "amount": 0.13, "unit": "output", "label": "Text to vector · Low", "display": "$0.13 per image" }, { "amount": 0.16, "unit": "output", "label": "Text to vector · Medium", "display": "$0.16 per image" }, { "amount": 0.2, "unit": "output", "label": "Text to vector · High", "display": "$0.20 per image" }, { "amount": 0.32, "unit": "output", "label": "Text to vector · High · Reference images", "display": "$0.32 per image" }, { "amount": 0.1, "unit": "output", "label": "Image to vector", "display": "$0.10 per image" } ], "examples": [ { "id": "steam-fire-engine-coloring-plate", "configuration": "vectorize", "price": 0.1, "latencyMs": 15555 }, { "id": "vaccine-carrier-field-lifestyle-vector", "configuration": "vectorize", "price": 0.1, "latencyMs": 9204 }, { "id": "cave-robotics-logo-vectorization", "configuration": "reference-to-vector · 1536×2048", "price": 0.16, "latencyMs": 41245 }, { "id": "mycelium-acoustics-brand-logo", "configuration": "text-to-vector · 2048×2048 · quality high", "price": 0.2, "latencyMs": 45147 }, { "id": "water-smart-yard-rebate-campaign", "configuration": "text-to-vector · 2048×2048 · quality high", "price": 0.2, "latencyMs": 71679 } ] } }, "externalDocs": { "description": "Ideogram Vector 1.0 on Runware", "url": "https://runware.ai/docs/models/ideogram-vector-1-0" }, "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": { "title": "Task Type", "description": "Identifier for the type of task being performed.", "type": "string", "const": "authentication" }, "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", "x-constraints": [ { "operation": "fileSize", "parameters": [ "inputs.image", "inputs.referenceImages" ], "maximum": 20971520, "scope": "each" }, { "operation": "fileFormat", "parameters": [ "inputs.image" ], "allowed": [ "jpg", "png", "webp" ] }, { "operation": "fileFormat", "parameters": [ "inputs.referenceImages" ], "allowed": [ "jpg", "png", "webp", "gif" ] }, { "operation": "ratio", "parameters": [ "inputs.referenceImages" ], "minimum": 0.1666, "maximum": 6, "scope": "each" } ], "properties": { "model": { "title": "Model", "description": "Send `auto` instead of an AIR identifier to have the model router choose the model for this task. The rest of the request is unchanged, every value you send is kept, and only the parameters you leave out are filled in. See [Model Router](https://runware.ai/docs/models-api/model-router).\n\n[Read full documentation](https://runware.ai/docs/models/ideogram-vector-1-0#model)", "type": "string", "const": "ideogram:vector@1.0" }, "inputs": { "title": "Inputs", "description": "Input assets for the task.", "type": "object", "properties": { "image": { "title": "Image", "description": "Image input (UUID, URL, Data URI, or Base64). Converted to SVG at its own dimensions, scaled down to 2048 pixels on the long side when larger.", "type": "string", "anyOf": [ { "format": "uuid" }, { "format": "uri" }, { "pattern": "^data:image\\/[a-zA-Z]+;base64,[a-zA-Z0-9+/=]+$" }, { "pattern": "^[a-zA-Z0-9+/=]+$" } ] }, "referenceImages": { "title": "Reference Images", "description": "List of reference images (UUID, URL, Data URI, or Base64). The first image sets the aspect ratio when `width` and `height` are omitted.", "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": 5 } }, "additionalProperties": false }, "positivePrompt": { "title": "Positive Prompt", "description": "Text prompt describing elements to include in the generated output.", "type": "string", "minLength": 1, "maxLength": 9500 }, "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": { "mode": { "type": "string", "title": "Mode", "description": "Level of detail in the conversion.", "oneOf": [ { "description": "Fewer, simpler shapes.", "const": "simple" }, { "description": "Keeps fine detail.", "const": "detailed" }, { "description": "Picks the level of detail for each image.", "const": "auto" } ] }, "quality": { "title": "Quality", "description": "Rendering quality.", "type": "string", "enum": [ "low", "medium", "high" ], "default": "medium" } }, "additionalProperties": false }, "taskType": { "title": "Task Type", "description": "Identifier for the type of task being performed.", "type": "string", "const": "vectorize" }, "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": "Webhook URL that receives JSON responses 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" }, "routing": { "title": "Routing", "description": "Model router options. Only read when `model` is `auto`, and never sent to the model.", "type": "object", "properties": { "preferences": { "title": "Preferences", "description": "Relative importance of each dimension when models are compared. Weights, not thresholds.", "type": "object", "properties": { "quality": { "title": "Weight", "description": "Importance of one dimension. `0` leaves it out of the decision.", "type": "integer", "minimum": 0, "maximum": 5 }, "speed": { "title": "Weight", "description": "Importance of one dimension. `0` leaves it out of the decision.", "type": "integer", "minimum": 0, "maximum": 5 }, "cost": { "title": "Weight", "description": "Importance of one dimension. `0` leaves it out of the decision.", "type": "integer", "minimum": 0, "maximum": 5 } }, "additionalProperties": false }, "maxPrice": { "title": "Max Price", "description": "Upper bound on what this request may cost, in USD. A model whose cost cannot be bounded is not chosen.", "type": "number", "minimum": 0 }, "requirements": { "title": "Requirements", "description": "Conditions the result has to meet, in plain words, such as a style or a feature. A model that cannot meet them is not chosen. Output size is set with width and height rather than described here.", "type": "string", "maxLength": 3000 } }, "additionalProperties": false }, "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-vector-1-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-vector-1-0#outputFormat)", "type": "string", "enum": [ "SVG" ], "default": "SVG" }, "deliveryMethod": { "title": "Delivery Method", "description": "Determines how the API delivers task results.", "type": "string", "oneOf": [ { "const": "sync", "description": "Returns results directly in the API response. Over HTTP, a task still running after 120 seconds continues as an async task and comes back with status 'processing'. Poll for its results using getResponse." }, { "const": "async", "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse." } ], "default": "sync" } }, "allOf": [ { "dependentRequired": { "width": [ "height" ], "height": [ "width" ] } }, { "not": { "allOf": [ { "required": [ "positivePrompt" ] }, { "properties": { "settings": { "required": [ "mode" ] } }, "required": [ "settings" ] } ] } }, { "if": { "properties": { "inputs": { "required": [ "image" ] } }, "required": [ "inputs" ] }, "then": { "not": { "anyOf": [ { "properties": { "inputs": { "required": [ "referenceImages" ] } }, "required": [ "inputs" ] }, { "properties": { "settings": { "required": [ "quality" ] } }, "required": [ "settings" ] }, { "required": [ "width" ] }, { "required": [ "height" ] } ] } } }, { "if": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] }, "then": { "oneOf": [ { "title": "2K (~1:3)", "properties": { "width": { "const": 683 }, "height": { "const": 2048 } } }, { "title": "2K (1:2)", "properties": { "width": { "const": 1024 }, "height": { "const": 2048 } } }, { "title": "2K (9:16)", "properties": { "width": { "const": 1152 }, "height": { "const": 2048 } } }, { "title": "2K (10:16)", "properties": { "width": { "const": 1280 }, "height": { "const": 2048 } } }, { "title": "2K (~2:3)", "properties": { "width": { "const": 1365 }, "height": { "const": 2048 } } }, { "title": "2K (3:4)", "properties": { "width": { "const": 1536 }, "height": { "const": 2048 } } }, { "title": "2K (~4:5)", "properties": { "width": { "const": 1638 }, "height": { "const": 2048 } } }, { "title": "2K (1:1)", "properties": { "width": { "const": 2048 }, "height": { "const": 2048 } } }, { "title": "2K (~5:4)", "properties": { "width": { "const": 2048 }, "height": { "const": 1638 } } }, { "title": "2K (4:3)", "properties": { "width": { "const": 2048 }, "height": { "const": 1536 } } }, { "title": "2K (~3:2)", "properties": { "width": { "const": 2048 }, "height": { "const": 1365 } } }, { "title": "2K (16:10)", "properties": { "width": { "const": 2048 }, "height": { "const": 1280 } } }, { "title": "2K (16:9)", "properties": { "width": { "const": 2048 }, "height": { "const": 1152 } } }, { "title": "2K (2:1)", "properties": { "width": { "const": 2048 }, "height": { "const": 1024 } } }, { "title": "2K (~3:1)", "properties": { "width": { "const": 2048 }, "height": { "const": 683 } } } ] } }, { "oneOf": [ { "required": [ "positivePrompt" ] }, { "properties": { "inputs": { "required": [ "image" ] } }, "required": [ "inputs" ] } ] } ], "additionalProperties": false, "required": [ "taskType", "taskUUID", "model" ] }, "description": "You must always POST an array of task objects." }, "ResponseBody": { "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Vectorize Response", "type": "object", "additionalProperties": false, "properties": { "taskType": { "title": "Task Type", "description": "Identifier for the type of task this response belongs to.", "type": "string", "const": "vectorize" }, "taskUUID": { "title": "Task UUID", "description": "UUID v4 identifier echoed from the original request, used to match async responses to their tasks.", "type": "string", "format": "uuid" }, "cost": { "title": "Cost", "description": "Task cost in USD. Present when `includeCost` is set to `true` in the request.", "type": "number" }, "imageUUID": { "title": "Image UUID", "description": "UUID of the output image.", "type": "string", "format": "uuid" }, "imageURL": { "title": "Image URL", "description": "URL of the output image.", "type": "string", "format": "uri" }, "imageBase64Data": { "title": "Image Base64 Data", "description": "Base64-encoded image data.", "type": "string" }, "imageDataURI": { "title": "Image Data URI", "description": "Data URI of the output image.", "type": "string", "format": "uri" } }, "required": [ "taskType", "taskUUID", "imageUUID" ] } } } }, "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 Vector 1.0", "description": "Ideogram Vector 1.0 is Ideogram's vector model, generating SVG artwork from text prompts, optionally guided by up to five reference images, and converting existing images into SVG. Each shape stays editable, so colors can be matched to a brand and individual elements refined in a vector editor. It suits logos, typography, illustrations, print designs, and labels or stickers.", "operationId": "run_ideogram_vector_1_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": [] } ] }