Before you ask
- Platform guide - authentication, routing, quotas, organizations, the dashboard.
- REST API reference - every endpoint with parameters, schemas and examples.
- Python guide and Python reference - the SDK and the
osrcommand line. - Self-hosting - the container image, environment variables and the Helm chart.
- Errors - what each status code means and which header to read (
Retry-After,X-Upgrade).
The search box in the header (Ctrl/Cmd + K) covers every documentation page, heading and API operation.
Bugs and feature requests
Open an issue on GitHub. Include the SDK or platform version (shown in the footer and in GET /api/v1/info), what you sent, what you expected and what came back. For a routing decision you disagree with, attach the request_id and the ranked part of the response; it contains the per-strategy breakdown that explains the choice.
Questions that are not bugs - how to model a catalogue, which strategy to weight, whether a deployment shape fits - belong in Discussions.
Account and billing
Plan changes, invoices and payment methods are handled in Plan and billing; payments go through Stripe and the receipt comes from there. Lost API keys cannot be recovered - keys are stored hashed - so revoke the old one and create a new one under API keys. To close an account or have its data removed, open a private issue or write to the security address below from the email on the account.
Security
Do not report vulnerabilities in a public issue. Email security@opensmartroute.org or use GitHub's private vulnerability reporting. The security policy lists supported versions and what to expect after a report; the security model describes the guards, PII handling and audit trail.
Enterprise
The enterprise edition (tenants, statistics, hash-chained audit, organization SSO) is part of the open-source package and can be self-hosted at no cost. For a managed deployment, a pilot or a routing audit of your current traffic, open a discussion titled "Enterprise" or contact the maintainers through the repository; the pricing page lists what each plan includes.
Service status
GET /healthz on the API answers 200 when the router is up, and GET /api/v1/info reports the edition, version and the executable targets of the deployment you are calling. Incidents affecting the hosted platform are posted as pinned GitHub issues.