Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.agtos.ai/llms.txt

Use this file to discover all available pages before exploring further.

agtOS exposes three protocol interfaces. Each serves a different use case — pick the one that fits your integration.

REST API

Port 4102 — 40+ endpointsHealth, chat, memory, scheduling, devices, configuration, and Prometheus metrics. Used by the CLI, dashboard, and external integrations.

WebSocket

Port 3000 — Real-time audioBidirectional PCM audio streaming with session management, transcripts, word timestamps, and TTS playback.

MCP Tools

Port 4100 — 10 built-in toolsVoice, system, memory, workflow, and scheduling tools via Streamable HTTP. Connect from Claude Desktop, Cursor, or any MCP client.

​
Authentication

All API endpoints support opt-in authentication via the AGTOS_API_KEY environment variable.
When AGTOS_API_KEY is set, all /api/* endpoints require a Bearer token:
curl -H "Authorization: Bearer your-api-key" \
  http://localhost:4102/api/health
Health endpoints (/health, /metrics) remain open for monitoring.

​
Rate limiting

All API endpoints use token bucket rate limiting per client IP:
ScopeDefaultEnvironment Variable
General API (/api/*)100 req/minAPI_RATE_LIMIT
Chat, Tasks, Credentials20 req/minCHAT_RATE_LIMIT
Rate limit headers are included on every response: 
X-RateLimit-Remaining: 98

​
Quick examples

curl http://localhost:4102/api/health