Documentation
How Awning works, written down.
Ten documents, kept next to the code they describe: what Awning does, how a sentence becomes a shop, how an agent pays for one, how the money stays safe, and the terms everyone agrees to.
For builders.
For agent developers, PayBox reviewers and anyone checking our work: what the system does, how it is put together, every endpoint and tool, and where it could break.
- 01Product specificationWhat Awning does and for whom: the journeys, the states, prices, limits, and what is live versus mocked.
- 02ArchitectureHow the plugin, the API, the x402 seller, the opening orchestrator and the reconciler fit together.
- 03API referenceEvery endpoint with its request and response, and the x402 exchange header by header.
- 04The PayBox pluginThe nine tools, their schemas, and a worked transcript of a shop opening and an agent buying from it.
- 05Threat modelAssets, trust boundaries, STRIDE by boundary, which mitigations are in code, and the known gaps.
- 06Security policyHow to report a vulnerability, what is in scope, and the rules for testing against Awning.
For the business.
How Awning makes money and where it goes next, and the terms owners, buyers and callers agree to.
- 01The businessThe problem, the customer, pricing and unit economics, go-to-market, competition and risks.
- 02RoadmapWhat exists today, what comes before selling widely, and where Awning goes after that.
- 03Terms of serviceThe agreement for owners, buyers and callers: non-custodial payments, acceptable use, suspension.
- 04Privacy policyWhat Awning collects, what is public on purpose, who else receives it and how long it is kept.
Rather see it running?
The status page shows the same health check as GET /v1/health, in plain words. The live feed shows every opening and sale, with its transaction on Base.