> ## Documentation Index
> Fetch the complete documentation index at: https://docs.elizaos.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# REST Reference

> Complete REST API documentation for the elizaOS platform

Welcome to the elizaOS REST Reference. This comprehensive guide covers all available REST endpoints and services for building and managing AI agents.

## Core APIs

<Card title="Agents" icon="robot" href="/rest-reference/agents/create-a-new-agent">
  Create, manage, and control AI agents. Handle agent lifecycle, configuration, and world management.
</Card>

<Card title="Messaging" icon="message" href="/rest-reference/messaging/create-server">
  Real-time messaging system for agent communication. Create servers, channels, and manage conversations.
</Card>

<Card title="Memory" icon="brain" href="/rest-reference/memory/get-agent-memories">
  Agent memory management. Store, retrieve, and organize agent memories and contextual information.
</Card>

<Card title="Rooms" icon="users" href="/rest-reference/rooms/create-a-room">
  Virtual spaces for agent interactions. Create and manage rooms for organized conversations.
</Card>

## Media & Audio

<Card title="Audio" icon="microphone" href="/rest-reference/audio/generate-speech-from-text">
  Speech synthesis, transcription, and audio processing capabilities.
</Card>

<Card title="Media" icon="image" href="/rest-reference/media/upload-media-for-agent">
  Media upload and management for agents and channels.
</Card>

## System & Monitoring

<Card title="System" icon="server" href="/rest-reference/system/basic-health-check">
  System status, health checks, and server management endpoints.
</Card>

<Card title="Logs" icon="file-text" href="/rest-reference/logs/get-agent-logs">
  Logging and debugging tools for agents and system operations.
</Card>

<Card title="WebSocket" icon="wifi" href="/rest-reference/websocket/socketio-real-time-connection">
  Real-time WebSocket connections for live agent interactions.
</Card>

## Getting Started

<Steps>
  <Step title="Authentication">
    Set up your API credentials and authentication tokens.
  </Step>

  <Step title="Create an Agent">
    Use the [Create Agent endpoint](/rest-reference/agents/create-a-new-agent) to start building.
  </Step>

  <Step title="Configure Messaging">
    Set up [messaging channels](/rest-reference/messaging/create-channel) for agent communication.
  </Step>

  <Step title="Test Integration">
    Use [health check endpoints](/rest-reference/system/basic-health-check) to verify your setup.
  </Step>
</Steps>

## API Standards

All API endpoints follow RESTful conventions:

* **GET** - Retrieve resources
* **POST** - Create new resources
* **PUT** - Update existing resources
* **DELETE** - Remove resources

Response formats are consistently JSON with appropriate HTTP status codes.

## Need Help?

<CardGroup cols={2}>
  <Card title="Core Concepts" icon="lightbulb" href="/runtime/core">
    Learn the fundamental concepts behind elizaOS
  </Card>

  <Card title="Create a Plugin" icon="book" href="/guides/create-a-plugin">
    Step-by-step integration guides
  </Card>
</CardGroup>