# seams documentation

> Gateway, routing, metering, spend control, and BYOK, how to reach them.
> Human site: https://docs.ourseams.com

## Get started

- [Welcome](https://docs.ourseams.com/welcome): The portal for your AI product: gateway, routing, metering, and spend control.
- [Introduction](https://docs.ourseams.com/introduction): The shape of the system, and where your code touches it.
- [Quickstart](https://docs.ourseams.com/quickstart): Mint a key for one end user and make a real call through your gateway.
- [Authentication](https://docs.ourseams.com/authentication): Two kinds of key, pointed at two different things, and never interchangeable.

## Core concepts

- [Applications](https://docs.ourseams.com/applications): The container everything else belongs to, and the two hostnames it gets.
- [Keys and end users](https://docs.ourseams.com/keys-and-end-users): One key per end user, and why never a header.
- [Wallets and holds](https://docs.ourseams.com/balances-and-holds): Where the money sits, and what a hold actually is.
- [The ledger](https://docs.ourseams.com/the-ledger): Append-only, and why that is not negotiable.
- [Bundles](https://docs.ourseams.com/bundles): Which models a key may reach, and at what markup.
- [Pricing strategies](https://docs.ourseams.com/pricing-strategies): How you charge end users maps onto wallets, plans, markup, and job ceilings.
- [Subscriptions and overage](https://docs.ourseams.com/subscriptions): What a paid bundle mints each period, and what happens when it runs out.
- [Credit systems](https://docs.ourseams.com/credit-systems): Name your own credits, decide when they mint, and let the gateway spend them down.
- [Spend caps](https://docs.ourseams.com/spend-caps): A hold before dispatch, and a stream that stops.
- [Outcomes](https://docs.ourseams.com/outcomes): Budget a unit of work, not a request, when one job is several calls.
- [Model aliases](https://docs.ourseams.com/model-aliases): Your names for models, not the provider's.
- [Routers](https://docs.ourseams.com/routers): A named policy over your model names, when one source is not enough.
- [Provider accounts](https://docs.ourseams.com/providers): Your provider accounts, what we do with them, and the catalog they draw from.
- [Bring your own key](https://docs.ourseams.com/byok): Your provider account, sealed with KMS.
- [Emitters](https://docs.ourseams.com/emitters): Settled usage, delivered where you bill from.

## Integrations

- [Agent onboarding](https://docs.ourseams.com/agent-onboarding): An agent that provisions its own key, its own budget and its own base URL, no console visit.
- [CLI](https://docs.ourseams.com/cli): Mint keys, read what spend went where, and check a broken integration without opening the console.

## SDKs

- [TypeScript SDK](https://docs.ourseams.com/typescript-sdk): @ourseams/sdk. one namespace per CLI command group.
- [Python SDK](https://docs.ourseams.com/python-sdk): ourseams-sdk. the same operations, imported as seams.

## Surfaces

- [The gateway](https://docs.ourseams.com/the-gateway): Your gateway host: four wire formats, model resolution, and the only path that moves money.
- [Calling the gateway](https://docs.ourseams.com/calling-the-gateway): OpenAI, Anthropic, Gemini, and curl: non-streaming, streaming, and cross-protocol.
- [The portal](https://docs.ourseams.com/the-portal): Where your customers see their own usage, spend and keys.
- [The console](https://docs.ourseams.com/the-console): Where your team runs the account.

## Examples

- [Metered chatbot](https://docs.ourseams.com/example-metered-chatbot): A chat product where every customer has their own balance and their own ceiling.
- [Usage-based pricing](https://docs.ourseams.com/example-usage-based-pricing): Charge for what they call: your markup on the wire, their wallet on the meter.
- [Outcome-based pricing](https://docs.ourseams.com/example-outcome-based-pricing): Sell a finished job. Budget the run. Meter every call that belongs to it.
- [Design a credit system](https://docs.ourseams.com/example-credit-system): Welcome credit, sellable packs, and a monthly allotment, one product, end to end.
- [Per-seat agents](https://docs.ourseams.com/example-per-seat-agents): One customer, many agents, and a budget that does not let one of them eat the month.
- [Prepaid credits](https://docs.ourseams.com/example-prepaid-credits): Sell a balance up front, take your margin at the top-up, and let the meter run it down.
- [Reselling with markup](https://docs.ourseams.com/example-reselling): Your own provider account on the path, your own price on the invoice.

## Reference

- [API reference](https://docs.ourseams.com/api-reference): The OpenAPI document is the list, generated from the routes that are served.
- [Every operation](https://docs.ourseams.com/operations): The command and the route that reach each operation.
- [Usage and margin](https://docs.ourseams.com/usage-and-margin): What was called, what it cost you, and what was left over.
- [The request log](https://docs.ourseams.com/request-log): One row per call, why it cost what it cost, and what is deliberately absent.
- [Errors](https://docs.ourseams.com/errors): Stable codes, and what each one means.
- [Lossy protocol conversions](https://docs.ourseams.com/protocol-lossy-conversions): What is not preserved when inbound and outbound wires differ.
- [FAQ](https://docs.ourseams.com/faq): The questions that come up first.
- [Changelog](https://docs.ourseams.com/changelog): What shipped, newest first.

## Read instead of crawling

- [https://docs.ourseams.com/llms-full.txt](https://docs.ourseams.com/llms-full.txt): every docs page, one file
- [https://api.ourseams.com/v1/openapi.json](https://api.ourseams.com/v1/openapi.json): every endpoint, field and error
- [https://ourseams.com/llms.txt](https://ourseams.com/llms.txt): product index
- [https://blog.ourseams.com/llms.txt](https://blog.ourseams.com/llms.txt): blog index