Install SDK
Install the Convox SDK for Node.js or Python.
The Convox SDK runs in your backend and exposes your business functions as LLM tools.
Install
npm install @aelio/sdkimport { aelio } from '@aelio/sdk';Requires Node.js ≥ 20. Current version: 0.1.1.
pip install aelio-sdk
# Also requires: pip install websockets>=12.0from aelio_sdk import AelioRequires Python ≥ 3.9. Current version: 0.1.0.
Environment variables
AELIO_SDK_SECRET=change-me-in-production # Required to connect
AELIO_SERVER_URL=ws://127.0.0.1:3010 # WebSocket URLAELIO_SECRET is accepted as an alias for AELIO_SDK_SECRET.
Minimal connection
await aelio.listen({
secret: process.env.AELIO_SDK_SECRET,
url: process.env.AELIO_SERVER_URL ?? 'ws://127.0.0.1:3010',
});aelio = Aelio(secret=os.environ["AELIO_SDK_SECRET"])
aelio.run() # blocking, or asyncio.create_task(aelio.listen())Develop without a running server
Tools, states, and policies are configured at startup even without AELIO_SDK_SECRET. The runtime connection is optional until you set the secret — letting you develop and test tool handlers independently.
Pick your platform guide
Node.js + Express
Full Express integration guide with middleware setup.
Next.js App Router
instrumentation.ts pattern + chat token API route.
React (Vite)
Widget integration for Vite and CRA projects.
Python + FastAPI
Complete FastAPI example with lifespan startup.
Python + Django
Management command + AppConfig pattern.
Go
Wire protocol community guide using gorilla/websocket.
Ruby
Community guide using faye-websocket.
Rust
Community guide using Tokio + tungstenite.