> ## Documentation Index
> Fetch the complete documentation index at: https://developer.beeble.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Beeble API for AI-powered visual effects

## 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

<Steps>
  <Step title="Upload Assets">
    Use the [Uploads API](/docs/api-reference/uploads/create-upload-url) to securely upload your starting materials:

    <ParamField body="source_video" type="file" required>
      The original video you want to transform.
    </ParamField>

    <ParamField body="reference_image" type="file">
      Your visual target. While not strictly required, we **always strongly recommend** providing one to achieve the highest quality and most accurate results.
    </ParamField>

    <ParamField body="alpha_mask" type="file">
      A custom mask file. Whether you need to upload this depends entirely on which **alpha\_mode** you choose in the next step.
    </ParamField>
  </Step>

  <Step title="Start Generation">
    Call the [Generate endpoint](/docs/api-reference/switchx/start-generation) to define your compositing job. Link your uploaded assets and configure the following parameters:

    <ParamField body="alpha_mode" type="string" required>
      Choose how SwitchX handles the scene:

      | Mode       | Description                                                                                                                                                                         |
      | :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | **Auto**   | The AI automatically detects and masks the foreground subject.                                                                                                                      |
      | **Select** | Provide an alpha mask for a single reference frame (the **first frame** by default, or any frame via `alpha_keyframe_index`), 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.                                                                                                              |
    </ParamField>

    <ParamField body="prompt" type="string">
      *(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.
    </ParamField>
  </Step>

  <Step title="Poll or Webhook">
    Video generation takes a little time. Check your job's progress by [polling our status endpoint](/docs/api-reference/switchx/get-generation-status), or set up a [webhook callback](/docs/webhooks) to get notified the second it finishes.
  </Step>

  <Step title="Download">
    Retrieve the URL from the completed job and download your seamlessly composited, fully relighted final video!
  </Step>
</Steps>

***

## Get Started

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/docs/quickstart">
    Make your first API call in minutes
  </Card>

  <Card title="SwitchX API" icon="wand-magic-sparkles" href="/docs/api-reference/switchx/start-generation">
    Full SwitchX endpoint reference
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Uploads" icon="upload" href="/docs/api-reference/uploads/create-upload-url">
    Upload files for SwitchX
  </Card>

  <Card title="Authentication" icon="key" href="/docs/authentication">
    Get your API key
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Account" icon="user" href="/docs/api-reference/account/get-account-info">
    Check your rate limits, spending limit, and billing info
  </Card>
</CardGroup>

***

## LLM-Friendly Docs

Build AI-powered integrations using our machine-readable documentation.

<CardGroup cols={2}>
  <Card title="llms.txt" icon="robot" href="https://developer.beeble.ai/docs/llms.txt">
    Concise doc index for LLMs
  </Card>

  <Card title="llms-full.txt" icon="file-lines" href="https://developer.beeble.ai/docs/llms-full.txt">
    Full documentation content for LLMs
  </Card>
</CardGroup>