Authentication
All API requests require a Bearer token. API keys are scoped to a single project and begin with sk_live_.
Using the SDK
Pass your API key when creating the client. The SDK handles the Authorization header automatically.
import { HelmdeskClient } from '@helmdesk/sdk'
const helmdesk = new HelmdeskClient({
apiKey: process.env.HELMDESK_API_KEY!,
})Using curl / fetch
Include the key in the Authorization header:
curl -H "Authorization: Bearer sk_live_abc123..." \
https://helmdesk.dev/api/v1/ticketsManaging keys
Create and revoke API keys from Dashboard → Project → API Keys. Each project can have multiple active keys. If a key is compromised, revoke it immediately and create a new one.
Security note
Never expose your API key in client-side code or commit it to version control. Use environment variables and keep your keys server-side.