OpenAPI Specification
Together provides a complete OpenAPI 3.0 specification for the REST API.
Download
The full spec is available as a downloadable YAML file:
- Download openapi.yaml — latest version, served from this docs site
- View on GitHub — canonical source in the repository
Using the Spec
- Swagger UI: Load the spec into Swagger Editor or Swagger UI
- Code generation: Generate client SDKs using OpenAPI Generator
- Import into Postman/Insomnia: Import the YAML directly into your API client
Coverage
The OpenAPI spec covers the main REST API endpoints including:
- Authentication (register, login, refresh)
- User management
- Server (guild) management
- Channel management
- Message CRUD operations
- Role management
- Invite management
- Search
- Reactions
- Polls
- Webhooks
- Bot management
Contributing
If you find an endpoint missing from the spec or a discrepancy between the spec and actual API behavior, please open an issue or submit a PR against docs/openapi.yaml.