Image Upscaler

Product ID: image_upscaler · Billing: Beeble Cloud credits

Before you start

Create an API key with your organization selected.
Confirm the product is enabled and your organization has Beeble Cloud credits.
Select a model below and complete any required consent in Beeble Cloud.

Choose a model

List the models available to your organization: Set BEEBLE_API_KEY and, for internal teams, BEEBLE_TEAM_ID.

curl --fail-with-body "https://api.beeble.ai/v1/products/image_upscaler/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/image_upscaler/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/image_upscaler/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

Prepare your inputs

Provide your image using the model’s image input. Check its allowed scale or target-resolution parameters; these differ by model. For each media field supported by your model, provide a Beeble URI, an authorized Beeble CDN URL, a public/presigned HTTPS URL, or a base64 data URI. HTTPS and data URIs do not require a separate upload. Follow the shared media limits and the selected model’s file requirements.

Submit a job

Schemas: Request body · Response. The inputs object follows your selected model’s input_schema above. Request template: replace MODEL_ID_FROM_CATALOG and fill inputs from the model schema. Save as request.json. Use a unique idempotency_key for each new job; keep it unchanged on retries.

{
  "model_id": "MODEL_ID_FROM_CATALOG",
  "billing_unit": "credits",
  "idempotency_key": "image_upscaler-example-001",
  "inputs": {}
}

Python requires requests; JavaScript examples run in Node.js.

curl --fail-with-body https://api.beeble.ai/v1/products/image_upscaler/jobs \
  -H "x-api-key: $BEEBLE_API_KEY" \
  -H "X-Beeble-Team-Id: ${BEEBLE_TEAM_ID:-}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

import json
import os
from pathlib import Path

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.post(
    "https://api.beeble.ai/v1/products/image_upscaler/jobs",
    headers=headers,
    json=json.loads(Path("request.json").read_text()),
    timeout=120,
)
response.raise_for_status()
job_id = response.json()["id"]
print(job_id)

import { readFile } from "node:fs/promises"

const headers = {
  "x-api-key": process.env.BEEBLE_API_KEY,
  "Content-Type": "application/json",
}
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/image_upscaler/jobs",
  {
    method: "POST",
    headers,
    body: await readFile("request.json", "utf8"),
    signal: AbortSignal.timeout(120_000),
  },
)
if (!response.ok) throw new Error(await response.text())
const { id: jobId } = await response.json()
console.log(jobId)

Response (202, abbreviated):

{
  "id": "dap_example",
  "status": "processing",
  "outputs": {}
}

Completed response

Poll the job using the returned id until status is success. Stop on failed, cancelled, or credit_required. Example response (200, success; abbreviated): URLs are illustrative. Available outputs depend on the model and input media.

{
  "id": "dap_example",
  "product": "image_upscaler",
  "status": "success",
  "outputs": {
    "media_kind": "image",
    "primary_url": "https://cdn.beeble.ai/example/upscaled.png?signed-parameters",
    "thumbnail_url": "https://cdn.beeble.ai/example/thumbnail.webp?signed-parameters"
  }
}

Download outputs.primary_url for the upscaled image.

Get started

Products

Core concepts

Integrations

Before you start

Choose a model

Prepare your inputs

Submit a job

Completed response

​Before you start

​Choose a model

​Prepare your inputs

​Submit a job

​Completed response

Before you start

Choose a model

Prepare your inputs

Submit a job

Completed response