{"uid":"cap_HwIiGjeDfHQf9KeilvfBD","slug":"agents-vimmerse-net-vimmerse-replace-background-044dbb12","name":"Vimmerse Replace Background","description":"Composites **`video_url`** over **`bg_image_url`** and/or **`bg_video_url`**. Tune **`chroma_key_color`**, **`overlay_scale`**, **`alignment`**, offsets, etc.","url":"https://agents.vimmerse.net/v2/video/replace-background?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"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"}}},"responseSchema":{},"example":null,"exampleRequest":null,"tags":[],"displayCostAmount":"1.2","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":"$1.2/call (dynamic — varies by input)","primary":{"kind":"dynamic","protocol":"mpp","network":"tempo","amountUsd":"1.2","per":"call","confidence":"exact"},"accepted":[{"kind":"dynamic","protocol":"mpp","network":"tempo","amountUsd":"1.2","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_z01RqnqljPP8lLPoat3P8","protocol":"mpp","methodType":"crypto","chain":"tempo","mode":"charge","costAmount":"1.2","costPer":"request","priority":0,"asset":"usd","unit":"request","depositMicros":null,"planRef":null}],"brandName":"agents.vimmerse.net","brandSlug":"agents-vimmerse-net-x402","brandBaseUrl":"https://agents.vimmerse.net","brandDocsUrl":null,"whatItDoes":"Composites a foreground video over a background image or video using chroma key or background removal, with configurable scale, alignment, and offsets.","exampleAgentPrompt":"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.","exampleUseCases":[{"title":"Virtual background for presenter video","prompt":"I have a video of a presenter recorded in front of a green screen at https://cdn.example.com/presenter.mp4 — can you replace the background with this conference room image at https://cdn.example.com/confroom.jpg, center the person, and scale them to about 67% of the frame?"},{"title":"Overlay product demo on looping background video","prompt":"I want to composite my product demo clip at https://assets.example.com/demo.mp4 over a looping background video at https://assets.example.com/loop.mp4 — align it to the left side, offset it 50 pixels right and 30 pixels down, and set the scale to 0.5."},{"title":"Remove background and place on custom scene","prompt":"Can you strip the background from my video at https://media.example.com/actor.mp4 using the rembg library and place it centered over this custom scene image at https://media.example.com/scene.png at full overlay scale?"}],"resultDescription":"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.","failureModes":["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"],"whenToPreferThis":"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.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-31T00:42:16.938Z","isFirstParty":false,"canonicalSlug":"agents-vimmerse-net-vimmerse-replace-background-ef95375f"}