Skip to main content

​
Prerequisites

To use the Beeble API, you need an API key.
  1. Sign up if you don’t have an account
  2. Go to Developer Page
  3. Click Issue API Key
See Authentication for details on obtaining and using your API key.
1

Upload: Get an Upload URL

Create an upload and get a URL for your source file.
curl -X POST https://api.beeble.ai/v1/uploads \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filename": "source.mp4"}'
Then upload your file to the upload URL:
curl -X PUT "${UPLOAD_URL}" \
  -H "Content-Type: video/mp4" \
  --data-binary @source.mp4
2

Generate: Start SwitchX

Start a compositing job with your uploaded source.
curl -X POST https://api.beeble.ai/v1/switchx/generations \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "generation_type": "video",
    "source_uri": "'"${BEEBLE_URI}"'",
    "prompt": "cinematic studio lighting",
    "alpha_mode": "auto"
  }'
Response:
{
  "id": "swx_abc123..."
}
3

Poll: Check Job Status

Poll the job status until it completes.
curl https://api.beeble.ai/v1/switchx/generations/swx_abc123 \
  -H "x-api-key: YOUR_API_KEY"
Response (completed):
{
  "id": "swx_abc123",
  "status": "completed",
  "progress": 100,
  "generation_type": "video",
  "alpha_mode": "auto",
  "output": {
    "render": "https://cdn.beeble.ai/.../render.mp4",
    "source": "https://cdn.beeble.ai/.../source.mp4",
    "alpha": "https://cdn.beeble.ai/.../alpha.mp4"
  },
  "created_at": "2026-02-23T10:00:00Z",
  "modified_at": "2026-02-23T10:05:00Z",
  "completed_at": "2026-02-23T10:05:00Z"
}
4

Download: Get Results

Download the composited output.
curl -o render.mp4 "https://cdn.beeble.ai/.../render.mp4"
Output URLs expire after a limited time. Download results promptly.

​
Next Steps

SwitchX API

Full endpoint reference

Uploads

Upload endpoint reference