Skip to main content
The API key is the secret your backend sends with every Ringg API request. It identifies the workspace the request acts for, and each workspace has one key. In the dashboard: Settings → API key. For the request format and error codes, see Authentication; to go from a new key to a real call, follow the quickstart.

​
Who can generate the key

In the dashboard, only the workspace owner can generate or regenerate it. Other members see the button disabled, with “Only the workspace owner can generate API keys. Please contact them to proceed.” The owner is marked with an Owner chip on Workspace members. Each Ringg Space has its own key. A new Ringg Space starts without one: switch to it and generate the key on this page.

​
Generate the key

Generating an API key, from Generate API Key to the masked key (the key shown is a demo value)

Have your secret manager open before you start: you get one chance to copy the key.
1

Generate the key

On Settings → API key, click Generate API Key. A dialog opens with the full key.
2

Copy it now

Click Copy (it changes to Copied) and paste the key into your secret manager. If copying fails, select the key in the field and copy it by hand.
Generate API Key dialog showing a fake demo key in a read-only field, a Copied button, the warning to copy and store the key now, and a Done button

The one-time reveal (demo key)

3

Close the dialog

Click Done.
The page shows Generated key (masked) and Created on.
API Key page showing Generated key as a prefix, dots and the last four characters, Created on 1 October 2026, and a Regenerate API Key button

The masked key after the dialog closes

From then on the page shows: New keys start with rg_live_. A key generated earlier can start with ringg_live_ or be a plain UUID, and show no masked form; it keeps working until you regenerate it.

​
Use the key

Send the key in the X-API-KEY header to https://prod-api.ringg.ai/ca/api/v0. Get Workspace Info (GET /workspace) is a quick check that it works:
A 200 response with your workspace’s details in workspace_info means the key works. A 401 with {"message": "Invalid credentials"} means it is missing, mistyped or was regenerated.
The key acts for the whole workspace. It can create agents, start campaigns and place calls that spend your balance.

​
Store it safely

  • Keep it in a secret manager or a server-side environment variable such as RINGG_API_KEY.
  • Call the Ringg API from your backend only. The key must never reach browser JavaScript, a mobile app, a public repository, a screenshot or a support ticket. The web widget has its own public key in the embed code; don’t swap this one in.
  • Hand it to developers through your company’s secret-sharing tool, not email or chat.
  • Don’t log request headers.

​
Rotate the key

Regenerating replaces the key at once, with no overlap: the old key stops working the moment the new one exists.
1

List what uses the key

Backend services, scripts, Zapier, MCP clients, CRMs. Agree a switch-over time with their owners.
2

Regenerate

Click Regenerate API Key, then Regenerate in the confirmation dialog.
3

Copy the new key

The New API Key dialog shows it once. Click Copy, then Done.
4

Update every service

Replace the secret everywhere and redeploy. Until a service has the new key, its requests fail with 401.
If the key has leaked, or might have, rotate it straight away. Keys cannot be created or rotated through the API.

​
Troubleshooting

You are not the workspace owner; ask them (who can generate the key).
It cannot be shown again. Click Regenerate API Key to get a new one; this revokes the key you didn’t copy.
Services still sending the old key are rejected. Compare the last four characters of Generated key with each service’s key and update the ones that differ.
Click Try again. The page won’t offer Generate API Key until it knows whether a key exists, so it can’t replace one by accident.

​
Next steps

Authenticate API requests

Header format, error codes and a first request.

Receive call results

Have Ringg post call events to your server.

Connect an AI assistant

Use the key with Claude, ChatGPT or Cursor over MCP.