{"uid":"cap_XJPodrPDp5vOhUnddm4xj","slug":"agents-vimmerse-net-vimmerse-text-to-image-7f9028dc","name":"Vimmerse Text to Image","description":"Generates one or more images from a text prompt.\n\nSend **Content-Type: application/json**. The response is an asset object; output URLs are in **`results`**.\n\n### Parameters\n\n| Field | Type | Default | Description |\n|-------|------|---------|-------------|\n| `prompt` | string | — | Text description of the desired image |\n| `quantity` | integer | `1` | Number of images (1–4) |\n| `option` | string | `AutoI` | Model/tool; `AutoI` picks automatically |\n| `aspect_ratio` | string | `16:9` | e.g. `21:9`, `16:9`, `4:3`, `1:1`, `9:16` |\n| `enhance_image` | boolean | `false` | Apply 1× super-resolution post-processing |\n| `async_mode` | boolean | `false` | Return immediately with `status: processing` |\n| `webhook_url` | string | — | Optional callback URL when complete |\n\n### Example\n\n```python\nimport requests\n\nurl = \"https://api.vimmerse.net/v2/image/text-2-image\"\nheaders = {\n    \"X-Api-Key\": \"YOUR_API_KEY\",\n    \"Content-Type\": \"application/json\",\n}\npayload = {\n    \"prompt\": \"A serene landscape with mountains and a lake at sunset, cinematic lighting\",\n    \"quantity\": 2,\n    \"option\": \"AutoI\",\n    \"aspect_ratio\": \"16:9\",\n    \"enhance_image\": False,\n    \"async_mode\": False,\n}\n\nresponse = requests.post(url, headers=headers, json=payload, timeout=300)\nresponse.raise_for_status()\nasset = response.json()\nprint(asset[\"id\"], asset[\"status\"], asset[\"results\"])\n```","url":"https://agents.vimmerse.net/v2/image/text-2-image?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"type":"object","title":"Text2ImageRequest","properties":{"option":{"enum":["AutoI","Seedream","NanoBananaT2","NanoBananaPro","QwenImage","GPTImage","FluxPro","FluxTurbo","NanoBanana","FluxKontextPro","StableDiffusion3.5"],"type":"string","title":"Option","default":"AutoI","description":"If `AutoI` is selected, one of the options will be selected automatically."},"prompt":{"type":"string","title":"Text Prompt","default":"Shot of Nike shoes on colorful background"},"quantity":{"type":"integer","title":"Quantity","default":1,"maximum":4,"minimum":1},"async_mode":{"type":"boolean","title":"Async Mode","default":false},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook URL"},"aspect_ratio":{"type":"string","title":"Aspect Ratio","default":"16:9","pattern":"^(\\d+):(\\d+)$","description":"Available values: ['21:9', '16:9', '4:3', '3:2', '1:1', '2:3', '3:4', '9:16', '9:21']"},"enhance_image":{"type":"boolean","title":"Enhance Image","default":false,"description":"Enhances the image by applying 1× super-resolution during post-processing."}},"description":"Request body for POST /v2/image/text-2-image. Content-Type: application/json."},"responseSchema":{},"example":null,"exampleRequest":null,"tags":[],"displayCostAmount":"0.12","displayCostAsset":"USD","priceDynamic":true,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"dynamic","summary":"$0.12/call (dynamic — varies by input)","primary":{"kind":"dynamic","protocol":"mpp","network":"tempo","amountUsd":"0.12","per":"call","confidence":"exact"},"accepted":[{"kind":"dynamic","protocol":"mpp","network":"tempo","amountUsd":"0.12","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_P0o919_skuYuJPt7qi2NL","protocol":"mpp","methodType":"crypto","chain":"tempo","mode":"charge","costAmount":"0.12","costPer":"request","priority":0,"asset":"0x20C000000000000000000000b9537d11c60E8b50","unit":"request","depositMicros":null,"planRef":null}],"brandName":"agents.vimmerse.net","brandSlug":"agents-vimmerse-net-x402","brandBaseUrl":"https://agents.vimmerse.net","brandDocsUrl":null,"whatItDoes":"Generates one to four images from a text prompt using selectable AI models with configurable aspect ratio and optional super-resolution enhancement.","exampleAgentPrompt":"Generate 2 images of a futuristic city skyline at dusk with neon lights, in 16:9 aspect ratio, using the FluxPro model, and apply super-resolution enhancement.","exampleUseCases":[{"title":"Social media banner image creation","prompt":"Create a vivid 16:9 image of a tropical beach at golden hour with palm trees and crystal-clear water — I want 2 versions using the FluxPro model with super-resolution turned on."},{"title":"Square product mockup generation","prompt":"Generate a 1:1 square image of a sleek pair of white sneakers on a minimalist studio background with soft shadows, using the AutoI model."},{"title":"Portrait-format story illustration","prompt":"I need a 9:16 portrait image of a fantasy forest with glowing mushrooms and a moonlit path, generate 3 variations asynchronously and send the results to https://myapp.com/webhook when they're done."}],"resultDescription":"Returns an asset object containing an asset ID, status field, and a results array with URLs pointing to the generated images. In async mode, status will be 'processing' and results will be populated once generation completes (delivered via webhook if provided).","failureModes":["Invalid or missing prompt returns a 422 validation error","Quantity outside 1–4 range returns a 422 validation error","Unsupported aspect ratio string returns a 422 validation error","Invalid model option name returns a 422 validation error","Missing or invalid API key returns a 401 unauthorized error","Webhook URL unreachable in async mode causes silent callback failure","Model-specific content policy violations may result in an empty or rejected result","Timeout on synchronous long-running generation if not using async_mode"],"whenToPreferThis":"Choose this endpoint when you need to generate one to four images from a natural language text prompt with flexible model selection (including Flux, Stable Diffusion, GPT Image, Seedream, and others), configurable aspect ratios, and optional super-resolution post-processing. It is particularly useful when you want to delegate model selection automatically (AutoI) or when you need async generation with webhook callbacks for long-running jobs. Prefer it over generic image APIs when working within the Vimmerse ecosystem that also handles video, audio, and multi-scene workflows.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-30T22:53:37.637Z","isFirstParty":false,"canonicalSlug":"agents-vimmerse-net-vimmerse-text-to-image-7f9028dc"}