Skip to main content

ElizaOS Documentation home page

Join Community
elizaos/eliza
elizaos/eliza

Plugin Registry

Launch Resources

Docs for LLMs

AGENTS

POST
Create a New Agent
GET
Get Agent Details
GET
List All Agents
PATCH
Update agent
DEL
Delete an agent
POST
Start an agent
POST
Stop an agent
GET
Get agent panels
POST
Create a world for an agent
GET
Get all worlds
PATCH
Update a world

AUDIO

POST
Generate speech from text
POST
Synthesize speech from text
POST
Transcribe audio
POST
Process audio message
POST
Convert conversation to speech

MESSAGING

POST
Create server
POST
Create channel
POST
Create central channel
POST
Create group channel
GET
Get or create DM channel
POST
Send message to channel
GET
Get channel messages
GET
Get channel details
GET
Get channel info
GET
Get channel participants
PATCH
Update channel
DEL
Delete channel
DEL
Delete channel message
DEL
Delete all channel messages
DEL
Delete all channel messages by user
POST
Add agent to server
POST
Add agent to channel
DEL
Remove agent from server
GET
Get server agents
GET
Get server channels
GET
Get central servers
GET
Get central server channels
POST
Process external message
POST
Ingest messages from external platforms
POST
Submit a message to the central messaging system
POST
Mark message processing as complete

SESSIONS API

POST
Create Session
GET
Get Session
POST
Send Session Message
GET
Get Session Messages
POST
Renew Session
PATCH
Update Session Timeout
POST
Session Heartbeat
DEL
End Session
GET
List Sessions
GET
Sessions Health Check

MEMORY

GET
Get agent memories
GET
Get room memories
POST
Create a room
PATCH
Update a memory
DEL
Delete all agent memories
DEL
Delete all memories for a room

ROOMS

POST
Create a room
GET
Get room details
GET
Get agent rooms
PATCH
Update a room
DEL
Delete a room

MEDIA

POST
Upload media for agent
POST
Upload media to channel

LOGS

GET
Get agent logs
GET
Get system logs
POST
Get system logs (POST)
DEL
Delete a specific log entry
DEL
Clear system logs

SYSTEM

GET
Basic health check
GET
Health check endpoint
GET
Ping health check
GET
Get system status
GET
Get server debug info
GET
Get server debug info
GET
Get local environment variables
POST
Update local environment variables
POST
Stop the server

WEBSOCKET

GET
Socket.IO Real-time Connection

MESSAGING

Get channel info

Get basic information for a specific channel (alias for details)

Documentation Index
Fetch the complete documentation index at: https://elizalabs-docs-x402-deployment-guide.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.

Was this page helpful?

Get channel details Get channel participants

⌘I

x github discord youtube linkedin

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.