# Vimmerse Edit Image

> Vimmerse Edit Image is a paid API for AI agents from agents.vimmerse.net, paid per call via MPP, $0.12/call (dynamic — varies by input), status unknown (last checked 2026-10-30).

Edits an image by removing text, upscaling, reframing, expanding the aspect ratio, or inpainting masked regions.

## Facts

- Endpoint: POST https://agents.vimmerse.net/v2/image/edit-image?utm_source=zero.xyz
- Price: $0.12/call (dynamic — varies by input)
- Payment: MPP
- Status: unknown
- Last checked: 2026-10-30
- Activations on Zero: 0
- Provider: agents.vimmerse.net
- Website: https://agents.vimmerse.net
- Canonical page: https://www.zero.xyz/c/agents-vimmerse-net-vimmerse-edit-image-c661fdae
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_JPIasVR5IjtLpV68fr3ff

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability agents-vimmerse-net-vimmerse-edit-image-c661fdae -d '<json body>'
```

Example prompt: Can you remove all the text overlays from this image at https://media.vimmerse.net/example/sign.png using the RemoveText option?

## When to prefer this

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.

## Known failure modes

- 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

## How this service works

Edits an image: remove text, upscale, reframe, expand aspect ratio, or inpaint masked regions.

| `option` | Required fields |
|----------|-----------------|
| `RemoveText` | `image_url` |
| `Upscale` | `image_url` |
| `ExpandToAspectRatio` | `image_url`, `aspect_ratio` |
| `Inpaint` | `image_url`, `mask_url`, `prompt` |
| `LumaReframe` | `image_url`, `reframe_parameters` |

### Example — remove text

```python
import requests

url = "https://api.vimmerse.net/v2/image/edit-image"
headers = {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "image_url": "https://media.vimmerse.net/example/sign.png",
    "option": "RemoveText",
}

response = requests.post(url, headers=headers, json=payload, timeout=300)
response.raise_for_status()
print(response.json()["results"])
```

### Example — inpaint

```python
payload = {
    "image_url": "https://media.vimmerse.net/example/room.png",
    "mask_url": "https://media.vimmerse.net/example/room_mask.png",
    "option": "Inpaint",
    "prompt": "Add a mountain view through the window",
    "quantity": 1,
}
```

## Output

A JSON object containing a 'results' field with one or more URLs pointing to the edited output image(s), depending on the quantity requested.

## Request schema (JSON Schema)

```json
{
 "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."
}
```

## Response schema (JSON Schema)

```json
{
 "type": "object",
 "title": "Response Edit Img Api V2 Image Edit Image Post",
 "additionalProperties": true
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/agents-vimmerse-net-vimmerse-edit-image-c661fdae/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from agents.vimmerse.net](https://www.zero.xyz/host/agents.vimmerse.net/llms.txt)