---
title: API reference overview
description: Complete REST API Reference for the Zorveus Management and Product API on api.zorveus.com.
---

The supported service-key API manages product users by external user ID. Configure organizations, apps, connections, API keys, spending caps, provider credentials, and webhooks in the dashboard. Dashboard routes in this reference are not application integration endpoints.

---

## OpenAPI Specification

The OpenAPI schema is available at the following URL. The schema can include dashboard routes. Inclusion does not make a route a supported service-key endpoint.

```text
https://api.zorveus.com/openapi.json
```

You can import this URL directly into **Postman**, **Insomnia**, **Swagger UI**, or code generation tools (e.g. `openapi-typescript`, `datamodel-code-generator`).

```bash
# Download the public OpenAPI spec
curl -O https://api.zorveus.com/openapi.json
```

---

## Production Servers

| Base URL | Purpose | Authentication |
| :--- | :--- | :--- |
| `https://api.zorveus.com/product-users/by-external-id` | Supported product-user management | `Authorization: Bearer zrv_svc_...` |
| `https://api.zorveus.com/v1` | OpenAI-compatible Inference Gateway | `Authorization: Bearer zrv_...` |

---

## Authentication Credentials

- **API Key (`zrv_...`)**: High-performance bearer token used in `Authorization: Bearer zrv_...` for AI completions on `https://api.zorveus.com/v1` (and native provider wire endpoints) or checking spend on `/inference-keys/usage`.
- **Service Key (`zrv_svc_...`)**: Server-to-server secret for supported `/product-users/by-external-id` operations. Service keys cannot make model inference calls.
- **Dashboard Session**: Browser session cookie with CSRF protection for web dashboard operations.

---

## API Groups

<CardGroup cols={2}>
  <Card title="Product Users & Credits" icon="layers" href="/api-reference/product-users">
    Read product-user allowance, update customer details, and issue credit grants by external user ID.
  </Card>
  <Card title="Provider Credentials" icon="key" href="/api-reference/provider-credentials">
    Manage BYOK provider credentials in the dashboard. There is no application API workflow.
  </Card>
  <Card title="Apps & Connections" icon="terminal" href="/api-reference/apps">
    Create and manage apps and connections in the dashboard.
  </Card>
  <Card title="Usage & Analytics" icon="activity" href="/api-reference/usage">
    Inspect key usage summaries, raw ledger events, and spending analytics.
  </Card>
</CardGroup>