API Reference
API Overview
Hermes REST API — base URL, authentication, and route map
API Overview
The Hermes API Gateway provides a unified REST API for all platform features.
Base URL
https://api.hermes.camie.aiAuthentication
All endpoints (except /health) require a Bearer token:
Authorization: Bearer hermes_your_api_key
# or
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...See Authentication for details.
Rate Limits
| Scope | Limit |
|---|---|
| Per API Key (minute) | 100 requests |
| Per API Key (hour) | 1,000 requests |
Route Map
The gateway proxies requests to the appropriate subsystem:
| API Route | Subsystem | Internal Route |
|---|---|---|
/v1/clusters/* | Sub-5 (Infrastructure) | /api/contabo-cluster/* |
/v1/warmup/* | Sub-5 (Infrastructure) | /api/contabo-cluster/* |
/v1/domains/* | Sub-5 (Infrastructure) | /api/domain/* |
/v1/mailboxes/* | Sub-5 (Infrastructure) | /api/contabo-mailbox/* |
/v1/leads/* | Sub-1 (Lead Discovery) | /api/leads/* |
/v1/campaigns/* | Sub-1 (Lead Discovery) | /api/campaigns/* |
/v1/inbox/* | Sub-4 (Inbox) | /api/inbox/* |
/v1/email-validation/* | Sub-5 (Infrastructure) | /api/email-validation/* |
/wallet/* | Gateway (direct) | — |
/api/keys/* | Gateway (direct) | — |
/clusters/* | Gateway (direct) | — |
Response Format
All responses follow a consistent format:
{
"success": true,
"data": { ... },
"meta": {
"page": 1,
"limit": 20,
"total": 100,
"timestamp": "2026-03-14T14:15:53.984Z"
}
}Error Response
{
"success": false,
"error": "Description of what went wrong"
}HTTP Status Codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request — invalid parameters |
| 401 | Unauthorized — missing or invalid token |
| 402 | Payment Required — insufficient wallet balance |
| 404 | Not Found |
| 429 | Rate Limited |
| 500 | Internal Server Error |
| 502 | Bad Gateway — subsystem unavailable |