Authentication

All requests to the Vyoma API must be authenticated using an API key.

Getting an API key

Sign in to your Vyoma dashboard
Navigate to API Keys
Create a new key
Copy and store the key securely

Security warning

Never commit API keys to version control. Treat them like passwords.

Using the SDK

client.ts

import { VyomaClient } from "vyoma"

const client = new VyomaClient({
  apiKey: process.env.VYOMA_API_KEY!,
})

Using the REST API

Include your API key in the Authorization header.

curl -X POST http://localhost:3000/api/sandbox/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"templateId":"node-20"}'

Environment variables

Store your API key in an environment variable and load it at runtime.

.env.local

VYOMA_API_KEY=vy_live_xxxxxxxxxxxxx

Rotate API keys periodically and revoke unused keys to maintain security.

Continue with the Quickstart to make your first authenticated request.