Installation
Quickstart
TypeScript
Configuration
TypeScript
Response envelope
All successful responses follow the same envelope:JSON
JSON
Runtime compatibility
| Runtime | Supported | Notes |
|---|---|---|
| Node.js 18+ | ✅ | Uses native fetch and crypto.subtle |
| Deno | ✅ | Web standard APIs |
| Bun | ✅ | Web standard APIs |
| Cloudflare Workers | ✅ | Edge runtime compatible |
| Vercel Edge Functions | ✅ | Edge runtime compatible |
| Modern Browsers | ✅ | ESM bundle, crypto.subtle required |
| Node.js < 18 | ❌ | No native fetch, use a polyfill or upgrade |
Package exports
JSON
TypeScript
TypeScript support
The SDK is written in TypeScript and ships.d.ts declarations. All response types are exported:
TypeScript