Qumo Deploy TypeScript SDK

The @qumo-deploy/sdk package provides complete, strongly-typed TypeScript and JavaScript APIs for interacting with the Qumo Deploy control plane. Designed for server-side runtimes (Node.js 18+, Bun, Deno) as well as web console frontends, the SDK encapsulates authentication, credential minting, project isolation, machine identities, and billing management.

Core Features

Quickstart Guide

Install the package across npm, pnpm, yarn, bun, or Deno and make your first API request.

Client Reference

Learn about QumoClient, configuration parameters, and resource accessors.

Code Recipes

Practical code examples for minting relay tokens, managing projects, and setting up CI bots.

Error Handling & Types

Comprehensive guide to APIError, HTTP status handling, and exported TypeScript interfaces.

Quick Example

import { QumoClient } from "@qumo-deploy/sdk";

const client = new QumoClient({
  baseUrl: "https://api.qumo.dev",
  apiKey: process.env.QUMO_API_KEY,
});

// Mint a short-lived token for relay media ingestion
const credential = await client.credentials.issue({
  scopes: ["relay:session"],
  ttl_seconds: 3600,
});

console.log("Relay auth token:", credential.token);

​Qumo Deploy TypeScript SDK

​Core Features