Docs
Choose a provider access mode, then follow the walkthrough.
What brings you here?
Restormel Keys is a product in the Restormel platform. It’s designed to slot into your existing stack. It complements provider-access layers like OpenRouter, Vercel AI Gateway, and Portkey, and it also supports direct providers when you manage credentials in your own environment. This doc set covers install, framework choice, provider access modes, the Restormel Resolve API surface, and the Dashboard.
Products and components
- Restormel Keys — routing, policies, cost, and embeddable UX for AI apps.
- Restormel Resolve — the API surface that returns the provider/model decision for a request.
- Restormel Doctor — health checks for framework + config.
- Restormel Validate — verification checks for provider access and stored credentials (CI-friendly).
Start with Next.js
Using Next.js App Router? Install the core plus React and Web Components. Full path: Framework compatibility.
pnpm add @restormel/keys @restormel/keys-react @restormel/keys-elementsChoose a provider access mode
Before you wire anything, decide how your stack will reach providers. Restormel does not need to hold raw provider secrets by default. See Provider access modes for a simple decision tree.
Pick your framework
One core; different wrappers. Use the headless API for resolution and cost on the server; add UI (KeyManager, ModelSelector, CostEstimator) where it fits.
| Framework | Package path | Status |
|---|---|---|
| Next.js / React | @restormel/keys + @restormel/keys-react + @restormel/keys-elements | ✅ Supported |
| SvelteKit | @restormel/keys + @restormel/keys-svelte | ✅ Supported |
| Web Components / Astro / vanilla | @restormel/keys + @restormel/keys-elements | ✅ Supported |
| Vue / Nuxt | Headless or elements for now | 🔵 Planned |
Framework compatibility has install commands, when-to-use guidance, and the full Next.js walkthrough.
Quick links
- How it all fits together — key types, API surfaces, and where each URL fits
- Walkthrough — step-by-step integration (Phase 0–6)
- Cloud API — Dashboard API (
rk_…): resolve, routes, policies, catalog, project model index; Zuplo gateway (zpka_…); OpenAPI imports. Integrator note (indexdatashape, validation errors):keys-catalog-sync.md. - OpenRouter integration — keep OpenRouter as your provider access layer
- Vercel AI Gateway integration — keep Vercel gateway auth and observability
- Portkey integration — keep Portkey as your gateway and route via Restormel
- Canonical model & provider catalog — public HTTP feed + npm helpers for up-to-date lists
- Keys landing — what Keys is, modes, comparison, pricing
- Pricing — tiers and FAQ
- Dashboard — create projects and API keys
- Sign in — authenticate with GitHub