{"uid":"cap_JPIasVR5IjtLpV68fr3ff","slug":"agents-vimmerse-net-vimmerse-edit-image-c661fdae","name":"Vimmerse Edit Image","description":"Edits an image: remove text, upscale, reframe, expand aspect ratio, or inpaint masked regions.\n\n| `option` | Required fields |\n|----------|-----------------|\n| `RemoveText` | `image_url` |\n| `Upscale` | `image_url` |\n| `ExpandToAspectRatio` | `image_url`, `aspect_ratio` |\n| `Inpaint` | `image_url`, `mask_url`, `prompt` |\n| `LumaReframe` | `image_url`, `reframe_parameters` |\n\n### Example — remove text\n\n```python\nimport requests\n\nurl = \"https://api.vimmerse.net/v2/image/edit-image\"\nheaders = {\n    \"X-Api-Key\": \"YOUR_API_KEY\",\n    \"Content-Type\": \"application/json\",\n}\npayload = {\n    \"image_url\": \"https://media.vimmerse.net/example/sign.png\",\n    \"option\": \"RemoveText\",\n}\n\nresponse = requests.post(url, headers=headers, json=payload, timeout=300)\nresponse.raise_for_status()\nprint(response.json()[\"results\"])\n```\n\n### Example — inpaint\n\n```python\npayload = {\n    \"image_url\": \"https://media.vimmerse.net/example/room.png\",\n    \"mask_url\": \"https://media.vimmerse.net/example/room_mask.png\",\n    \"option\": \"Inpaint\",\n    \"prompt\": \"Add a mountain view through the window\",\n    \"quantity\": 1,\n}\n```","url":"https://agents.vimmerse.net/v2/image/edit-image?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"type":"object","title":"EditImageRequest","required":["image_url"],"properties":{"option":{"type":"string","title":"Option","default":"RemoveText","description":"Available values: `RemoveText`, `Upscale`, `LumaReframe`, `Inpaint`, `ExpandToAspectRatio`."},"prompt":{"type":"string","title":"Text Prompt","default":"","description":"Text prompt for the regions to be modified/added."},"mask_url":{"type":"string","title":"Mask Image URL","default":""},"quantity":{"type":"integer","title":"Quantity","default":1,"minimum":1,"description":"Quantity of output images."},"image_url":{"type":"string","title":"Base Image URL"},"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","examples":["16:9","4:3","1:1","3:4","9:16"]},"expand_method":{"type":"string","title":"Expand Method","default":"Outpaint","description":"Only used for `ExpandToAspectRatio` option."},"expand_direction":{"type":"string","title":"Expand Direction","default":"center","description":"Only used for `ExpandToAspectRatio` option."},"reframe_parameters":{"type":"string","title":"Reframe Parameters","default":"","description":"JSON string for reframe parameters in pixels."}},"description":"Request body for POST /v2/image/edit-image. Content-Type: application/json."},"responseSchema":{"type":"object","title":"Response Edit Img Api V2 Image Edit Image Post","additionalProperties":true},"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_XzB_-ev0mcpkyyL3QHnhQ","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":"Edits an image by removing text, upscaling, reframing, expanding the aspect ratio, or inpainting masked regions.","exampleAgentPrompt":"Can you remove all the text overlays from this image at https://media.vimmerse.net/example/sign.png using the RemoveText option?","exampleUseCases":[{"title":"Remove watermark text from photo","prompt":"This product photo at https://example.com/product.png has some watermark text on it — can you clean that off using RemoveText so I have a clean version?"},{"title":"Expand portrait to landscape for social","prompt":"I have a portrait image at https://example.com/portrait.jpg and I need it expanded to a 16:9 aspect ratio for a YouTube thumbnail — can you do that with ExpandToAspectRatio?"},{"title":"Inpaint room with new window view","prompt":"Take this room photo at https://example.com/room.png and use the mask at https://example.com/room_mask.png to inpaint the window area with 'a stunning mountain view at sunset'."}],"resultDescription":"A JSON object containing a 'results' field with one or more URLs pointing to the edited output image(s), depending on the quantity requested.","failureModes":["Invalid or inaccessible image_url returns an error","Missing required fields for the chosen option (e.g. no mask_url for Inpaint) returns a validation error","Unsupported aspect ratio value may return a 400 error","Timeout on large images or complex operations after 300 seconds","Invalid reframe_parameters JSON string causes a parsing error","Insufficient credits results in a 402 payment required response"],"whenToPreferThis":"Choose this endpoint when you need to non-destructively modify an existing image — removing overlaid text, super-resolving quality, filling regions with AI-generated content via inpainting, expanding the canvas to a new aspect ratio, or reframing with Luma. Prefer this over image generation endpoints when the base image must be preserved and only specific edits are needed.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-30T22:53:34.536Z","isFirstParty":false,"canonicalSlug":"agents-vimmerse-net-vimmerse-edit-image-c661fdae"}