# Vimmerse Replace Background

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

Composites a foreground video over a background image or video using chroma key or background removal, with configurable scale, alignment, and offsets.

## Facts

- Endpoint: POST https://agents.vimmerse.net/v2/video/replace-background?utm_source=zero.xyz
- Price: $1.2/call (dynamic — varies by input)
- Payment: MPP
- Status: unknown
- Last checked: 2026-10-31
- Activations on Zero: 0
- Provider: agents.vimmerse.net
- Website: https://agents.vimmerse.net
- Canonical page: https://www.zero.xyz/c/agents-vimmerse-net-vimmerse-replace-background-044dbb12
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_HwIiGjeDfHQf9KeilvfBD

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-replace-background-044dbb12 -d '<json body>'
```

Example prompt: Take my talking head video at https://example.com/speaker.mp4 and composite it over this office background image at https://example.com/office.jpg — center the overlay at 0.67 scale and key out the green screen color with a tolerance of 0.15.

## When to prefer this

Choose this endpoint when you need to replace or composite a video's background with a specific image or video asset, especially when chroma keying (green/blue screen removal) or automatic background removal is required. It is ideal for virtual background effects, talking head videos, product overlays, and any scenario requiring fine control over positioning, scale, and background source.

## Known failure modes

- Invalid or inaccessible video_url returns an error
- Unsupported chroma_key_color value may cause poor keying results
- Background image or video URL unreachable results in failure
- Mismatched aspect ratios between foreground and background may cause unexpected cropping
- Async mode requires polling or webhook; no immediate video returned
- Insufficient credits results in payment error

## How this service works

Composites **`video_url`** over **`bg_image_url`** and/or **`bg_video_url`**. Tune **`chroma_key_color`**, **`overlay_scale`**, **`alignment`**, offsets, etc.

## Output

Returns a composited video where the foreground video subject has been placed over the specified background image or video, with the chosen chroma key color removed or background auto-removed, scaled and positioned according to the provided alignment and offset parameters. The response may include a job ID or direct video URL depending on async mode.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "title": "ReplaceVideoBackgroundRequest",
 "required": [
  "video_url"
 ],
 "properties": {
  "prompt": {
   "type": "string",
   "title": "Prompt",
   "default": ""
  },
  "x_offset": {
   "type": "integer",
   "title": "X Offset",
   "default": 0
  },
  "y_offset": {
   "type": "integer",
   "title": "Y Offset",
   "default": 0
  },
  "alignment": {
   "type": "string",
   "title": "Alignment",
   "default": "center",
   "description": "`center`, `left`, or `right`."
  },
  "video_url": {
   "type": "string",
   "title": "Foreground video URL"
  },
  "async_mode": {
   "type": "boolean",
   "title": "Async Mode",
   "default": false
  },
  "start_time": {
   "type": "string",
   "title": "Background video start time",
   "default": "0"
  },
  "webhook_url": {
   "anyOf": [
    {
     "type": "string"
    },
    {
     "type": "null"
    }
   ],
   "title": "Webhook URL"
  },
  "bg_image_url": {
   "type": "string",
   "title": "Background image URL",
   "default": ""
  },
  "bg_video_url": {
   "type": "string",
   "title": "Background video URL",
   "default": ""
  },
  "overlay_scale": {
   "type": "string",
   "title": "Overlay scale",
   "default": "0.6666"
  },
  "use_rembg_lib": {
   "type": "boolean",
   "title": "Use rembg library",
   "default": false
  },
  "crop_to_content": {
   "type": "boolean",
   "title": "Crop overlay to content",
   "default": true
  },
  "chroma_key_color": {
   "type": "string",
   "title": "Chroma key color",
   "default": "origin"
  },
  "chroma_tolerance": {
   "type": "string",
   "title": "Chroma tolerance",
   "default": "0.1"
  }
 }
}
```

## Response schema (JSON Schema)

```json
{}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/agents-vimmerse-net-vimmerse-replace-background-044dbb12/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)