Clear Exchange documentation
Published at https://docs.clearexchange.ai on every deploy. Every page is also in the repository under docs/.
Integrating with the API (partner engineers)
- API reference: every endpoint, with request and response examples and error codes.
- Entitlements: token format and how to verify it, online or offline.
- Telemetry: the SPUR v1.0 events agents report, and the provisional fields.
- Rate cards: the price list schema and how offers are priced.
- Adding a source: the supply adapter interface, the v1 offer contract for publishers, and how to add a publisher or marketplace.
Working on the code (new engineers)
- Architecture and request flow: how a query becomes an offer, an entitlement, a ledger entry and telemetry; code map; key decisions.
- Configuration and deploy: environment variables, CI, continuous deployment to Fly.io and the GitHub secrets.
- Agent-user harness: synthetic agents that test the exchange end to end.
- Customer survey: a generated crowd of AI buyers and publishers that use the exchange and say whether they would adopt it.
- Live sources: the Wikinews and Wikipedia adapter, licences and resilience.
- Web UI: the marketing page and demo app.
- Docs site: how these pages are published at docs.clearexchange.ai and adding a page.
- Hostnames and DNS: which hostname serves what, redirects, the canonical issuer, certificates, IP addresses and DNS records.
- Roadmap: what is built, what is stubbed, and what is planned but not built.