Sign in

Documentation

Recovea documentation

One base URL change puts your AI calls through the Recovea gateway. These pages document what it does on the wire: Meter, Cap, Breaker and Prove.

View as markdown

Base URLs

OpenAI https://api.recovea.ai/v1
Anthropic https://api.recovea.ai
Your own endpoint https://api.recovea.ai/upstream/v1

Read the quickstart

For coding agents: The five questions an agent asks of an AI gateway, answered for Recovea: cost tracking, budgets, observability, caching and fallback.

Quickstart

  • Quickstart Change one base URL and send one request: the headers that come back, the first receipt, and what an armed cap answers.

Products

  • Products Meter, Cap, Breaker and Prove: four product lines on one gateway, each described as its wire behaviour.
  • Meter Every request routed through the gateway is priced from a frozen price list and recorded with no prompt or completion in the record.
  • Cap An armed cap refuses the request before your provider is called and answers 402. The body names the window that was reached.
  • Breaker A budget one run carries, declared in request headers. The run is refused at its own line and stays stopped; other runs keep going.
  • Prove Every priced request is a receipt in your organization's hash chain under recovea-chain-v1. Export a period and re-derive every hash yourself.
  • Where a cap is set Every place a cap is set in the platform, who may change which cap, the four-field form, the five windows, and the scope on the wire.

Concepts

  • Concepts The ideas behind the product pages: windows, thresholds, the receipt chain, fail-open and fail-closed, roles and keys.
  • Caps and windows The five windows a cap runs on, their UTC boundaries, what the week means in the code, and how several caps on one scope combine.
  • Alert thresholds The percentages a cap warns at: whole numbers from 1 to 100, up to ten per cap, each fired once per window and re-armed at the reset.
  • The hash-chained ledger The recipe recovea-chain-v1: fourteen fields in order, joined by U+001F, hashed with SHA-256 from a genesis of 64 zeros, and how to re-derive one receipt.
  • Fail-open and fail-closed What the gateway does when part of it fails: it passes your traffic through, except where you armed a cap, which refuses rather than guess.
  • Content-free by schema The metering record has no field that can hold a prompt, a completion or a tool argument. That is a property of the schema, not a retention policy.
  • Roles The five roles, Owner, Admin, Member, Billing and Viewer, and what each may do, from the capability table the server enforces on every platform route.
  • Organization and keys Your organization, the gateway keys it mints, and the project a key can carry: what each one is and who may change it.
  • Tags The x-recovea-tags request header: its shape, its limits, the four namespaces, and the rule that it never reaches your provider.
  • Glossary One-line definitions of the words these docs use, each pointing at the page that explains it.

Guides

  • Guides One job per page, top to bottom, ending with a step that shows the thing working.
  • Cap your AI spend Set a cap on your organization or on one key, arm it, read the refusal it answers with, hear its alerts, and raise it.

API reference

  • API reference The exact shapes: endpoints, headers, status codes and bodies, for the reader who already has it working.
  • The Baseline package (the passive tap) The wire the Baseline package runs on: one endpoint, a bearer tap key, the fifteen-field event, and what the server answers.

Changelog

  • Changelog What shipped, dated, one line each. The changelog is kept on recovea.ai.