{"uid":"cap_Gv7HfM5WZ79NXKwdfn8Jp","slug":"agents-vimmerse-net-vimmerse-generate-text-prompt-38e99235","name":"Vimmerse Generate Text Prompt","description":"Generates or transforms prompt text.\n\n| Field | Notes |\n|-------|--------|\n| `option` | `InspireMe` (default), `Image2Prompt`, `SuggestPrompt`, `RefinePrompt` |\n| `image_url` | Primary image for vision options |\n| `image2_url` | Optional second image |\n| `video_url` | Uses middle frame when no `image_url` |\n| `prompt` | Seed text; required for `RefinePrompt` behavior via `option` |\n| `mode` | `scene`, `video`, `image`, or `audio` |\n\n```python\nimport requests\n\nr = requests.post(\n    \"https://api.vimmerse.net/v2/text/prompt\",\n    headers={\"X-Api-Key\": \"YOUR_API_KEY\", \"Content-Type\": \"application/json\"},\n    json={\n        \"image_url\": \"https://media.vimmerse.net/example/product.jpg\",\n        \"option\": \"Image2Prompt\",\n        \"mode\": \"image\",\n    },\n    timeout=120,\n)\nr.raise_for_status()\nprint(r.json())  # JSON string value\n```","url":"https://agents.vimmerse.net/v2/text/prompt?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"type":"object","title":"GeneratePromptRequest","properties":{"mode":{"type":"string","title":"Mode","default":"scene","examples":["scene","video","image","audio"],"description":"Refinement mode."},"option":{"type":"string","title":"Option","default":"InspireMe","description":"`Image2Prompt` — describe image; `SuggestPrompt` — creative suggestion; `RefinePrompt` — improve `prompt`; `InspireMe` — auto from inputs."},"prompt":{"type":"string","title":"Prompt","default":"","description":"Seed or instruction text."},"image_url":{"type":"string","title":"Base image URL","default":""},"video_url":{"type":"string","title":"Video URL","default":"","description":"Middle frame is extracted and used like an image when no image_url is set."},"image2_url":{"type":"string","title":"Second image URL (optional)","default":""}},"description":"Request body for POST /v2/text/prompt."},"responseSchema":{"type":"string","title":"Response Get Prompt V2 Text Prompt Post"},"example":null,"exampleRequest":null,"tags":[],"displayCostAmount":"0.000000","displayCostAsset":"USD","priceDynamic":false,"priceHint":null,"priceStatus":"unknown_unparsed","priceSource":"registry","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":"unknown","summary":"price unknown","primary":{"kind":"unknown","protocol":"mpp","network":"tempo","amountUsd":null,"per":"call","confidence":"unknown"},"accepted":[{"kind":"unknown","protocol":"mpp","network":"tempo","amountUsd":null,"per":"call","confidence":"unknown"}]},"paymentMethods":[{"uid":"pm_4Qgrm41ywp3a9YZVSX7Kc","protocol":"mpp","methodType":"crypto","chain":"tempo","mode":"charge","costAmount":"0.000000","costPer":"request","priority":0,"asset":null,"unit":"request","depositMicros":null,"planRef":null}],"brandName":"agents.vimmerse.net","brandSlug":"agents-vimmerse-net-x402","brandBaseUrl":"https://agents.vimmerse.net","brandDocsUrl":null,"whatItDoes":"Generates, suggests, refines, or extracts a descriptive text prompt from images, video, or seed text for use in AI media generation workflows.","exampleAgentPrompt":"Look at this product image at https://media.vimmerse.net/example/product.jpg and generate a descriptive text prompt for it using the Image2Prompt option in image mode — I want to use it for AI image generation.","exampleUseCases":[{"title":"Extract prompt from product photo","prompt":"I have a product photo at https://store.example.com/images/watch.jpg — can you describe it as a text prompt I can reuse for AI image generation? Use the Image2Prompt option in image mode."},{"title":"Refine a weak image generation prompt","prompt":"My current prompt is 'a woman in a park' — can you refine it into something richer and more detailed that I can use for video generation? Use RefinePrompt in video mode."},{"title":"Get creative scene inspiration from nothing","prompt":"I don't have a specific idea yet — can you inspire me with a fresh creative prompt for a cinematic scene using the InspireMe option in scene mode?"}],"resultDescription":"Returns a plain JSON string containing the generated, suggested, refined, or extracted text prompt ready to use as input for image, video, audio, or scene generation workflows.","failureModes":["Missing required seed text when using RefinePrompt option — returns 422 validation error","Invalid or inaccessible image_url or video_url — returns error or poor-quality output","Unsupported option value — returns 422 validation error","Timeout on large video files when extracting middle frame — returns 504 or timeout error","Invalid mode value — returns 422 validation error"],"whenToPreferThis":"Choose this endpoint when you need to programmatically generate, improve, or extract text prompts from images or video before passing them to a downstream media generation step. It is especially useful in automated pipelines where a human hasn't crafted a prompt yet, or when you want to upgrade a weak seed prompt. Prefer it over generic LLM prompting when you want vision-grounded, media-mode-aware prompt text tuned specifically for Vimmerse's image, video, scene, or audio generators.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-31T00:34:44.535Z","isFirstParty":false,"canonicalSlug":"agents-vimmerse-net-vimmerse-generate-text-prompt-38e99235"}