Skip to Content
API ReferenceOverview

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.com

All 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:

MethodFormatAvailability
API Keycsk_live_<32 hex chars>Pro, Team, Enterprise tiers
JWTeyJhbGci... (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

LimitValueScope
API Gateway burst100 requestsPer-account
API Gateway sustained50 requests/secPer-account
Pipeline executions5 per minutePer-user
Monthly rule generationTier-dependent (see below)Per-user
API key dailyConfigurable per keyPer-key

Monthly Limits by Tier

TierRules per MonthPrice
Free20£0
ProUnlimited£29/mo
TeamUnlimited£99/mo (5 seats)
EnterpriseCustomCustom

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

MethodPathDescriptionAuth
POST/v1/generateStart rule generation pipelineJWT or API Key
GET/v1/status/{executionArn}Get execution status and resultsJWT or API Key
GET/v1/executionsList recent executionsJWT or API Key
GET/v1/usageGet monthly usage statsJWT or API Key
GET/v1/healthHealth checkNone
Last updated on