Zorveus Documentation

Choose the right Zorveus integration path for your architecture and business model.

Zorveus provides three core integration models depending on who funds the AI usage and how credentials are managed.

Choose your integration mode

Business Goal	Integration Mode	Funding Source	Key Credential
Business funds its own product	Business Quickstart	Business Organization Wallet	API Key (`zrv_...`)
Business uses existing provider credentials	BYOK Quickstart	Upstream Provider (Direct)	API Key + Stored Provider Secret
End-user funds third-party app	OAuth App Quickstart	User's Personal/Company Wallet	Scoped OAuth Token (`zrv_...`)

Credential terminology

Understanding credential types ensures you use the correct secret in each context:

API Key (zrv_...): Secret token used in Authorization: Bearer zrv_... against the model gateway (https://api.zorveus.com/v1 or native wire endpoints). Used to execute model inference and inspect connection spend. Shown only once upon creation.
Service Key (zrv_svc_...): Server-to-server credential for supported /product-users/by-external-id operations at https://api.zorveus.com; never expose this key in browser code and do not pass it to inference endpoints.
Client ID & Client Secret (zrv_client_... / zrv_client_secret_...): Credentials for registered OAuth applications to authenticate during PKCE token exchanges.
Provider Credential: Encrypted upstream API keys (e.g. OpenAI, Anthropic, Gemini) stored in Zorveus for Bring Your Own Key (BYOK) routing.

Production endpoints

Always use production endpoints in deployed applications:

Inference Base URL:  https://api.zorveus.com/v1
Management Base URL: https://api.zorveus.com
OAuth Authorize URL: https://app.zorveus.com/oauth/authorize

Use Integrate an organization-funded product for the full workflow, including attribution, plan keys, allowances, payments, and errors. Use Integrate with a coding agent for a copyable prompt and source links.

Business Quickstart

Send your first request with an OpenAI-compatible client or Zorveus SDK.

Product-User Metering

Attribute requests to specific end users and apply credit grants without extra database setup.

Bring Your Own Key (BYOK)

Attach your existing provider accounts to Zorveus for cost tracking and unified routing.

OAuth PKCE Flow

Implement secure OAuth 2.0 PKCE login so users pay for their own inference in your app.

Was this page helpful?

Edit this page on GitHub

Getting started