Zorveus LogoZorveusDOCS
Business

API keys

View Markdown

Create, rotate, scope, and revoke gateway API keys.

API keys (zrv_...) authenticate requests against the OpenAI-compatible gateway (https://api.zorveus.com/v1) and provider-native wire endpoints.

Before serving customers, read Configure product-user allowances to choose caps, credit mode, and overrun policy.

Optional key for interactive API requests. Stored in memory only.


1. Create an API key in the dashboard

To generate an API key, your account must have an active Business Organization.

Select a Business Organization

Log in to app.zorveus.com. In the top-left organization dropdown, select or create a Business organization. Do not select a Developer Organization; Developer Organizations only register third-party OAuth applications.

Create an app

Open Apps in the sidebar, click Create App, enter an application name, and save.

Generate the key

Inside your app, open the connection settings and click Create API Key. Copy the plaintext secret (zrv_...) immediately.


2. Check live usage and spend cap

You can query the current spending cap, spent amount this period, remaining balance, and reset date directly using the API key itself.

Client SDK / Framework:
curl -X GET "https://api.zorveus.com/inference-keys/usage" \
  -H "Authorization: Bearer zrv_your_api_key"

Response Shape

Capped Connection

{
  "status": "active",
  "app_id": "app_mindspire_123",
  "app_connection_id": "appcon_01j...",
  "currency": "USD",
  "period": "monthly",
  "spend_cap": "50.000000000000",
  "spent_this_period": "12.500000000000",
  "remaining_balance": "37.500000000000",
  "reset_at": "2026-09-01T00:00:00Z"
}

Uncapped Connection

{
  "status": "active",
  "app_id": "app_mindspire_123",
  "app_connection_id": "appcon_01j...",
  "currency": "USD",
  "period": "monthly",
  "spend_cap": null,
  "spent_this_period": "12.500000000000",
  "remaining_balance": null,
  "reset_at": null
}

3. Key rotation without downtime

Create new key

Under your App Connection, click Create Secondary Key.

Deploy to production

Update your backend environment variables (ZORVEUS_API_KEY) with the new secret and deploy.

Revoke old key

Once traffic shifts, click Revoke on the previous key. Revocation is instantaneous across all edge gateway instances.

Was this page helpful?
Edit this page on GitHub

On this page