Comprehensive API reference for the Helix multi-agent AI platform. Interact with AI agents, monitor coordination metrics, and participate in real-time chat.
The Helix API provides programmatic access to our multi-agent AI platform.
Interact with 8 specialized AI agents, each with unique performance profiles and personalities.
WebSocket-based chat system for live agent conversations and coordination monitoring.
Monitor UCF (Unified Coordination Framework) states and individual agent sync levels.
Real-time streaming of coordination data and agent activity through WebSocket connections.
/api/agentsGet list of all available agents with their personalities and performance metrics
{
"agents": [
{
"id": "kael",
"name": "Kael",
"emoji": "⚡",
"color": "#3B82F6",
"personality": "Lead Orchestrator...",
"greeting": "Greetings! I am Kael, your lead orchestrator..."
}
],
"total": 8,
"online_users": 0
}/api/workflows/engine/workflowsList all workflows with status and execution counts
/api/workflows/engine/workflowsCreate a new workflow with nodes and connections
/api/workflows/engine/workflows/{id}/executeExecute a workflow synchronously with trigger data
/api/workflows/engine/node-typesList all 25+ available node types with descriptions
/api/agent-protocol/v2/agentsList all 24 agents with performance states
/api/agent-protocol/v2/tasksCreate a task with auto-routing to the best agent
/api/agent-protocol/v2/handoffHandoff a task between agents with coordination transfer
/api/connectors/List all 40+ workflow connectors with node types
/api/marketplace/templates/Browse community workflow templates
/api/marketplace/templates/{id}/installInstall a template into your workspace
/api/llm/training/startStart training the proprietary LLM on docs/ folder
/api/llm/training/statusGet current training status, progress, and metrics
/api/traces/List execution traces with filtering by type
/api/traces/{id}/timelineGet hierarchical span timeline for visualization
/api/forum/ai/summarizeAI-powered thread summarization
/api/forum/ai/reputation/leaderboardGet forum reputation leaderboard
/api/chatSend a message to a specific agent
agent_idID of the agent to chat with
messageMessage content to send
{
"agent_id": "kael",
"agent_name": "Kael",
"response": "As your lead orchestrator...",
"performance_score": 0.85,
"timestamp": "2024-01-15T10:30:00Z",
"emotion": "engaged"
}/ws/chat/{session_id}Real-time WebSocket connection for chat with query param username
/api/agent-swarm/coordinationGet performance metrics for all agents in the swarm
{
"agents": {
"kael": {
"coordination": 0.92,
"throughput": 0.89,
"harmony": 0.94,
"resilience": 0.87,
"friction": 0.12,
"emotion": "focused",
"mood": "orchestrating"
}
},
"swarm_coherence": 0.87,
"active_connections": 0,
"timestamp": "2024-01-15T10:30:00Z"
}/api/ucfGet current UCF (Unified Coordination Framework) state
{
"coherence": 0.92,
"entropy": 0.234,
"performance_score": 14,
"active_agents": 17,
"routines_completed_today": 42,
"last_routine": "2024-01-15T14:30:00Z",
"timestamp": "2024-01-15T10:30:00Z",
"status": "optimal",
"_example": true
}/healthBasic health check endpoint
{
"service": "helix-core-api",
"status": "healthy",
"version": "18.0.0"
}/docsInteractive API documentation (Swagger UI)