> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sumvin.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the SDK

> Add @sumvin/sdk to a project, check your runtime, and pick the entry point you need.

export const waitlists = {
  earlyAccess: "https://sumvin.com/?interest=early_access&utm_source=docs&utm_medium=banner&utm_campaign=early_access#waitlist",
  payments: "https://sumvin.com/?interest=payments&utm_source=docs&utm_medium=banner&utm_campaign=payments#waitlist",
  openBanking: "https://sumvin.com/?interest=open_banking&utm_source=docs&utm_medium=banner&utm_campaign=open_banking#waitlist",
  developers: "https://sumvin.com/developers?interest=cli,agent_plugin&utm_source=docs&utm_medium=banner&utm_campaign=developers#access",
  verifiers: "https://sumvin.com/developers?interest=verifiers&utm_source=docs&utm_medium=banner&utm_campaign=verifiers#access"
};

<Note>
  **Private preview:** this is rolling out and may not be available on your account yet.{waitlists.earlyAccess ? <> <a href={waitlists.earlyAccess}>Request early access →</a></> : null}
</Note>

<CodeGroup>
  ```bash bun theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
  bun add @sumvin/sdk
  ```

  ```bash npm theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
  npm install @sumvin/sdk
  ```

  ```bash pnpm theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
  pnpm add @sumvin/sdk
  ```
</CodeGroup>

The package ships ESM and CommonJS builds with type definitions. Its only runtime dependency is `zod`.

## Runtimes

| Runtime | Supported |
| - | - |
| Node.js 20 or later | Yes |
| Evergreen browsers | Yes |
| Cloudflare Workers | Yes |
| Bun | Works, but the SDK's own test suite does not yet run under Bun in CI |

## Entry points

| Import | What's in it | Extra packages |
| - | - | - |
| `@sumvin/sdk` | Every API operation, its types and schemas, plus authentication, errors and the ceiling reader. | None |
| `@sumvin/sdk/react` | Query options for TanStack Query. | `react`, `@tanstack/react-query` |
| `@sumvin/sdk/testing` | `fakeFetch`, for tests only. See [Testing](/sdk/testing). | None |

## Next

<Card title="Make a client" icon="plug" href="/sdk/client">
  Point the SDK at the API and choose how it authenticates.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.