Skip to main content

SDK Overview

Use the SDK when you want typed, maintainable integration code instead of raw HTTP calls.

Step 1: Install the SDK​

pnpm add @chyper/sdk

Step 2: Configure Environment Variables​

CHYPER_API_BASE=https://your-api-base
CHYPER_API_KEY=your-api-key

Step 3: Initialize the Client​

import { ChyperClient } from "@chyper/sdk";

const client = new ChyperClient({
  baseURL: process.env.CHYPER_API_BASE,
  accessToken: process.env.CHYPER_API_KEY,
});

Step 4: Run a First Read Operation​

const projects = await client.projects.list();
console.log(projects.length);

Step 5: Add a Controlled Write Operation​

  1. Validate inputs before calling SDK write methods.
  2. Apply role-based controls in your app.
  3. Log operation outcomes for auditability.
  1. SDK authentication setup.
  2. Read operations.
  3. Write operations with approval gates.
  4. Streaming and event-driven behavior.

Continue with SDK Authentication and SDK Resources.