SDKs

Official client libraries for the IBEE Solutions API. Install one for your language and start building.

Version 0.3 covers object storage, secret store, compute discovery, cloud and GPU VMs, VPC networking, Reserved IPs, firewalls, load balancers, Block Storage, CDN, and an explicit billing eligibility check. Every client authenticates with an API token from Settings → API Tokens plus a workspace ID.

Environments

The SDKs target production (https://api.ibee.ai/v1) by default. To use the development gateway (https://api.ibee.co.in/v1) with a ibee_dev_key_... token:

from ibee import Ibee, IbeeEnvironment
client = Ibee(token="ibee_dev_key_xxx", environment=IbeeEnvironment.DEVELOPMENT)

Billing admission on create

The Python SDK, TypeScript SDK, and CLI expose the billing eligibility endpoint as an explicit preflight. They do not call it automatically before create requests. When your workflow needs an early decision, call the eligibility operation immediately before creating the resource and continue only when allowed is true.

The preflight token needs billing.read; the create request needs the relevant product write scope. The public gateway is authoritative and performs a fail-closed billing decision before forwarding every declared billable create to the existing product service. A successful earlier preflight is not a reservation or a guarantee that a later create will succeed.

Python SDK

Install the Python SDK from PyPI:

pip install ibee

from ibee import Ibee
client = Ibee(token="ibee_prod_key_xxxxxxxxxxxx")
# Discover IDs accepted by VM creation
sites = client.compute_catalog.list_compute_sites(workspace_id="907479")
plans = client.compute_catalog.list_compute_plans(
    workspace_id="907479", vm_type="cloud"
)
images = client.compute_catalog.list_compute_images(
    workspace_id="907479", vm_type="cloud"
)
# List cloud VMs
vms = client.cloud_vms.list_cloud_vms(workspace_id="907479")
# Create a cloud VM from a priced plan and an image
plan = next(p for p in plans.plans if p.selectable and p.pricing_status == "priced")
image = images.images[0]
vm = client.cloud_vms.create_cloud_vm(
    workspace_id="907479",
    idempotency_key="create-web-server-01",
    name="web-server",
    plan_id=plan.plan_id,
    template_id=image.template_id,
    os_distro=image.os_distro,
    os_type=image.os_type,
    cpu=plan.cpu,
    ram_mb=plan.ram_mb,
    # Pass the plan's billing_catalog through unchanged (see below).
    request_options={"additional_body_parameters": {"billing_catalog": plan.billing_catalog}},
)
# List GPU VMs
gpu_vms = client.gpu_vms.list_gpu_vms(workspace_id="907479")
# Object storage — list and create
buckets = client.object_storage.list_buckets(workspace_id="907479")
bucket = client.object_storage.create_bucket(
    workspace_id="907479", name="my-bucket", region="in-south-2"
)
# Secret store — create a store, then a versioned secret
store = client.secret_store.create_secret_store(workspace_id="907479", name="payments")
secret = client.secret_store.create_secret(
    workspace_id="907479",
    store_id=store.id,
    secret_name="stripe-key",
    value={"API_KEY": "sk_live_xxx"},
)
value = client.secret_store.get_secret_value(workspace_id="907479", secret_id=secret.id)

To create a VM from the same kind of choices shown in the portal, pass the selected IDs into the create call:

vm = client.cloud_vms.create_cloud_vm(
    workspace_id="907479",
    idempotency_key="create-web-server-01",
    name="web-server-01",
    os_distro="ubuntu",
    os_type="linux",
    template_id="tmpl_ubuntu_2204",
    plan_id="plan_standard_2c_4g",
    cpu=2,
    ram_mb=4096,
    disk_gb=80,
    ssh_key_ids=["ssh_key_123"],
    tags=["prod", "web"],
    request_options={"additional_body_parameters": {"billing_catalog": plan.billing_catalog}},
)

plan_id is the selected instance plan. template_id is the selected OS template or image. ssh_key_ids are the SSH keys to inject at first boot. billing_catalog is the object returned with the selected plan by list_compute_plans; the API requires it on every VM create and it must be sent back unchanged. SDK 0.3.0 has no named argument for it yet, so pass it as an additional body parameter as shown. Omit site_id for automatic placement. To pin a VM, copy the exact site_id returned by list_compute_sites; do not use a region or site name. In the current SDK, cpu and ram_mb are still required fallback fields even when plan_id is provided.

Async support is built in:

import asyncio
from ibee import AsyncIbee
async def main():
    client = AsyncIbee(token="ibee_prod_key_xxxxxxxxxxxx")
    vms = await client.cloud_vms.list_cloud_vms(workspace_id="907479")
    print(vms)
asyncio.run(main())

TypeScript SDK

Install the TypeScript SDK from npm. It works in Node 18+ and modern browsers, ships ESM and CommonJS builds with full type declarations, and has no runtime dependencies.

npm install ibee-sdk

import { Ibee } from "ibee-sdk";
const client = new Ibee({ token: "ibee_prod_key_xxxxxxxxxxxx" });
const sites = await client.computeCatalog.listSites({ workspaceId: "907479" });
const plans = await client.computeCatalog.listPlans({
  workspaceId: "907479",
  vmType: "cloud",
});
const images = await client.computeCatalog.listImages({
  workspaceId: "907479",
  vmType: "cloud",
});
// List cloud VMs
const vms = await client.cloudVms.list({ workspaceId: "907479" });
// Create a cloud VM from a priced plan and an image
const plan = plans.plans.find((p) => p.selectable && p.pricing_status === "priced")!;
const image = images.images[0];
await client.cloudVms.create({
  workspaceId: "907479",
  name: "web-server",
  plan_id: plan.plan_id,
  template_id: image.template_id,
  os_distro: image.os_distro,
  os_type: image.os_type,
  cpu: plan.cpu,
  ram_mb: plan.ram_mb,
  // SDK 0.3.0 has no billing_catalog field yet; pass the plan's object through unchanged.
  ...{ billing_catalog: (plan as typeof plan & { billing_catalog: unknown }).billing_catalog },
});
// List buckets
const buckets = await client.objectStorage.listBuckets({ workspaceId: "907479" });
// Create a bucket in an Object Storage region
const bucket = await client.objectStorage.createBucket({
  workspaceId: "907479",
  name: "my-bucket",
  region: "in-south-2",
});

Non-2xx responses throw an ApiError carrying the HTTP status and parsed body:

import { ApiError } from "ibee-sdk";
try {
  await client.secretStore.listSecretStores({ workspaceId: "907479" });
} catch (err) {
  if (err instanceof ApiError) {
    console.error(err.statusCode, err.body);
  }
}

Billing eligibility preflight

Before a billable create, ask billing whether the workspace is allowed to create the SKU. Proceed only when allowed is true; the token needs billing.read in addition to the product write scope.

eligibility = client.billing.check_resource_eligibility(
    workspace_id="907479", sku_code="OBJECTST-STD"
)
if not eligibility.allowed:
    raise RuntimeError(f"Blocked by billing: {eligibility.reason}")
bucket = client.object_storage.create_bucket(
    workspace_id="907479", name="my-bucket"
)

The decision is point-in-time and does not reserve funds, so run it immediately before the create request. The SDKs and CLI do not invoke it automatically.

Command-line interface

Prefer the terminal? The ibee CLI is built on the Python SDK and covers the same products.

pip install ibee-cli
export IBEE_TOKEN="ibee_prod_key_xxxxxxxxxxxx"
export IBEE_WORKSPACE_ID="907479"
ibee buckets list
ibee buckets create my-bucket --region in-south-2
ibee secrets stores list
ibee compute sites
ibee vpcs list
ibee vms list

See the CLI reference for all commands.

Resource reference

Both SDKs expose the same resources (Python uses snake_case, TypeScript uses camelCase):

Using the API without an SDK

You can call the REST API directly using any HTTP client:

curl https://api.ibee.ai/v1/object-storage/buckets?workspace_id=907479 \
  -H "Authorization: Bearer ibee_prod_key_xxxxxxxxxxxx"