API keys & organizations

API access

An Organization API Key is an API key created with your organization selected in the Developer Portal. The product must be enabled for that organization. Jobs use Beeble Cloud credits. See the Overview for current availability. Call GET /v1/products to list products available to your organization.

Getting Your API Key

Open the Developer Portal and sign in.
Select your organization and click Create Key.
Copy and store the key securely. It is shown only once.

Using Your API Key

Include your API key in the x-api-key header with every request to the Beeble API:

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"}'

import requests

response = requests.post(
    "https://api.beeble.ai/v1/uploads",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={"filename": "source.mp4"}
)

const response = await fetch("https://api.beeble.ai/v1/uploads", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ filename: "source.mp4" }),
})

See Uploads for the response example and request and response schemas.

Revoking Your API Key

In the Developer Portal, click Revoke next to your key and confirm. Requests using that key will then be rejected.

Organization Keys

Each key is bound to its owner and organization. Organization members can create and revoke their own keys. Requests verify current membership; the key stops working when its owner leaves the organization.

Internal teams

If your organization uses internal teams, include X-Beeble-Team-Id on uploads, catalog requests, job submissions, and reads. Keep the same organization and team throughout a job. Organization administrators can omit the header to read jobs with no team assignment.

Organization security policies

API keys follow your organization’s MFA and SSO policies. Keys cannot supply a session MFA proof; an organization requiring MFA needs an applicable SSO exemption to use machine keys. Product jobs can return 409 if your organization requires a compute region they cannot enforce.

See Billing & credits for payment setup and Jobs & retries for retry handling.

Get started

Products

Core concepts

Integrations

API access

Getting Your API Key

Using Your API Key

Revoking Your API Key

Organization Keys

Internal teams

​API access

​Getting Your API Key

​Using Your API Key

​Revoking Your API Key

​Organization Keys

​Internal teams

API access

Getting Your API Key

Using Your API Key

Revoking Your API Key

Organization Keys

Internal teams