SwitchX
SwitchX is our flagship video-to-video model that lets you switch anything in a scene while perfectly keeping what matters. Unlike standard video generators, SwitchX uses the original pixels to drive the final output. By providing a Source Video, defining an Alpha Mask (to tell the AI what to keep), and providing a Reference Image (to dictate the new look), SwitchX seamlessly generates new elements and relights your original subject to match perfectly.How It Works
Upload Assets
Use the Uploads API to securely upload your starting materials:
The original video you want to transform.
Your visual target. While not strictly required, we always strongly recommend providing one to achieve the highest quality and most accurate results.
A custom mask file. Whether you need to upload this depends entirely on which alpha_mode you choose in the next step.
Start Generation
Call the Generate endpoint to define your compositing job. Link your uploaded assets and configure the following parameters:
Choose how SwitchX handles the scene:
| Mode | Description |
|---|---|
| Auto | The AI automatically detects and masks the foreground subject. |
| Select | Provide an alpha mask for the first frame only, and our AI will propagate it across the entire video. |
| Fill | Keeps everything in the original scene exactly as it is (no masking applied). |
| Custom | Provide a full custom video mask for exact frame-by-frame control. |
(Recommended) A text description of the desired output video to further guide the AI on the specific style, lighting, or background details you want to generate.
Poll or Webhook
Video generation takes a little time. Check your job’s progress by polling our status endpoint, or set up a webhook callback to get notified the second it finishes.
Get Started
Quickstart
Make your first API call in minutes
SwitchX API
Full SwitchX endpoint reference
Uploads
Upload files for SwitchX
Authentication
Get your API key
Account
Check your rate limits, spending limit, and billing info
LLM-Friendly Docs
Build AI-powered integrations using our machine-readable documentation.llms.txt
Concise doc index for LLMs
llms-full.txt
Full documentation content for LLMs