API ReferenceOverview

API Overview

The Syaala Platform provides a comprehensive REST API for programmatic access to all platform features.

Base URL

https://api.syaala.com/v1

Authentication

⚠️

Authentication Required: All API requests must include a valid JWT token from Supabase authentication.

Include your authentication token in the Authorization header:

curl -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  https://api.syaala.com/v1/deployments

Rate Limits

Rate limits are enforced per API key and organization:

  • Free tier: 100 requests/minute
  • Startup tier: 1,000 requests/minute
  • Growth tier: 10,000 requests/minute
  • Enterprise tier: Custom limits

Response Format

All API responses follow a consistent JSON structure:

{
  "success": true,
  "data": { ... },
  "error": null
}

Error responses include detailed information:

{
  "success": false,
  "data": null,
  "error": {
    "code": "DEPLOYMENT_NOT_FOUND",
    "message": "Deployment with ID abc123 not found",
    "details": {}
  }
}

Pagination

List endpoints support cursor-based pagination:

GET /api/deployments?limit=20&cursor=abc123xyz

Response includes pagination metadata:

{
  "data": [...],
  "pagination": {
    "hasMore": true,
    "nextCursor": "def456uvw"
  }
}

Available Endpoints

QuickstartAlerts API