Getting Started
Authentication
API keys and JWT tokens for Hermes API access
Authentication
The Hermes API Gateway supports two authentication methods: API Keys and JWT Tokens.
API Keys
API keys are the recommended method for programmatic access. Keys are prefixed with hermes_ and are 64 hex characters long.
Creating an API Key
- Go to the Hermes Dashboard
- Click Create New Key
- Set a name and optional IP whitelist
- Copy the key — it won't be shown again
Using an API Key
Include your key in the Authorization header:
curl -H "Authorization: Bearer hermes_abc123..." \
https://api.hermes.camie.ai/v1/leadsKey Features
| Feature | Details |
|---|---|
| Format | hermes_ + 64 hex characters |
| Storage | SHA-256 hashed (we never store plaintext) |
| Rate Limit | 100 requests/minute, 1,000 requests/hour |
| IP Whitelist | Optional — restrict key to specific IPs |
| Rotation | Rotate keys without downtime via /api/keys/:id/rotate |
JWT Tokens
JWT tokens are used by the Hermes Dashboard and CLI. They're obtained through the authentication flow on the web app.
Using a JWT Token
curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
https://api.hermes.camie.ai/v1/leadsToken Payload
{
"userId": "3dd2d062-9f8b-46c9-b721-2c92d6d0dec1",
"email": "user@example.com",
"name": "Your Name",
"iat": 1773497723,
"exp": 1774102523
}Public Endpoints
These endpoints don't require authentication:
| Endpoint | Description |
|---|---|
GET /health | System health check |
Error Responses
{
"success": false,
"error": "Missing or invalid Authorization header"
}{
"success": false,
"error": "Insufficient wallet balance. Required: $41.00, Available: $20.00"
}{
"success": false,
"error": "Rate limit exceeded. Try again later."
}