API Documentation

Everything you need to integrate KubeBid into your infrastructure. REST API, CLI, and SDK references.

Quick Start

Get up and running in under 5 minutes

1. Install the CLI

# macOS / Linux
curl -sSL https://get.kubebid.io | bash

# Or with Homebrew
brew install kubebid/tap/kubebid

2. Authenticate

# Login with your API key
kubebid auth login --token $KUBEBID_API_KEY

# Or set environment variable
export KUBEBID_API_KEY="kb_live_xxx"

3. Create a Cluster

kubebid cluster create \
  --name "my-cluster" \
  --nodes 3 \
  --instance-type "h100-4x" \
  --max-bid 5.99 \
  --region "us-west-2"

4. Connect with kubectl

# Get kubeconfig
kubebid cluster kubeconfig my-cluster > ~/.kube/config

# Verify connection
kubectl get nodes

REST API Reference

Base URL: https://api.kubebid.io/v1

Authentication

All API requests require authentication via Bearer token in the Authorization header.

curl https://api.kubebid.io/v1/clusters \
  -H "Authorization: Bearer kb_live_xxx"
GET /clusters

List all clusters in your organization.

Response:
{
  "clusters": [{
    "id": "clus_abc123",
    "name": "production",
    "status": "running"
  }]
}
POST /clusters

Create a new cluster with auction-based pricing.

Request Body:
{
  "name": "ml-training",
  "region": "us-west-2",
  "node_pools": [{
    "instance_type": "h100-4x",
    "count": 4,
    "max_bid": 5.99
  }]
}
DELETE /clusters/:id

Delete a cluster and release all resources.

GET /auctions/prices

Get current auction prices for all instance types.

Response:
{
  "prices": [{
    "instance_type": "h100-8x",
    "current_bid": 12.49,
    "availability": "high"
  }]
}

SDKs & Libraries

Official client libraries for popular languages

Python

pip install kubebid
View Documentation

Node.js

npm install @kubebid/sdk
View Documentation

Go

go get github.com/kubebid/go-sdk
View Documentation

Rate Limits

API rate limits by plan tier.

Plan Requests/min Burst Webhooks
Developer 60 100 5
Team 600 1,000 50
Enterprise Unlimited Custom Unlimited

Ready to Build?

Get your API key and start integrating KubeBid today.