Developers

Build on Aeion OS

REST APIs, MCP tools, webhooks, real-time collaboration, and SDKs. Everything you need to extend the platform or integrate with your stack.

API Reference Code Examples

Multiple Integration Points

Choose the integration method that fits your use case — from simple REST to AI-native MCP.

🔗

REST API

Full CRUD for every collection with filtering, pagination, sparse fieldsets, and relation population. Auto-generated from your schema.

GET, POST, PATCH, DELETE /api/v1/{collection}

🤖

MCP (Model Context Protocol)

AI-native tooling protocol. Build agents that read, write, and manage your data through structured tool calls with typed schemas.

JSON-RPC 2.0 over SSE

🌐

WebMCP (In-Browser Tools)

Register custom tools directly in the admin UI. Create collection CRUD helpers, module actions, and AI-powered workflows without a backend.

useAeionTool() React hook

📡

Webhooks & Events

Subscribe to any event in the system. Commerce orders, CRM changes, helpdesk tickets — get notified in real-time via HTTP callbacks.

Redis Streams + HTTP callbacks

⚡

Real-Time Collaboration

WebSocket-based real-time sync for collaborative editing, live dashboards, and multiplayer experiences via Yjs CRDT.

WebSocket /collab/ws

📁

File & Media API

Upload, transform, and serve media with automatic image optimization, video transcoding, and CDN delivery.

POST /api/v1/media/upload

Authentication

API Keys

Generate scoped API keys from the admin dashboard. Each key has granular permissions (content:read, commerce:write, etc.).

Authorization: Bearer aeion_sk_live_...

JWT Sessions

For frontend apps, use JWT-based authentication with automatic refresh tokens. Supports SSO/SAML on Business+ plans.

POST /api/v1/auth/login { email, password }

Code Examples

List collection itemsbash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://your-site.aeion.cloud/api/v1/products?where[status][equals]=active&limit=10"

Create a recordbash

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "New Product", "price": 2999, "status": "draft"}' \
  "https://your-site.aeion.cloud/api/v1/products"

MCP tool calljson

{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "content",
    "arguments": {
      "action": "list",
      "resource": "pages",
      "limit": 5
    }
  },
  "id": 1
}

SDKs & Libraries

🟨

JavaScript / TypeScript

Available

🐍

Python

Coming Soon

🔵

Coming Soon

🔴

Ruby

Coming Soon

Rate Limits

Starter100 req/min

Business500 req/min

EnterpriseCustom

Webhook Events

commerce.order.created

crm.deal.stage_changed

helpdesk.ticket.resolved

content.page.published

auth.user.registered

+ 200 more event types

Ready to build?

Start with a free trial and get full API access. Our developer community is here to help.

Get API Key Talk to Engineering