Integration walkthrough

From "I have an AI app" to "my app resolves, routes, enforces policies, and shows embeddable UI through Restormel Keys."

This walkthrough is the primary onboarding journey. It takes you through install, first resolve call, routes and fallbacks, policies, embeddable UI, and go-live. Use it with the Dashboard and Cloud API (Zuplo) as you go.

Before you begin

Prerequisites: an existing AI-powered app, a Restormel account, and your routing inventory (what you use today for model selection).

Phases

  1. Phase 0 — Inventory — Audit existing routing and decide what to remove, keep, or wrap.
  2. Phase 1 — Install and configure — Packages, dashboard project, Gateway Key, Restormel Doctor (framework and config; Cloud env is verified in Phase 2).
  3. Phase 2 — Resolve your first model — One resolve call from your backend; verify providerType and modelId in the response.
  4. Phase 3 — Add routes and fallbacks — Create routes with steps in the Dashboard; configure fallback chain; wire route IDs.
  5. Phase 4 — Apply policies — Model allowlist, deprecated-model block, budget cap; use the evaluate endpoint from your backend with your project Gateway Key (or from dashboard session).
  6. Phase 5 — Embed the UI — ModelSelector and optional KeyManager; policy-filtered model list via a server-side proxy.
  7. Phase 6 — Go live — Parallel run, cutover, smoke test, legacy code removal.
  8. Migration paths — LiteLLM, Portkey, OpenRouter, custom.
  9. Verification strategy — Dashboard, CLI, smoke tests; ongoing monitoring and CI.
  10. Staging and CI setup — Non-production project, secrets (where to get them, what to call them, where to save them, how to rotate); nightly and post-deploy.

Implementing with a coding agent

Each phase page includes an “Agent prompts” section. It’s collapsed by default so you only see it when you need it. Use it if you want a coding agent to review the docs for that phase and implement it in your repo in a safe, gated sequence.

Auth at a glance

  • Gateway Key — Resolve API and backend policy evaluate calls for your project; keep it server-side only.
  • Session — Dashboard UI (Sign in with GitHub) and policy testing from the dashboard.

Next

Framework compatibility for install commands. Dashboard to create a project and generate a Gateway Key. Cloud API for gateway URL and Zuplo.