API Overview

https://platform.syaala.com/api

curl -X GET https://platform.syaala.com/api/deployments \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -X POST https://platform.syaala.com/api/deployments \
  -H "Authorization: Bearer sk_live_1a2b3c4d5e6f7g8h9i0j" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-deployment",
    "model": "meta-llama/Meta-Llama-3.1-8B-Instruct",
    "runtime": "vllm",
    "gpu": "NVIDIA-RTX-4090"
  }'

{
  "success": true,
  "data": {
    "id": "dep_a1b2c3d4e5f6",
    "name": "my-deployment",
    "status": "running",
    "endpoint": "https://dep-a1b2c3d4.syaala.run"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_MODEL",
    "message": "Model 'invalid-model' not found on HuggingFace",
    "details": {
      "model": "invalid-model",
      "valid_sources": ["huggingface", "custom"]
    }
  }
}

const response = await fetch('https://platform.syaala.com/api/deployments', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(deploymentConfig)
})
 
const result = await response.json()
 
if (!response.ok) {
  // Handle specific error codes
  switch (result.error.code) {
    case 'RATE_LIMIT_EXCEEDED':
      const retryAfter = response.headers.get('Retry-After')
      console.log(`Rate limited. Retry after ${retryAfter} seconds`)
      break
 
    case 'INSUFFICIENT_CREDITS':
      console.log('Please add credits at https://platform.syaala.com/dashboard/billing')
      break
 
    case 'INVALID_MODEL':
      console.log(`Model not found: ${result.error.details.model}`)
      break
 
    default:
      console.error('API Error:', result.error.message)
  }
}

HTTP/1.1 200 OK
X-RateLimit-Limit: 600
X-RateLimit-Remaining: 587
X-RateLimit-Reset: 1728003600
Retry-After: 13

async function makeRequestWithRetry(url: string, options: RequestInit, maxRetries = 3) {
  for (let i = 0; i < maxRetries; i++) {
    const response = await fetch(url, options)
 
    if (response.status !== 429) {
      return response
    }
 
    const retryAfter = parseInt(response.headers.get('Retry-After') || '60')
    console.log(`Rate limited. Waiting ${retryAfter} seconds...`)
    await new Promise(resolve => setTimeout(resolve, retryAfter * 1000))
  }
 
  throw new Error('Max retries exceeded')
}

# First page
curl "https://platform.syaala.com/api/deployments?limit=20"
 
# Response
{
  "data": [...],
  "pagination": {
    "hasMore": true,
    "nextCursor": "eyJpZCI6ImRlcF94eXoiLCJjcmVhdGVkQXQiOiIyMDI1LTEwLTAxIn0"
  }
}
 
# Next page
curl "https://platform.syaala.com/api/deployments?limit=20&cursor=eyJpZCI6ImRlcF94eXoiLCJjcmVhdGVkQXQiOiIyMDI1LTEwLTAxIn0"

async function fetchAllDeployments() {
  const deployments: Deployment[] = []
  let cursor: string | undefined
 
  while (true) {
    const params = new URLSearchParams({
      limit: '100',
      ...(cursor && { cursor })
    })
 
    const response = await fetch(`https://platform.syaala.com/api/deployments?${params}`, {
      headers: { 'Authorization': `Bearer ${apiKey}` }
    })
 
    const result = await response.json()
    deployments.push(...result.data)
 
    if (!result.pagination.hasMore) break
    cursor = result.pagination.nextCursor
  }
 
  return deployments
}

# Filter deployments by status
GET /api/deployments?status=running
 
# Filter by multiple values
GET /api/deployments?status=running,deploying
 
# Filter by date range
GET /api/deployments?created_after=2025-10-01&created_before=2025-10-31

# Sort by creation date (ascending)
GET /api/deployments?sort=created_at
 
# Sort by creation date (descending)
GET /api/deployments?sort=-created_at
 
# Multiple sort fields
GET /api/deployments?sort=-status,created_at

https://platform.syaala.com/api/v1/deployments

{
  "event": "deployment.running",
  "timestamp": "2025-10-01T10:00:00Z",
  "data": {
    "id": "dep_a1b2c3d4e5f6",
    "name": "my-deployment",
    "status": "running",
    "endpoint": "https://dep-a1b2c3d4.syaala.run",
    "gpu": "NVIDIA-RTX-4090",
    "replicas": 2
  }
}

curl -X POST https://platform.syaala.com/api/webhooks \
  -H "Authorization: Bearer sk_live_..." \
  -d '{
    "url": "https://your-app.com/webhooks/syaala",
    "events": ["deployment.running", "deployment.failed"],
    "secret": "whsec_your_webhook_secret"
  }'

curl https://platform.syaala.com/api/openapi.json > syaala-api.json