> For the complete documentation index, see [llms.txt](https://docs.aimlapi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aimlapi.com/api-references/video-models/beeble/switchx-video-to-video.md).
# Switchx Video To Video
{% columns %}
{% column width="66.66666666666666%" %}
{% hint style="info" %}
This documentation is valid for the following list of our models:
* `beeble/switchx-video-to-video`
{% endhint %}
{% endcolumn %}
{% column width="33.33333333333334%" %} Try in Playground
{% endcolumn %}
{% endcolumns %}
## Model Overview
SwitchX is a video-to-video compositing model by Beeble that replaces a scene element while preserving the original subject, with automatic subject detection and seamless relighting to match a reference image. Does not support tools/function calling.
## Setup your API Key
If you don't have an API key yet, use our [Quickstart guide](https://docs.aimlapi.com/quickstart/setting-up).
## How to Make a Call
Step-by-Step Instructions
Generating a video involves sequentially calling two endpoints:
* Create and submit a video generation task. The response contains a generation ID.
* Poll the retrieval endpoint with that generation ID until the status is `completed`.
## API Schemas
### Create a video generation task and send it to the server
## POST /v2/video/generations
>
```json
{"openapi":"3.0.0","info":{"title":"AIML API","version":"1.0.0"},"servers":[{"url":"https://api.aimlapi.com"}],"paths":{"/v2/video/generations":{"post":{"operationId":"_v2_video_generations","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"model":{"type":"string","enum":["beeble/switchx-video-to-video"]},"video_url":{"type":"string","format":"uri","description":"URL of the source video to recomposite. Allowed formats: MP4, MOV (H.264 or HEVC), up to 240 frames. Source must not exceed 2,770,000 total pixels."},"alpha_url":{"type":"string","format":"uri","description":"URL of the alpha mask. Required when alpha_mode is \"custom\" or \"select\"; ignored for \"auto\" and \"fill\". A mask video for video-to-video, a mask image for image-to-image."},"reference_image_url":{"type":"string","format":"uri","description":"URL of the reference image defining the target look and lighting for the replaced region. Allowed formats: JPEG, PNG, WEBP. At least one of reference_image_url or prompt must be provided."},"alpha_mode":{"type":"string","enum":["auto","fill","custom","select"],"default":"auto","description":"Subject masking strategy: \"auto\" (AI auto-detects the subject), \"fill\" (no masking), \"select\" (propagate a mask from one keyframe), or \"custom\" (frame-by-frame mask supplied via alpha_url). Defaults to \"auto\"."},"max_resolution":{"type":"integer","description":"Maximum output resolution (longer side) in pixels: 720 or 1080. Defaults to 1080. 1080 costs more than 720.","enum":[720,1080],"default":"1080"},"alpha_keyframe_index":{"type":"integer","minimum":0,"description":"Frame index (0-based) whose mask is propagated when alpha_mode is \"select\" on a video. Defaults to the first frame. Ignored for image generation and for the auto, fill, and custom modes."},"seed":{"type":"integer","minimum":0,"maximum":4294967295,"description":"Random seed (0–4294967295) for reproducibility. Omit for a random seed. The seed used is always returned in the response."},"prompt":{"type":"string","maxLength":2000,"description":"Text description of the desired output to guide the generation (max 2000 characters). At least one of prompt or reference_image_url must be provided."}},"required":["model","video_url"],"title":"beeble/switchx-video-to-video"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the generated video."},"status":{"type":"string","enum":["queued","generating","completed","error"],"description":"The current status of the generation task."},"video":{"type":"object","nullable":true,"properties":{"url":{"type":"string","format":"uri","description":"The URL where the file can be downloaded from."}},"required":["url"]},"error":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"],"description":"Description of the error, if any."},"meta":{"type":"object","nullable":true,"properties":{"usage":{"type":"object","nullable":true,"properties":{"credits_used":{"type":"number","description":"The number of tokens consumed during generation."},"usd_spent":{"type":"number","description":"The total amount of money spent by the user in USD."}},"required":["credits_used","usd_spent"]}},"description":"Additional details about the generation."}},"required":["id","status"]}}},"description":"Successful response."}}}}}}
```
### Retrieve the generated video from the server
Poll this endpoint with the `generation_id` returned by the submit request. When the status is `completed`, the response includes the generated video URL.
## GET /v2/video/generations
>
```json
{"openapi":"3.0.0","info":{"title":"AIML API","version":"1.0.0"},"servers":[{"url":"https://api.aimlapi.com"}],"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"","type":"http","description":"Bearer key","in":"header"}}},"paths":{"/v2/video/generations":{"get":{"operationId":"_v2_video_generations","parameters":[{"name":"generation_id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the generated video."},"status":{"type":"string","enum":["queued","generating","completed","error"],"description":"The current status of the generation task."},"video":{"type":"object","nullable":true,"properties":{"url":{"type":"string","format":"uri","description":"The URL where the file can be downloaded from."}},"required":["url"]},"error":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"],"description":"Description of the error, if any."},"meta":{"type":"object","nullable":true,"properties":{"usage":{"type":"object","nullable":true,"properties":{"credits_used":{"type":"number","description":"The number of tokens consumed during generation."}},"required":["credits_used"]}},"description":"Additional details about the generation."}},"required":["id","status"]}}}}}}}}}
```
## Code Example
The examples submit a generation task and poll every **15 seconds** until the final result is available.
{% tabs %}
{% tab title="Python" %}
{% code overflow="wrap" %}
```python
import requests
import time
api_key = ""
url = "https://api.aimlapi.com/v2/video/generations"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json",
}
generation = requests.post(url, headers=headers, json={'model': 'beeble/switchx-video-to-video', 'video_url': 'https://example.com/input.jpg', 'prompt': 'Describe what you want the model to generate.'})
generation.raise_for_status()
generation_id = generation.json()["id"]
while True:
result = requests.get(
url,
headers=headers,
params={"generation_id": generation_id},
)
result.raise_for_status()
data = result.json()
if data.get("status") not in ("queued", "generating"):
print(data)
break
time.sleep(15)
```
{% endcode %}
{% endtab %}
{% tab title="JavaScript" %}
{% code overflow="wrap" %}
```javascript
const apiKey = "";
const url = "https://api.aimlapi.com/v2/video/generations";
const headers = {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json",
};
const generation = await fetch(url, {
method: "POST",
headers,
body: JSON.stringify({
"model": "beeble/switchx-video-to-video",
"video_url": "https://example.com/input.jpg",
"prompt": "Describe what you want the model to generate."
}),
});
const { id: generationId } = await generation.json();
while (true) {
const response = await fetch(
`${url}?generation_id=${encodeURIComponent(generationId)}`,
{ headers },
);
const data = await response.json();
if (!["queued", "generating"].includes(data.status)) {
console.log(data);
break;
}
await new Promise((resolve) => setTimeout(resolve, 15000));
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
Response
{% code overflow="wrap" %}
```json
{
"id": "60ac7c34-3224-4b14-8e7d-0aa0db708325",
"status": "completed",
"video": {
"url": "https://cdn.aimlapi.com/generations/hedgehog/1759866285599-0cdfb138-c03a-49d4-a601-4f6413e27b15.mp4"
},
"error": {
"name": "",
"message": ""
},
"meta": {
"usage": {
"credits_used": 120000,
"usd_spent": 0.06
}
}
}
```
{% endcode %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.aimlapi.com/api-references/video-models/beeble/switchx-video-to-video.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.