Client

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

• Folders — Organize resources into folders within a project. (5 methods)
• Graphs — Create, update, execute, and manage workflow graphs, nodes, and edges. (16 methods)
• Triggers — Connect resources (forms, webhooks, schedules, agents) to graphs so they execute automatically. (7 methods)
• Agents — Create and manage AI agents with system prompts and tool bindings. (5 methods)
• Schemas — Create and manage reusable JSON Schema definitions for validation. (6 methods)
• Forms — Create and manage forms that can trigger graph executions. (8 methods)
• Documents — Create and manage documents that can be referenced in document nodes. (5 methods)
• Webhooks — Create and manage webhook endpoints that can trigger graph executions. (6 methods)
• Schedules — Create and manage cron schedules that can trigger graph executions. (6 methods)
• Streams — Persist graph execution output to structured data tables and query the results. (10 methods)
• Storage — Manage saved SQL queries and execute queries against project storage. (6 methods)
• Reviews — Human-in-the-loop reviews that pause graph execution until approved or rejected. (4 methods)
• Projects — Manage projects, storage provisioning, and project settings. (5 methods)
• Secrets — Manage encrypted secrets (key-value pairs) scoped to a project. (5 methods)
• Buckets — Manage file storage buckets, upload/download files, and create signed URLs. (8 methods)
• API Keys — Create, list, and revoke API keys for programmatic access. (3 methods)