API Reference
Complete API documentation for the elizaOS platform
API Reference
Welcome to the elizaOS API Reference. This comprehensive guide covers all available endpoints and services for building and managing AI agents.Core APIs
Agents
Create, manage, and control AI agents. Handle agent lifecycle, configuration, and world management.
Messaging
Real-time messaging system for agent communication. Create servers, channels, and manage conversations.
Memory
Agent memory management. Store, retrieve, and organize agent memories and contextual information.
Rooms
Virtual spaces for agent interactions. Create and manage rooms for organized conversations.
Media & Audio
Audio
Speech synthesis, transcription, and audio processing capabilities.
Media
Media upload and management for agents and channels.
System & Monitoring
System
System status, health checks, and server management endpoints.
Logs
Logging and debugging tools for agents and system operations.
WebSocket
Real-time WebSocket connections for live agent interactions.
Getting Started
1
Authentication
Set up your API credentials and authentication tokens.
2
Create an Agent
Use the Create Agent endpoint to start building.
3
Configure Messaging
Set up messaging channels for agent communication.
4
Test Integration
Use health check endpoints to verify your setup.
API Standards
All API endpoints follow RESTful conventions:- GET - Retrieve resources
- POST - Create new resources
- PUT - Update existing resources
- DELETE - Remove resources