Product catalog

Product jobs share one submission API and one job lifecycle. Choose a product below for its model selection, inputs, and examples. GET /v1/products lists the products enabled for your organization.

Available products

VFX and finishing

Product	Use it for	Product ID
SwitchX	Replace environments and relight your subject with SwitchX 1.0 or 2.0.	`switchx`
SwitchX 2.0 Finish	Finish a completed SwitchX 2.0 image or video at a higher resolution.	`switchx_finish`
Background Remover	Extract alpha mattes for background removal and compositing.	`background_remover`
VFX Passes	Extract material, alpha, and depth passes for relighting and compositing.	`vfx_passes`
SDR to HDR	Recover highlight and shadow detail from SDR media with SwitchHDR.	`sdr_to_hdr`
Reframe	Change the canvas and place your source within a new composition.	`reframe`
Image Upscaler	Increase image resolution with an available upscaling model.	`image_upscaler`
Video Upscaler	Increase video resolution with an available upscaling model.	`video_upscaler`

Generate

Product	Use it for	Product ID
Image Generator	Generate images from prompts and supported reference inputs.	`image_generator`
Video Generator	Generate video from prompts, images, or other supported inputs.	`video_generator`
3D Scene Generator	Generate a 3D scene from the inputs supported by your selected model.	`3d_scene_generator`

Discover your models

Set BEEBLE_API_KEY and, for internal teams, BEEBLE_TEAM_ID. Python requires requests; JavaScript examples run in Node.js.

List products

GET /v1/products returns the products enabled for your organization.

curl --fail-with-body "https://api.beeble.ai/v1/products" \
  -H "x-api-key: $BEEBLE_API_KEY" \
  -H "X-Beeble-Team-Id: ${BEEBLE_TEAM_ID:-}"

import json
import os
import requests

headers = {"x-api-key": os.environ["BEEBLE_API_KEY"]}
if team_id := os.environ.get("BEEBLE_TEAM_ID"):
    headers["X-Beeble-Team-Id"] = team_id

response = requests.get(
    "https://api.beeble.ai/v1/products",
    headers=headers,
    timeout=30,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))

const headers = { "x-api-key": process.env.BEEBLE_API_KEY }
if (process.env.BEEBLE_TEAM_ID) {
  headers["X-Beeble-Team-Id"] = process.env.BEEBLE_TEAM_ID
}
const response = await fetch("https://api.beeble.ai/v1/products", {
  headers,
  signal: AbortSignal.timeout(30_000),
})
if (!response.ok) throw new Error(await response.text())
console.log(JSON.stringify(await response.json(), null, 2))

Response (200, abbreviated):

{
  "products": [
    { "id": "switchx", "name": "SwitchX", "billing_units": ["credits"] }
  ]
}

Request parameters and response schema

List models and input schemas

Replace switchx with a product ID from the table above.

curl --fail-with-body "https://api.beeble.ai/v1/products/switchx/models" \
  -H "x-api-key: $BEEBLE_API_KEY" \
  -H "X-Beeble-Team-Id: ${BEEBLE_TEAM_ID:-}"

import json
import os
import requests

headers = {"x-api-key": os.environ["BEEBLE_API_KEY"]}
if team_id := os.environ.get("BEEBLE_TEAM_ID"):
    headers["X-Beeble-Team-Id"] = team_id

response = requests.get(
    "https://api.beeble.ai/v1/products/switchx/models",
    headers=headers,
    timeout=30,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))

const headers = { "x-api-key": process.env.BEEBLE_API_KEY }
if (process.env.BEEBLE_TEAM_ID) {
  headers["X-Beeble-Team-Id"] = process.env.BEEBLE_TEAM_ID
}
const response = await fetch(
  "https://api.beeble.ai/v1/products/switchx/models",
  {
    headers,
    signal: AbortSignal.timeout(30_000),
  },
)
if (!response.ok) throw new Error(await response.text())
console.log(JSON.stringify(await response.json(), null, 2))

Response (200): models contains each model’s id, name, input_schema, and any requires_consent value. Use the selected model’s input_schema for required inputs, types, defaults, and supported values. Request parameters and response schema Use id in requests and name for display. Complete any required model consent in Beeble Cloud before submitting.

API schemas

Each reference below renders request parameters, request bodies, and responses from OpenAPI. Model-specific inputs come from the model catalog’s input_schema.

API call	Input	Output
Create upload URL	Filename	Upload URL and Beeble URI
List products	No request body	Products available to your organization
List models	Product ID	Models and their input schemas
Estimate cost	Product ID, model ID, inputs	Estimated credits and source metadata
Create job	Product ID, model ID, inputs, idempotency key	Job ID, status, and billing fields
Get job	Job ID	Current status and outputs
List jobs	Page size and cursor	Saved jobs and next cursor

outputs is an open object in the job response schema. Its fields vary by product and model; OpenAPI does not yet define those individual fields.

Finish a SwitchX 2.0 result

SwitchX 2.0 Finish reuses a completed Standard product generation through the separate switchx_finish product. Use model_id: "switchx-2.0" with inputs.parent_job_id and inputs.target_resolution; no upload is needed. The guide covers eligible parents, transition estimates, and retrieving the new child job through the shared product-job API.

Job lifecycle

Product submissions return 202 and a public dap_… ID. Read that job for fresh status and output URLs. Reuse the same idempotency key and request body when a submission’s outcome is uncertain. See Jobs & retries.

Completion callbacks

Set a public HTTPS callback_url to receive terminal job results. Product callbacks use type: "product.job.completed" and may be delivered more than once. See Webhooks for the payload and retries.

Credit usage and availability

Charges use your organization’s Beeble Cloud credit balance. A failed job alone does not confirm a refund. Read Billing & credits for actual charge and refund fields and API keys & organizations for access requirements. Canvas and Showrunner document/conversation APIs are separate.

Get started

Products

Core concepts

Integrations

Available products

VFX and finishing

Generate

Discover your models

List products

List models and input schemas

API schemas

Finish a SwitchX 2.0 result

Job lifecycle

Completion callbacks

Credit usage and availability

​Available products

​VFX and finishing

​Generate

​Discover your models

​List products

​List models and input schemas

​API schemas

​Finish a SwitchX 2.0 result

​Job lifecycle

​Completion callbacks

​Credit usage and availability

Available products

VFX and finishing

Generate

Discover your models

List products

List models and input schemas

API schemas

Finish a SwitchX 2.0 result

Job lifecycle

Completion callbacks

Credit usage and availability