ScalixScalix Docs

API Reference

Complete REST API documentation for Scalix Cloud

Base URL

plaintext
https://api.scalix.world

Authentication

All requests require an API key in the Authorization header:

bash
curl -H "Authorization: Bearer scalix_sk_your_key_here" \
  https://api.scalix.world/v1/...

Request Format

  • Content-Type: application/json
  • Project context: set automatically via API key scope, or override with the x-scalix-project header (the console also accepts x-project-id)

Response Format

All responses return JSON:

json
{
  "data": { ... },
  "request_id": "req_abc123"
}

Error Format

json
{
  "error": "Human-readable message",
  "code": "ERROR_CODE",
  "request_id": "req_abc123",
  "docs_url": "https://docs.scalix.world/api-reference/errors#ERROR_CODE"
}

Service Endpoints

ServiceBase PathDescription
Database/api/v1/*SQL queries, schema, branches
Compute/v1/compute/*Container deployments
Functions/v1/functions/*Serverless functions
Services/v1/run/services/*Scalix Run managed services
Storage/v1/storage/*Object storage
KV Store/v1/kv/*Key-value operations
Events/v1/events/*Pub/Sub event bus
Cron/v1/cron/*Scheduled jobs
AI/v1/ai/*LLM inference
Auth/v1/auth/*End-user authentication
Domains/v1/domains/*Custom domain management
Build/v1/build/*Container image builds
Registry/v1/registry/*OCI container registry

Rate Limits

Rate limits vary by plan:

PlanRequests/secDaily AI Limit
Free20500
Chat Plus20500
Starter50Unlimited
Pro100Unlimited
Team200Unlimited
Business500Unlimited
Enterprise1000Unlimited

Auth endpoints (signup, login) are limited to 3 req/min per IP by default, regardless of plan.

Rate limit headers are included in every response:

plaintext
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1716230400

Pagination

Pagination conventions vary by endpoint: most list endpoints accept limit/offset query parameters (for example function invocations), and Shield events use cursor pagination. Check each endpoint's parameters in the reference pages below.

bash
curl "https://api.scalix.world/v1/functions/functions/{id}/invocations?limit=20&offset=0"