API Overview
The CloudSigma API is a REST API that accepts JSON requests and returns JSON responses. All endpoints are under the /v1/ prefix.
Base URL
https://cloudsigma.a13e.comAll examples in this documentation use the production base URL.
Authentication
Every endpoint (except /v1/health) requires a Bearer token in the Authorization header:
Authorization: Bearer <token>CloudSigma supports two token types:
| Method | Format | Availability |
|---|---|---|
| API Key | csk_live_<32 hex chars> | Pro, Team, Enterprise tiers |
| JWT | eyJhbGci... (Cognito access token) | All tiers (web app) |
See Authentication for setup instructions.
Response Envelope
All responses use a consistent envelope format.
Success:
{
"success": true,
"data": { ... }
}Error:
{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Human-readable description"
}
}HTTP status codes follow standard conventions: 200 for success, 400 for bad requests, 401 for unauthorized, 403 for forbidden, 429 for rate limits, and 500 for server errors.
Rate Limits
| Limit | Value | Scope |
|---|---|---|
| API Gateway burst | 100 requests | Per-account |
| API Gateway sustained | 50 requests/sec | Per-account |
| Pipeline executions | 5 per minute | Per-user |
| Monthly rule generation | Tier-dependent (see below) | Per-user |
| API key daily | Configurable per key | Per-key |
Monthly Limits by Tier
| Tier | Rules per Month | Price |
|---|---|---|
| Free | 20 | £0 |
| Pro | Unlimited | £29/mo |
| Team | Unlimited | £99/mo (5 seats) |
| Enterprise | Custom | Custom |
When you exceed your monthly limit, the API returns a TierLimitExceeded error. Upgrade your plan to continue generating rules.
CORS
The API supports CORS for browser-based requests from allowed origins.
Endpoints
| Method | Path | Description | Auth |
|---|---|---|---|
| POST | /v1/generate | Start rule generation pipeline | JWT or API Key |
| GET | /v1/status/{executionArn} | Get execution status and results | JWT or API Key |
| GET | /v1/executions | List recent executions | JWT or API Key |
| GET | /v1/usage | Get monthly usage stats | JWT or API Key |
| GET | /v1/health | Health check | None |