Skip to main content

API Reference

agtOS provides three ways to interact with the platform:
ProtocolPortUse Case
REST API4102Dashboard, CLI, health checks, chat
WebSocket3000Real-time voice audio streaming
MCP4100Tool integration for AI agents

Authentication

API endpoints support optional authentication via AGTOS_API_KEY:
curl -H "Authorization: Bearer your-api-key" http://localhost:4102/api/health
When AGTOS_API_KEY is not set, all endpoints are open (local development mode).

REST Endpoints

13+ HTTP endpoints for health, chat, sessions, memory, scheduling

WebSocket

Real-time audio streaming with push-to-talk and VAD

MCP Tools

9 tools: voice, system health, sessions, workflows, scheduling