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

> ## Agent Instructions
> This site documents two API families. Choose the family before generating integration code and keep its request fields, billing, statuses, responses, and webhooks together.
> SwitchX API: POST /v1/switchx/generations; use /quickstart and /authentication. Completed generation files are under output.
> Enterprise API: POST /v1/products/{product}/jobs and GET /v1/product-jobs/{job_id}; use /enterprise/quickstart and /products. Check /enterprise for current access requirements. Completed product files are under outputs.
> For product jobs, fetch model-specific input_schema from GET /v1/products/{product}/models. OpenAPI defines the common job response; product guides show illustrative completed outputs. Do not treat output examples as exhaustive schemas.
> SwitchX 2.0 Finish uses the separate switchx_finish product and model_id switchx-2.0. Follow /products/switchx-finish: pass inputs.parent_job_id (a completed Standard switchx product generation's public dap_ ID owned by the same key owner, organization, and team) and inputs.target_resolution (1080 or 2160), without uploading media. Fast results, Finish results, and legacy SwitchX API generations cannot be parents. Estimate the transition, then submit and poll the new child ID; result files are under outputs.
> For product APIs, authenticate with an Organization API Key in x-api-key and keep the same organization and X-Beeble-Team-Id context for uploads, estimates, submissions, and reads. Use Beeble Cloud credits; product routes do not support USD.
> Follow /enterprise/llms-txt for the product API workflow: discover products and models, upload media, estimate credits, submit with an idempotency_key, and poll or receive webhooks. On an uncertain submission, retry the same body and key; do not create a replacement job.
> Product-job success is status=success; stop polling on failed, cancelled, or credit_required. Use the chosen product guide for completed response examples and download fields. Refer to /enterprise/errors, /enterprise/rate-limits, /guides/billing, and /guides/jobs for failures, limits, and refunds.

# Overview

> Build image, video, and 3D workflows with the Beeble API.

Provide a media URI, choose a product, and retrieve the result from an asynchronous
job. Start with a working example, then use the product guides to build your workflow.

<Note>
  Currently available to Enterprise customers. Requires an [Organization API
  Key](/docs/enterprise/authentication#api-access), product access, and **Beeble
  Cloud credits**.
</Note>

<CardGroup cols={2}>
  <Card title="Make your first request" icon="terminal" href="/docs/enterprise/quickstart">
    Run SwitchX 2.0 using Beeble Cloud credits.
  </Card>

  <Card title="Explore the products" icon="grid-2" href="/docs/products">
    Explore product APIs for compositing, generation, and upscaling.
  </Card>
</CardGroup>

<span id="get-started" />

<span id="choose-your-starting-point" />

## How it works

<Steps>
  <Step title="Create an API key">
    Create a key in the [Developer Portal](https://developer.beeble.ai/api-keys)
    with your organization selected.
  </Step>

  <Step title="Prepare media and submit">
    Use an uploaded Beeble URI, an authorized Beeble CDN URL, a public or
    presigned HTTPS URL, or a base64 data URI. [Choose a media
    input](/docs/guides/uploads#choose-a-media-input), then submit it in your model's
    input schema.
  </Step>

  <Step title="Retrieve your result">
    Save the returned job ID. [Poll for completion](/docs/guides/jobs) or receive a
    [webhook](/docs/enterprise/webhooks), then download the successful output.
  </Step>
</Steps>

<span id="llm-friendly-docs" />

## Build your integration

* [API Reference](/docs/api-reference/products/list-available-products): request and response fields.
* [Billing & credits](/docs/guides/billing): estimates, spending caps, and refunds.
* [Jobs & retries](/docs/guides/jobs): polling, downloads, and safe retries.
* [LLM-friendly docs](/docs/enterprise/llms-txt): machine-readable documentation.