API
API documentation for the Rushomon URL shortener service.
Unreleased / main branch
This version documents features on the main branch that have not yet been included in a stable release. Endpoints and schemas may change without notice.
Pre-1.0 release
Rushomon has not yet reached a 1.0 stable API. The interface is subject to breaking changes between minor versions until a stable 1.0 is tagged.
Authentication
Most endpoints require authentication using either:
- Session cookies (for web application users)
- Bearer tokens (for API keys)
Using API Keys
- Create an API key in the dashboard (Pro tier or higher required)
- Include the key in the Authorization header:
Authorization: Bearer ro_pat_...
Response Format
All responses are JSON formatted. Error responses follow this structure:
{
"error": "Error message describing what went wrong"
}
Pagination
List endpoints support pagination with page and limit query parameters:
page: Page number (1-indexed, default: 1)limit: Items per page (1-100, default: 20)
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT or API Key |
Contact
Rushomon Support: support@rushomon.cc
License
AGPL-3.0