Skip to main content

API Reference

Welcome to the Olympus Cloud API Reference. This documentation covers all available endpoints across our backend services.

Service Overview

ServiceTechnologyEndpointsDescription
Auth ServiceRust (Axum)30+Authentication, authorization, sessions
Platform ServiceRust (GraphQL)GraphQLMulti-tenancy, RBAC, billing
Commerce ServiceRust (Axum)31+Orders, payments, KDS, inventory
API GatewayGo (Chi)95+Unified routing, rate limiting
AI/ML ServicePython (FastAPI)50+Analytics, ML models, voice AI

Base URLs

Production: https://api.olympuscloud.ai
Staging: https://staging.api.olympuscloud.ai
Development: https://dev.api.olympuscloud.ai

Authentication

Authentication Required

All API requests require authentication via JWT Bearer token. Unauthenticated requests will receive a 401 Unauthorized response.

curl -X GET https://api.olympuscloud.ai/v1/resource \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

See Authentication Guide for details.

Rate Limiting

Rate Limits

Exceeding your rate limit will result in 429 Too Many Requests responses. Monitor the X-RateLimit-Remaining header to stay within limits.

TierRequests/minBurst
Free6010
Professional600100
Enterprise60001000

Rate limit headers are included in all responses:

X-RateLimit-Limit: 600
X-RateLimit-Remaining: 599
X-RateLimit-Reset: 1704067200

Response Format

All responses follow a consistent JSON structure:

{
"data": { ... },
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-01-06T12:00:00Z"
}
}

Error responses:

{
"error": {
"code": "INVALID_REQUEST",
"message": "Validation failed",
"details": [
{ "field": "email", "message": "Invalid email format" }
]
},
"meta": {
"request_id": "req_abc123"
}
}

API Sections