Skip to content

Install ​

bash
bun add @socifyr/sdk
bash
pnpm add @socifyr/sdk
bash
npm install @socifyr/sdk
bash
yarn add @socifyr/sdk

Runtime support ​

RuntimeSupported
Node.js 20+✓
Bun 1.0+✓
Deno (npm specifier)✓
Cloudflare Workers✓
Edge runtimes (Vercel, Netlify)✓
Browser✗ — never ship an API key client-side

The SDK is built as both CJS and ESM and ships full TypeScript declarations.

First call ​

typescript
import { Socifyr } from '@socifyr/sdk'

const socifyr = new Socifyr({
  apiKey: process.env.SOCIFYR_API_KEY!,
  workspaceId: process.env.SOCIFYR_WORKSPACE_ID!,
})

const workspaces = await socifyr.workspaces.list()
console.log(workspaces[0].name)

If that returns the expected workspace, you're good. Continue with Configuration.