# 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.

Notes for readers:

- Every page here is prerendered to static HTML, so the whole text of a page is in the initial response and no JavaScript has to run to read it.
- Every page also has a Markdown twin at its own address with `.md` on the end (the landing's is /index.md), derived from that page's own HTML at build time. It is the cheaper read and it says the same thing.
- https://docs.recovea.ai/llms-full.txt is every twin on this site in the order below, in one file.
- Prices are not stated on this site; they are at https://recovea.ai/pricing.
- This file is generated from the same route list the sitemap is generated from, on every build.

## Start here

- [Recovea Docs](https://docs.recovea.ai/): 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. ([markdown](https://docs.recovea.ai/index.md))
- [For coding agents](https://docs.recovea.ai/agents/): The five questions an agent asks of an AI gateway, answered for Recovea: cost tracking, budgets, observability, caching and fallback. ([markdown](https://docs.recovea.ai/agents.md))

## Quickstart

- [Quickstart](https://docs.recovea.ai/quickstart/): Change one base URL and send one request: the headers that come back, the first receipt, and what an armed cap answers. ([markdown](https://docs.recovea.ai/quickstart.md))

## Products

- [Products](https://docs.recovea.ai/products/): Meter, Cap, Breaker and Prove: four product lines on one gateway, each described as its wire behaviour. ([markdown](https://docs.recovea.ai/products.md))
- [Meter](https://docs.recovea.ai/products/meter/): Every request routed through the gateway is priced from a frozen price list and recorded with no prompt or completion in the record. ([markdown](https://docs.recovea.ai/products/meter.md))
- [Cap](https://docs.recovea.ai/products/cap/): An armed cap refuses the request before your provider is called and answers 402. The body names the window that was reached. ([markdown](https://docs.recovea.ai/products/cap.md))
- [Breaker](https://docs.recovea.ai/products/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. ([markdown](https://docs.recovea.ai/products/breaker.md))
- [Prove](https://docs.recovea.ai/products/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. ([markdown](https://docs.recovea.ai/products/prove.md))
- [Where a cap is set](https://docs.recovea.ai/products/caps/): 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. ([markdown](https://docs.recovea.ai/products/caps.md))

## Concepts

- [Concepts](https://docs.recovea.ai/concepts/): The ideas behind the product pages: windows, thresholds, the receipt chain, fail-open and fail-closed, roles and keys. ([markdown](https://docs.recovea.ai/concepts.md))
- [Caps and windows](https://docs.recovea.ai/concepts/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. ([markdown](https://docs.recovea.ai/concepts/caps-and-windows.md))
- [Alert thresholds](https://docs.recovea.ai/concepts/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. ([markdown](https://docs.recovea.ai/concepts/alert-thresholds.md))
- [The hash-chained ledger](https://docs.recovea.ai/concepts/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. ([markdown](https://docs.recovea.ai/concepts/hash-chained-ledger.md))
- [Fail-open and fail-closed](https://docs.recovea.ai/concepts/fail-open-vs-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. ([markdown](https://docs.recovea.ai/concepts/fail-open-vs-fail-closed.md))
- [Content-free by schema](https://docs.recovea.ai/concepts/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. ([markdown](https://docs.recovea.ai/concepts/content-free-by-schema.md))
- [Roles](https://docs.recovea.ai/concepts/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. ([markdown](https://docs.recovea.ai/concepts/roles.md))
- [Organization and keys](https://docs.recovea.ai/concepts/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. ([markdown](https://docs.recovea.ai/concepts/organization-and-keys.md))
- [Tags](https://docs.recovea.ai/concepts/tags/): The x-recovea-tags request header: its shape, its limits, the four namespaces, and the rule that it never reaches your provider. ([markdown](https://docs.recovea.ai/concepts/tags.md))
- [Glossary](https://docs.recovea.ai/concepts/glossary/): One-line definitions of the words these docs use, each pointing at the page that explains it. ([markdown](https://docs.recovea.ai/concepts/glossary.md))

## Guides

- [Guides](https://docs.recovea.ai/guides/): One job per page, top to bottom, ending with a step that shows the thing working. ([markdown](https://docs.recovea.ai/guides.md))
- [Cap your AI spend](https://docs.recovea.ai/guides/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. ([markdown](https://docs.recovea.ai/guides/cap-your-ai-spend.md))

## API reference

- [API reference](https://docs.recovea.ai/reference/): The exact shapes: endpoints, headers, status codes and bodies, for the reader who already has it working. ([markdown](https://docs.recovea.ai/reference.md))
- [The Baseline package (the passive tap)](https://docs.recovea.ai/reference/passive-tap/): The wire the Baseline package runs on: one endpoint, a bearer tap key, the fifteen-field event, and what the server answers. ([markdown](https://docs.recovea.ai/reference/passive-tap.md))
- [OpenAI-compatible](https://docs.recovea.ai/reference/openai-compatible/): The OpenAI wire. ([markdown](https://docs.recovea.ai/reference/openai-compatible.md))
- [Create a chat completion](https://docs.recovea.ai/reference/openai-compatible/chat-completions/): OpenAI's chat completions endpoint, forwarded to OpenAI. ([markdown](https://docs.recovea.ai/reference/openai-compatible/chat-completions.md))
- [Create a completion](https://docs.recovea.ai/reference/openai-compatible/completions/): OpenAI's legacy completions endpoint, forwarded to OpenAI as sent. ([markdown](https://docs.recovea.ai/reference/openai-compatible/completions.md))
- [Create embeddings](https://docs.recovea.ai/reference/openai-compatible/embeddings/): OpenAI's embeddings endpoint, forwarded to OpenAI as sent. ([markdown](https://docs.recovea.ai/reference/openai-compatible/embeddings.md))
- [Create a response](https://docs.recovea.ai/reference/openai-compatible/responses/): OpenAI's Responses endpoint, forwarded to OpenAI as sent. ([markdown](https://docs.recovea.ai/reference/openai-compatible/responses.md))
- [List models](https://docs.recovea.ai/reference/openai-compatible/list-models/): OpenAI's model list, forwarded to OpenAI. ([markdown](https://docs.recovea.ai/reference/openai-compatible/list-models.md))
- [Any other OpenAI path](https://docs.recovea.ai/reference/openai-compatible/openai-passthrough/): Every other path under /v1 is forwarded to OpenAI as sent, under any method, so an endpoint works the day the provider ships it; there is no allowlist. ([markdown](https://docs.recovea.ai/reference/openai-compatible/openai-passthrough.md))
- [Anthropic](https://docs.recovea.ai/reference/anthropic/): Anthropic's wire on the same host. ([markdown](https://docs.recovea.ai/reference/anthropic.md))
- [Create a message](https://docs.recovea.ai/reference/anthropic/messages/): Anthropic's Messages endpoint on the bare host, forwarded to Anthropic as sent. ([markdown](https://docs.recovea.ai/reference/anthropic/messages.md))
- [Paths under /v1/messages](https://docs.recovea.ai/reference/anthropic/messages-subpaths/): Every path under /v1/messages (token counting, message batches and a batch's results among them), and /v1/messages itself under any method other than POST, is Anthropic's, forwarded to Anthropic as sent. ([markdown](https://docs.recovea.ai/reference/anthropic/messages-subpaths.md))
- [Create a message (earlier spelling)](https://docs.recovea.ai/reference/anthropic/messages-alias/): The earlier spelling of /v1/messages. ([markdown](https://docs.recovea.ai/reference/anthropic/messages-alias.md))
- [Any other Anthropic path (earlier spelling)](https://docs.recovea.ai/reference/anthropic/anthropic-alias-passthrough/): Every other path under /anthropic/v1 is forwarded to Anthropic with /anthropic stripped, under any method. ([markdown](https://docs.recovea.ai/reference/anthropic/anthropic-alias-passthrough.md))
- [Declared upstreams](https://docs.recovea.ai/reference/declared-upstreams/): The OpenAI wire, forwarded to a destination your organization declared. ([markdown](https://docs.recovea.ai/reference/declared-upstreams.md))
- [Forward to your declared upstream](https://docs.recovea.ai/reference/declared-upstreams/upstream-passthrough/): Forwards /v1/{path} to the OpenAI-compatible destination your organization declared, under any method, signed with the credential stored for that destination as Authorization: Bearer. ([markdown](https://docs.recovea.ai/reference/declared-upstreams/upstream-passthrough.md))

## Changelog

- [Changelog](https://docs.recovea.ai/changelog/): What shipped, dated, one line each. The changelog is kept on recovea.ai. ([markdown](https://docs.recovea.ai/changelog.md))