SWIRLS_
ReferenceSDK

SDK

Reference documentation for the Swirls TypeScript SDK (@swirls/sdk).

The @swirls/sdk package provides a type-safe TypeScript client for the Swirls API.

Installation

npm install @swirls/sdk

Client

The Client exposes the full Swirls API as type-safe procedures (graphs, forms, triggers, and more). Use it when you need to call individual API endpoints.

import { Swirls } from '@swirls/sdk/client'

const swirls = new Swirls({ apiKey: 'your-api-key' })

const projects = await swirls.client.projects.listProjects()

See Client for all 11 namespaces.

On this page