Skip to main content
All API requests require authentication via an API key passed in the x-api-key HTTP header.

Getting your API key

  1. Sign in to your sunor dashboard.
  2. Navigate to API Keys.
  3. Click Create API Key and give it a name.
  4. Copy the key immediately — it will only be shown once.

Using your API key

Include the x-api-key header in every request:

Error responses

Example error response:
Every public API response includes an X-Request-Id header for correlation. You may send your own safe X-Request-Id value, or let Sunor generate one. Authentication failures occur before an API key’s quota can be read, so an early 401 can omit X-RateLimit-Remaining.

Security tips

Never expose your API key in client-side code. API keys should only be used in server-side applications or secure environments.
  • Store your API key in environment variables, not in source code.
  • Rotate keys periodically from the API Keys page.
  • If you suspect a key has been compromised, delete it immediately and create a new one.
  • Each key is tied to your account — anyone with the key can use your credits.