Skip to main content
Ringg API requests use a workspace API key in the X-API-KEY header.
Treat the API key as a server-side secret. Do not include it in browser JavaScript, mobile app bundles, public repositories, screenshots, logs, or support tickets.

Get your API key

  1. Log in to the Ringg AI dashboard.
  2. Open Settings β†’ API Key from the dashboard sidebar.
  3. Click Generate API Key and copy it immediately.
The key is shown only once, at the moment it is generated. It cannot be retrieved afterwards β€” the dashboard stores only a masked form of it. If you lose it, regenerate from the same screen, which immediately revokes the old key and breaks any integration still using it.
Ringg dashboard API key screen

X-API-KEY

Regenerating an API key immediately invalidates the previous key. Update every backend service that uses the old key before relying on the new one.

Send the API key

Successful response

GET /workspace is the simplest authentication check.

Production practices

  • Store the key in a secret manager or environment variable.
  • Use one backend service as the integration boundary when possible.
  • Rotate the key if you suspect it’s been exposed.
  • Avoid logging request headers.
  • Alert on unexpected usage volume or repeated 401 responses.
  • Use HTTPS for every API call.

Troubleshooting

Next steps

Quick Start Guide

Use the key to make your first call.

Workspace Info

Read your workspace details.