Endpointwise Documentation
Everything you need to configure your API gateway, generate reference docs, and manage keys — starting with a single CLI push.
Where to start
If this is your first time using Endpointwise, the Quickstart gets you from a working OpenAPI spec to a live gateway + reference page in under 10 minutes.
Quickstart
Get a gateway and docs live in under 10 minutes with the CLI.
API Reference
Full management API — create gateways, issue keys, inspect routes.
Authentication
API key scoping, expiry, rotation, and auth header format.
Rate Limits
Per-endpoint and global limits, burst vs. sustained, 429 responses.
Webhooks
Event types, retry policies, payload verification, and delivery logs.
SDKs
Client libraries for Node.js, Python, Go, and Ruby.
How Endpointwise works
The core workflow is spec-driven: your OpenAPI spec is the single source of truth for your gateway config and your reference docs.
Push your OpenAPI spec
Run npx endpointwise push --spec ./openapi.yaml. The CLI validates your spec, configures gateway routes, and generates a hosted reference page.
Configure rate limits and issue keys
Set per-endpoint rate limits in the dashboard or in your endpointwise.yaml config file. Issue scoped API keys with expiry dates.
Share the reference URL and key
Your partner gets a live reference page and a working key. Rate limits are documented on the same page. No separate docs site to maintain.
Need help?
Contact us at [email protected]. Starter plan users have access to community support; Platform and Scale plans include email support with an SLA.