# Zorveus documentation

> Zorveus is an AI inference gateway with product-user allowances, credits, and wallet billing.

Choose the funding path first: organization-funded products use inference keys; user-funded apps use OAuth.
Use an inference key for model requests and a service key for product-user management. Keep keys server-side.
OpenAI base URL: https://api.zorveus.com/v1. Anthropic base URL: https://api.zorveus.com.
Management base URL: https://api.zorveus.com. Model catalog: https://www.zorveus.com/models.

Start with /getting-started/integrate-your-product for organization-funded integration.
Read /startups/check-allowance before adding admission checks. Credits alone are not total available allowance.

The links below return source Markdown with MDX components. Code fences include every SDK tab.
The corresponding HTML page URL appears after each link.

## overview

- [Zorveus documentation](https://docs.zorveus.com/api/raw-doc?slug=): Zorveus is an AI wallet, billing layer, and multi-provider gateway designed for two main developer workflows. HTML: https://docs.zorveus.com/

## account and organizations

- [Account Security](https://docs.zorveus.com/api/raw-doc?slug=account-and-organizations%2Faccount-security): Manage passwords, active browser sessions, and security settings. HTML: https://docs.zorveus.com/account-and-organizations/account-security
- [Connected Applications](https://docs.zorveus.com/api/raw-doc?slug=account-and-organizations%2Fconnected-apps): Inspect and revoke third-party OAuth apps authorized on your wallet. HTML: https://docs.zorveus.com/account-and-organizations/connected-apps
- [Members & Invites](https://docs.zorveus.com/api/raw-doc?slug=account-and-organizations%2Fmembers-and-invites): Invite team members, configure RBAC roles, and manage invitations. HTML: https://docs.zorveus.com/account-and-organizations/members-and-invites
- [Notification settings](https://docs.zorveus.com/api/raw-doc?slug=account-and-organizations%2Fnotification-settings): Configure email alerts for spending cap thresholds, wallet low-balance warnings, and invites. HTML: https://docs.zorveus.com/account-and-organizations/notification-settings
- [Organizations](https://docs.zorveus.com/api/raw-doc?slug=account-and-organizations%2Forganizations): Create and manage Business workspaces and personal funding accounts. HTML: https://docs.zorveus.com/account-and-organizations/organizations

## api reference

- [Apps & Connections API](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Fapps): Configure apps and connections in the Zorveus dashboard. HTML: https://docs.zorveus.com/api-reference/apps
- [Authentication](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Fauthentication): Authentication methods for the Zorveus API. HTML: https://docs.zorveus.com/api-reference/authentication
- [Spending Caps API](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Fcaps): Reference and interactive runner for spending caps operations. HTML: https://docs.zorveus.com/api-reference/caps
- [Models Catalog API](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Fmodels): Routable model discovery HTML: https://docs.zorveus.com/api-reference/models
- [Notification settings API](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Fnotifications): Read and update the current dashboard user's notification preferences. HTML: https://docs.zorveus.com/api-reference/notifications
- [OAuth API](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Foauth): Authorization Code with PKCE, consent decisions, token exchange, and revocation operations. HTML: https://docs.zorveus.com/api-reference/oauth
- [Organizations API](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Forganizations): Organizations, members, invitations, onboarding, service keys, and outbound webhooks. HTML: https://docs.zorveus.com/api-reference/organizations
- [API reference overview](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Foverview): Complete REST API Reference for the Zorveus Management and Product API on api.zorveus.com. HTML: https://docs.zorveus.com/api-reference/overview
- [Product Users & Credits API](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Fproduct-users): Supported service-key operations for product users identified by external user ID. HTML: https://docs.zorveus.com/api-reference/product-users
- [Provider credentials](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Fprovider-credentials): Manage provider credentials in the dashboard, not through application API requests. HTML: https://docs.zorveus.com/api-reference/provider-credentials
- [Usage & Analytics API](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Fusage): Reference and interactive runner for usage & analytics operations. HTML: https://docs.zorveus.com/api-reference/usage
- [Wallets & Top-Ups API](https://docs.zorveus.com/api/raw-doc?slug=api-reference%2Fwallet): Reference and interactive runner for wallets & top-ups operations. HTML: https://docs.zorveus.com/api-reference/wallet

## concepts

- [Apps, connections, and keys](https://docs.zorveus.com/api/raw-doc?slug=concepts%2Fapps-connections-and-keys): Understand the relational hierarchy linking organizations, apps, app connections, and API keys. HTML: https://docs.zorveus.com/concepts/apps-connections-and-keys
- [System architecture](https://docs.zorveus.com/api/raw-doc?slug=concepts%2Farchitecture): Understand how your application, Zorveus, model providers, and user allowances fit together. HTML: https://docs.zorveus.com/concepts/architecture
- [Caps and credits](https://docs.zorveus.com/api/raw-doc?slug=concepts%2Fcaps-and-credits): Compare base spending allowances with consumable product-user credit grants. HTML: https://docs.zorveus.com/concepts/caps-and-credits
- [Funding and billing](https://docs.zorveus.com/api/raw-doc?slug=concepts%2Ffunding-and-billing): Understand wallet-funded inference, BYOK routing, and credit enforcement modes. HTML: https://docs.zorveus.com/concepts/funding-and-billing
- [Models and Routing](https://docs.zorveus.com/api/raw-doc?slug=concepts%2Fmodels-and-routing): Learn about provider-prefixed model names, wildcard policies, credential resolution, and managed routing. HTML: https://docs.zorveus.com/concepts/models-and-routing
- [Organizations](https://docs.zorveus.com/api/raw-doc?slug=concepts%2Forganizations): Understand organization types, ownership boundaries, member permissions, and funding contexts. HTML: https://docs.zorveus.com/concepts/organizations
- [Usage and cost accounting](https://docs.zorveus.com/api/raw-doc?slug=concepts%2Fusage-and-cost): Understand how Zorveus calculates virtual spend, wallet charges, provider costs, and cache-aware token usage. HTML: https://docs.zorveus.com/concepts/usage-and-cost

## getting started

- [Bring your own key (BYOK) quickstart](https://docs.zorveus.com/api/raw-doc?slug=getting-started%2Fbyok-quickstart): Connect an upstream provider credential and route eligible inference through it. HTML: https://docs.zorveus.com/getting-started/byok-quickstart
- [Integrate with a coding agent](https://docs.zorveus.com/api/raw-doc?slug=getting-started%2Fcoding-agents): Copy an integration prompt tailored to Business or Developer OAuth. HTML: https://docs.zorveus.com/getting-started/coding-agents
- [Integrate an organization-funded product](https://docs.zorveus.com/api/raw-doc?slug=getting-started%2Fintegrate-your-product): Connect inference, customer attribution, subscription allowances, payments, and limit handling in one workflow. HTML: https://docs.zorveus.com/getting-started/integrate-your-product
- [OAuth App Quickstart](https://docs.zorveus.com/api/raw-doc?slug=getting-started%2Foauth-app-quickstart): Allow users to connect their Zorveus AI wallet to your application using Authorization Code with PKCE. HTML: https://docs.zorveus.com/getting-started/oauth-app-quickstart
- [Getting started](https://docs.zorveus.com/api/raw-doc?slug=getting-started%2Foverview): Choose the right Zorveus integration path for your architecture and business model. HTML: https://docs.zorveus.com/getting-started/overview
- [Product-user quickstart](https://docs.zorveus.com/api/raw-doc?slug=getting-started%2Fproduct-user-quickstart): Attribute AI inference requests to your own customers using inline external user metadata. HTML: https://docs.zorveus.com/getting-started/product-user-quickstart
- [Business Quickstart](https://docs.zorveus.com/api/raw-doc?slug=getting-started%2Fstartup-quickstart): Control AI inference spending, attach plan-based spend caps, and send your first request through Zorveus. HTML: https://docs.zorveus.com/getting-started/startup-quickstart

## inference

- [Audio transcription and speech](https://docs.zorveus.com/api/raw-doc?slug=inference%2Faudio): Transcribe audio files and synthesize speech through supported OpenAI-compatible routes. HTML: https://docs.zorveus.com/inference/audio
- [Chat completions](https://docs.zorveus.com/api/raw-doc?slug=inference%2Fchat-completions): Generate text and reasoning completions across OpenAI, Anthropic, Gemini, and open models. HTML: https://docs.zorveus.com/inference/chat-completions
- [Embeddings](https://docs.zorveus.com/api/raw-doc?slug=inference%2Fembeddings): Generate dense vector embeddings for semantic retrieval, similarity search, and RAG pipelines. HTML: https://docs.zorveus.com/inference/embeddings
- [Image generation](https://docs.zorveus.com/api/raw-doc?slug=inference%2Fimages): Generate images and visual assets through OpenAI DALL-E and compatible models. HTML: https://docs.zorveus.com/inference/images
- [Model discovery](https://docs.zorveus.com/api/raw-doc?slug=inference%2Fmodel-discovery): Query the models endpoint to discover live available models permitted for your API key. HTML: https://docs.zorveus.com/inference/model-discovery
- [Content moderation](https://docs.zorveus.com/api/raw-doc?slug=inference%2Fmoderation): Check inputs and outputs against safety and content moderation models. HTML: https://docs.zorveus.com/inference/moderation
- [Inference overview](https://docs.zorveus.com/api/raw-doc?slug=inference%2Foverview): Overview of multi-provider wire protocols and inference capabilities supported on api.zorveus.com. HTML: https://docs.zorveus.com/inference/overview
- [Product-user metadata](https://docs.zorveus.com/api/raw-doc?slug=inference%2Fproduct-user-metadata): Pass custom customer identifiers, names, emails, and tracking tags inside inference requests. HTML: https://docs.zorveus.com/inference/product-user-metadata
- [Realtime client secrets](https://docs.zorveus.com/api/raw-doc?slug=inference%2Frealtime): Create a short-lived client secret for a supported realtime model session. HTML: https://docs.zorveus.com/inference/realtime
- [Rerank](https://docs.zorveus.com/api/raw-doc?slug=inference%2Frerank): Rerank document search results for optimized retrieval accuracy in RAG workflows. HTML: https://docs.zorveus.com/inference/rerank
- [Responses API](https://docs.zorveus.com/api/raw-doc?slug=inference%2Fresponses): Generate a response through the OpenAI-compatible Responses API. HTML: https://docs.zorveus.com/inference/responses
- [Streaming completions](https://docs.zorveus.com/api/raw-doc?slug=inference%2Fstreaming): Stream completion events over Server-Sent Events through the Zorveus gateway. HTML: https://docs.zorveus.com/inference/streaming
- [Tool calling](https://docs.zorveus.com/api/raw-doc?slug=inference%2Ftool-calling): Execute structured function calls and JSON schema tools across supported models. HTML: https://docs.zorveus.com/inference/tool-calling

## oauth

- [App review and publishing](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Fapp-review): Submit an OAuth app for review and understand each lifecycle state. HTML: https://docs.zorveus.com/oauth/app-review
- [Authorization request](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Fauthorization-request): Build an OAuth authorization URL with PKCE, scopes, and state. HTML: https://docs.zorveus.com/oauth/authorization-request
- [Consent and spending caps](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Fconsent-and-caps): Understand the wallet, permissions, and cap selected during OAuth consent. HTML: https://docs.zorveus.com/oauth/consent-and-caps
- [OAuth error handling](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Ferrors): Handle OAuth redirect errors, invalid redirect URIs, and token exchange failure codes. HTML: https://docs.zorveus.com/oauth/errors
- [OAuth 2.0 overview](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Foverview): Actors, returned data, and the authorization-code PKCE flow for connectable AI applications. HTML: https://docs.zorveus.com/oauth/overview
- [Reauthorization](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Freauthorization): Replace an OAuth token and update the existing app connection. HTML: https://docs.zorveus.com/oauth/reauthorization
- [Register an OAuth app](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Fregister-an-app): Create a developer app and configure its redirect URIs, scopes, models, and cap policy. HTML: https://docs.zorveus.com/oauth/register-an-app
- [Token revocation](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Frevocation): Revoke an OAuth-issued inference token and its app connection. HTML: https://docs.zorveus.com/oauth/revocation
- [Testing Draft Apps](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Ftesting-draft-apps): Add test-user email allowlists to test OAuth applications prior to public review. HTML: https://docs.zorveus.com/oauth/testing-draft-apps
- [Token exchange](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Ftoken-exchange): Exchange short-lived authorization codes and PKCE verifiers for scoped inference tokens. HTML: https://docs.zorveus.com/oauth/token-exchange
- [Use the scoped OAuth token](https://docs.zorveus.com/api/raw-doc?slug=oauth%2Fuse-the-token): Execute inference calls using the user-provided OAuth access token. HTML: https://docs.zorveus.com/oauth/use-the-token

## platform

- [Authentication and credentials](https://docs.zorveus.com/api/raw-doc?slug=platform%2Fauthentication): Choose the credential and headers required by each Zorveus API surface. HTML: https://docs.zorveus.com/platform/authentication
- [Base URLs and environments](https://docs.zorveus.com/api/raw-doc?slug=platform%2Fbase-urls): Use the correct production host for inference, management, dashboard, and OAuth traffic. HTML: https://docs.zorveus.com/platform/base-urls
- [Error handling](https://docs.zorveus.com/api/raw-doc?slug=platform%2Ferrors): Handle product API and OpenAI-compatible gateway errors without relying on message text. HTML: https://docs.zorveus.com/platform/errors
- [Idempotency](https://docs.zorveus.com/api/raw-doc?slug=platform%2Fidempotency): Retry only the operations that define an idempotency contract. HTML: https://docs.zorveus.com/platform/idempotency
- [Money and dates](https://docs.zorveus.com/api/raw-doc?slug=platform%2Fmoney-and-dates): Preserve decimal amounts and timezone-aware timestamps across clients. HTML: https://docs.zorveus.com/platform/money-and-dates
- [Pagination](https://docs.zorveus.com/api/raw-doc?slug=platform%2Fpagination): Follow the pagination contract defined by each list endpoint. HTML: https://docs.zorveus.com/platform/pagination
- [Rate limits](https://docs.zorveus.com/api/raw-doc?slug=platform%2Frate-limits): Handle Zorveus and upstream provider throttling safely. HTML: https://docs.zorveus.com/platform/rate-limits
- [Security](https://docs.zorveus.com/api/raw-doc?slug=platform%2Fsecurity): Protect Zorveus credentials, OAuth flows, provider secrets, and webhook endpoints. HTML: https://docs.zorveus.com/platform/security
- [Outbound Webhooks](https://docs.zorveus.com/api/raw-doc?slug=platform%2Fwebhooks): Receive real-time HTTP event notifications for balance alerts, payment events, and product user spending caps. HTML: https://docs.zorveus.com/platform/webhooks

## providers

- [Anthropic provider setup](https://docs.zorveus.com/api/raw-doc?slug=providers%2Fanthropic): Configure Anthropic Claude API keys, native wire protocol, and model routing. HTML: https://docs.zorveus.com/providers/anthropic
- [AWS Bedrock provider setup](https://docs.zorveus.com/api/raw-doc?slug=providers%2Faws-bedrock): Check and configure the runtime credential contract for AWS Bedrock routes. HTML: https://docs.zorveus.com/providers/aws-bedrock
- [Azure OpenAI provider setup](https://docs.zorveus.com/api/raw-doc?slug=providers%2Fazure-openai): Configure Azure OpenAI Service deployments and custom endpoint routing. HTML: https://docs.zorveus.com/providers/azure-openai
- [Google Gemini provider setup](https://docs.zorveus.com/api/raw-doc?slug=providers%2Fgemini): Configure Google AI Studio Gemini API keys, native wire protocol, and multimodal routing. HTML: https://docs.zorveus.com/providers/gemini
- [NVIDIA NIM provider setup](https://docs.zorveus.com/api/raw-doc?slug=providers%2Fnvidia-nim): Connect NVIDIA API Catalog and NIM microservice credentials. HTML: https://docs.zorveus.com/providers/nvidia-nim
- [OpenAI provider setup](https://docs.zorveus.com/api/raw-doc?slug=providers%2Fopenai): Configure OpenAI BYOK credentials, model wildcards, and direct routing. HTML: https://docs.zorveus.com/providers/openai
- [OpenRouter provider setup](https://docs.zorveus.com/api/raw-doc?slug=providers%2Fopenrouter): Connect OpenRouter API keys to access DeepSeek, Llama 3, and open-weights models. HTML: https://docs.zorveus.com/providers/openrouter
- [Provider integrations](https://docs.zorveus.com/api/raw-doc?slug=providers%2Foverview): Discover and configure upstream credentials for Bring Your Own Key routing. HTML: https://docs.zorveus.com/providers/overview

## resources

- [Changelog and release notes](https://docs.zorveus.com/api/raw-doc?slug=resources%2Fchangelog): Track documentation-visible changes to Zorveus integration contracts. HTML: https://docs.zorveus.com/resources/changelog
- [Code examples and SDK recipes](https://docs.zorveus.com/api/raw-doc?slug=resources%2Fexamples): Find the shortest verified example for each integration path. HTML: https://docs.zorveus.com/resources/examples
- [Frequently asked questions](https://docs.zorveus.com/api/raw-doc?slug=resources%2Ffaq): Answers about credentials, product users, billing, Bring Your Own Key routing, latency, and stored usage data. HTML: https://docs.zorveus.com/resources/faq
- [Support and security reports](https://docs.zorveus.com/api/raw-doc?slug=resources%2Fsupport): Get integration help, report a vulnerability, or check service status. HTML: https://docs.zorveus.com/resources/support
- [Troubleshooting](https://docs.zorveus.com/api/raw-doc?slug=resources%2Ftroubleshooting): Diagnose inference, product-user, service-key, provider, streaming, and OAuth failures. HTML: https://docs.zorveus.com/resources/troubleshooting

## Business

- [Set allowance periods and anchors](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fallowance-periods): Align daily or monthly product-user allowances with a subscription start date. HTML: https://docs.zorveus.com/startups/allowance-periods
- [API keys](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fapi-keys): Create, rotate, scope, and revoke gateway API keys. HTML: https://docs.zorveus.com/startups/api-keys
- [Managing apps](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fapps): Create and configure applications, model allowlists, credit modes, and overrun policies in the Zorveus dashboard. HTML: https://docs.zorveus.com/startups/apps
- [Automatic Routing](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fautomatic-routing): Understand exact and wildcard routing policies, priority ordering, and provider fallback resolution. HTML: https://docs.zorveus.com/startups/automatic-routing
- [Grant credits after a payment](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fbilling-integration): Connect verified customer payments to product-user credit grants without confusing them with wallet top-ups. HTML: https://docs.zorveus.com/startups/billing-integration
- [Check available allowance](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fcheck-allowance): Read total spendable allowance without confusing credit grants with a user's remaining base allowance. HTML: https://docs.zorveus.com/startups/check-allowance
- [Configure product-user allowances](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fconfigure-product-user-allowances): Choose model access, caps, enforcement, and overrun settings with practical examples. HTML: https://docs.zorveus.com/startups/configure-product-user-allowances
- [Product-user credit grants](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fcredit-grants): Allocate consumable credit to one product user and configure connection credit modes. HTML: https://docs.zorveus.com/startups/credit-grants
- [Team Members and Roles](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fmembers): Manage organization members, invite teammates, and understand internal team attribution. HTML: https://docs.zorveus.com/startups/members
- [Manage product users](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fproduct-users): Look up and update your customers, then read their usage, credits, and allowance. HTML: https://docs.zorveus.com/startups/product-users
- [Provider credentials](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fprovider-credentials): Configure Bring Your Own Key credentials in the Zorveus dashboard. HTML: https://docs.zorveus.com/startups/provider-credentials
- [Service keys](https://docs.zorveus.com/api/raw-doc?slug=startups%2Fservice-keys): Authenticate server-to-server management requests with organization-scoped permissions. HTML: https://docs.zorveus.com/startups/service-keys

## wallet and billing

- [BYOK pricing and cost accounting](https://docs.zorveus.com/api/raw-doc?slug=wallet-and-billing%2Fbyok-costs): Understand pricing thresholds, wallet settlement, virtual spend, and provider costs for Bring Your Own Key requests. HTML: https://docs.zorveus.com/wallet-and-billing/byok-costs
- [Spending caps](https://docs.zorveus.com/api/raw-doc?slug=wallet-and-billing%2Fcaps): Configure daily, monthly, or lifetime spending caps and overrun policies in the Zorveus dashboard. HTML: https://docs.zorveus.com/wallet-and-billing/caps
- [Wallet ledger](https://docs.zorveus.com/api/raw-doc?slug=wallet-and-billing%2Fledger): Inspect the transaction audit feed and ledger entries in the Zorveus dashboard. HTML: https://docs.zorveus.com/wallet-and-billing/ledger
- [Promotional Codes](https://docs.zorveus.com/api/raw-doc?slug=wallet-and-billing%2Fpromotions): Redeem promotional coupon codes and understand eligibility criteria. HTML: https://docs.zorveus.com/wallet-and-billing/promotions
- [Top-Up Return Flow](https://docs.zorveus.com/api/raw-doc?slug=wallet-and-billing%2Ftop-up-return-flow): Understand post-payment return flows, session polling, and webhook confirmations. HTML: https://docs.zorveus.com/wallet-and-billing/top-up-return-flow
- [Wallet Top-Ups](https://docs.zorveus.com/api/raw-doc?slug=wallet-and-billing%2Ftop-ups): Add funds to your organization wallet using supported payment gateways. HTML: https://docs.zorveus.com/wallet-and-billing/top-ups
- [Usage analytics](https://docs.zorveus.com/api/raw-doc?slug=wallet-and-billing%2Fusage): Monitor inference volume, inspect cache-aware token breakdowns, and track financial metrics in the Zorveus dashboard. HTML: https://docs.zorveus.com/wallet-and-billing/usage
- [Usage filters and time series](https://docs.zorveus.com/api/raw-doc?slug=wallet-and-billing%2Fusage-filters): Filter usage by application, connection, product user, model, provider, billing mode, member, and time. HTML: https://docs.zorveus.com/wallet-and-billing/usage-filters
- [Wallets and balances](https://docs.zorveus.com/api/raw-doc?slug=wallet-and-billing%2Fwallets): Manage prepaid organization balances, balance reservations, and wallet top-ups in the Zorveus dashboard. HTML: https://docs.zorveus.com/wallet-and-billing/wallets