> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qumo-deploy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# TypeScript SDK Overview

> Programmatically orchestrate Qumo Deploy control plane resources with type-safety.

# 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

<CardGroup cols={2}>
  <Card title="Quickstart Guide" icon="bolt" href="/sdk/quickstart">
    Install the package across npm, pnpm, yarn, bun, or Deno and make your first API request.
  </Card>

  <Card title="Client Reference" icon="code" href="/sdk/client-reference">
    Learn about `QumoClient`, configuration parameters, and resource accessors.
  </Card>

  <Card title="Code Recipes" icon="book-open" href="/sdk/recipes">
    Practical code examples for minting relay tokens, managing projects, and setting up CI bots.
  </Card>

  <Card title="Error Handling & Types" icon="shield-check" href="/sdk/error-handling">
    Comprehensive guide to `APIError`, HTTP status handling, and exported TypeScript interfaces.
  </Card>
</CardGroup>

***

## Quick Example

```typescript theme={null}
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);
```