Service Keys
Secure server-to-server management credentials for automating organization resources.
Service Keys (zrv_service_...) provide high-privilege programmatic access to the Zorveus Management API (https://api.zorveus.com).
Service Key InserterInteractive
Paste your Zorveus key to dynamically update all code snippets below.
Strict Backend-Only Credential
Service keys must NEVER be included in frontend client bundles, mobile binaries, or browser-rendered code. They possess administrative authority to manage users, grant credits, and configure billing settings.
Service Key Scopes & Role Presets
When generating a Service Key in the Zorveus Dashboard, you can select convenient Role Presets or configure Granular Scopes:
1. Role Presets
| Role Preset | Scope Identifiers | Permissions & Capabilities |
|---|---|---|
| Admin (Full Access) | admin, admin:full, admin:write, * | Complete read & write access to all organization resources, product users, credit grants, app connections, and BYOK credentials. |
| Read-Only | read_only, read, admin:read | Read-only access across all management APIs (e.g. querying users, reading usage logs, auditing credits). Mutation endpoints will return 403 Forbidden. |
2. Granular Scopes
For least-privilege automation, you can restrict service keys to specific resource actions:
| Granular Scope | Description |
|---|---|
product_users:read | Query product user profiles, credit summaries, and metadata. |
product_users:write | Create, upsert, modify status, and delete product users. |
credits:write | Issue credit grants, adjust balances, and revoke active grants. |
app_connections:write | Create, rotate, and manage secondary inference keys and app connections. |
provider_credentials:write | Store and manage encrypted BYOK credentials (OpenAI, Anthropic, Gemini, etc.). |
Authenticating API Requests
Pass the Service Key in the Authorization HTTP header for all requests to https://api.zorveus.com:
curl -X GET "https://api.zorveus.com/product-users/by-external-id?app_id=app_123&external_user_id=usr_456" \
-H "Authorization: Bearer zrv_service_your_service_key"Was this page helpful?
Edit this page on GitHub