Install the TypeScript SDK

Requirements

• Node.js 18 or later, or a browser / edge runtime with fetch, Blob, and FormData.
• A Custodian Labs account with an active plan.
• A generated API key.

Install the package

npm install @custodianlabs/sdk

# or
pnpm add @custodianlabs/sdk
yarn add @custodianlabs/sdk

The package ships both ESM and CommonJS builds with TypeScript types, so import and require both work:

import { Custodian } from "@custodianlabs/sdk";

const { Custodian } = require("@custodianlabs/sdk");

Verify the installation

import { Custodian } from "@custodianlabs/sdk";
console.log(typeof Custodian === "function" ? "SDK installed" : "SDK missing");

Next step

Continue to Authentication.