Documentation
Three documents, one for each job
Written from the running system. Everything they describe is in the product today; where something is not built, they say so.
For owners and admins
Product guide
Signing in and roles, vendor keys with their model lists, environments and spend caps, creating and editing virtual keys, address rules, mail keys, refusals, alerts, usage and the audit log — task by task.
Read it →For developers
API guide
Base URL and authentication, every endpoint with working examples in curl, Python and TypeScript, every error code and what to do about it, the headers that come back, and what is deliberately not supported.
Read it →For whoever runs it
Installation & operations
Requirements, the Docker Compose profile, configuration and secrets, domains and TLS, the first organisation, backups and restores, upgrading and how migrations are checked, and a security checklist.
Read it →For your coding assistant
The API guide has a machine-readable twin with the exact request and response shapes. Give that one to the assistant writing the integration and it will get it right the first time.
docs/INTEGRATION.md— the same guide as Markdown- Every example is the shape the gateway actually accepts, not a sketch
- Every error code, with what a client should do about it
Want the source as well?
The whole product, with every future update, for one payment.