SWIRLS_
ReferenceSDKClient

Client

Type-safe API client for the Swirls API. Procedures for graphs, forms, triggers, and more.

The Client wraps the Swirls oRPC contract. Use swirls.client.<namespace>.<procedure>({ input }) to call any endpoint.

Quick start

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

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

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

Namespaces

  • Graphs — Create, update, execute, and manage workflow graphs, nodes, and edges. (5 methods)
  • Deployments — Deploy and inspect project deployments. (4 methods)
  • Forms — Create and manage forms that can trigger graph executions. (3 methods)
  • Webhooks — Create and manage webhook endpoints that can trigger graph executions. (2 methods)
  • Schedules — Create and manage cron schedules that can trigger graph executions. (2 methods)
  • Reviews — Human-in-the-loop reviews that pause graph execution until approved or rejected. (4 methods)
  • Projects — Manage projects and project settings. (11 methods)
  • Billing — Usage, credits, and billing hold information. (3 methods)
  • Secrets — Manage secrets for projects and integrations. (5 methods)
  • Streams — Stream resources and related APIs. (2 methods)
  • Audit — Audit log and compliance queries. (5 methods)

On this page