Skip to main content

Install

Requirements

  • Node.js 18+ — the SDK uses the native fetch API added in Node 18
  • Works in all modern browsers (Chrome 95+, Firefox 90+, Safari 15+)
  • Compatible with edge runtimes: Cloudflare Workers, Vercel Edge Functions, Deno
If you need to use the SDK in Node.js 16 or earlier, pass a custom fetch implementation via the fetchImpl option:

Set up credentials

See the credentials guide for how to generate these values. Client secrets come from Settings → Client Secrets in the dashboard. API keys are generated when you create an app.

Verify your setup

Run this to confirm the SDK can connect and your credentials are valid:
If you see Connected! N app(s) found., you’re ready.

Self-hosted setup

If you’re running Vela on your own infrastructure, pass the baseUrl option pointing to your instance:

TypeScript configuration

The SDK ships with full type declarations. No @types package is needed. Recommended tsconfig.json settings:
For CommonJS projects: