Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This repository contains the comprehensive documentation for ElizaOS, including:
- **Getting Started** - Quick setup guides and tutorials
- **Core Concepts** - Understanding agents, plugins, and the architecture
- **Deep Dive** - Advanced topics like memory systems, services, and event handling
- **API Reference** - Complete API documentation for all modules
- **REST Reference** - Complete REST API documentation for all modules
- **Examples** - Real-world implementations and patterns

## Development
Expand Down Expand Up @@ -41,7 +41,7 @@ This will start a local development server at `http://localhost:3000` where you

```
docs/
├── api-reference/ # API documentation
├── rest-reference/ # REST API documentation
├── core-concepts/ # Core concepts and architecture
├── deep-dive/ # Advanced topics
├── images/ # Documentation images
Expand Down
164 changes: 82 additions & 82 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -95,136 +95,136 @@
]
},
{
"tab": "API Reference",
"pages": ["api-reference/index"],
"tab": "REST Reference",
"pages": ["rest-reference/index"],
"groups": [
{
"group": "AGENTS",
"pages": [
"api-reference/agents/create-a-new-agent",
"api-reference/agents/get-agent-details",
"api-reference/agents/list-all-agents",
"api-reference/agents/update-agent",
"api-reference/agents/delete-an-agent",
"api-reference/agents/start-an-agent",
"api-reference/agents/stop-an-agent",
"api-reference/agents/get-agent-panels",
"api-reference/agents/create-a-world-for-an-agent",
"api-reference/agents/get-all-worlds",
"api-reference/agents/update-a-world"
"rest-reference/agents/create-a-new-agent",
"rest-reference/agents/get-agent-details",
"rest-reference/agents/list-all-agents",
"rest-reference/agents/update-agent",
"rest-reference/agents/delete-an-agent",
"rest-reference/agents/start-an-agent",
"rest-reference/agents/stop-an-agent",
"rest-reference/agents/get-agent-panels",
"rest-reference/agents/create-a-world-for-an-agent",
"rest-reference/agents/get-all-worlds",
"rest-reference/agents/update-a-world"
]
},
{
"group": "AUDIO",
"pages": [
"api-reference/audio/generate-speech-from-text",
"api-reference/audio/synthesize-speech-from-text",
"api-reference/audio/transcribe-audio",
"api-reference/audio/process-audio-message",
"api-reference/audio/convert-conversation-to-speech"
"rest-reference/audio/generate-speech-from-text",
"rest-reference/audio/synthesize-speech-from-text",
"rest-reference/audio/transcribe-audio",
"rest-reference/audio/process-audio-message",
"rest-reference/audio/convert-conversation-to-speech"
]
},
{
"group": "MESSAGING",
"pages": [
"api-reference/messaging/create-server",
"api-reference/messaging/create-channel",
"api-reference/messaging/create-central-channel",
"api-reference/messaging/create-group-channel",
"api-reference/messaging/get-or-create-dm-channel",
"api-reference/messaging/send-message-to-channel",
"api-reference/messaging/get-channel-messages",
"api-reference/messaging/get-channel-details",
"api-reference/messaging/get-channel-info",
"api-reference/messaging/get-channel-participants",
"api-reference/messaging/update-channel",
"api-reference/messaging/delete-channel",
"api-reference/messaging/delete-channel-message",
"api-reference/messaging/delete-all-channel-messages",
"api-reference/messaging/delete-all-channel-messages-by-user",
"api-reference/messaging/add-agent-to-server",
"api-reference/messaging/add-agent-to-channel",
"api-reference/messaging/remove-agent-from-server",
"api-reference/messaging/get-server-agents",
"api-reference/messaging/get-server-channels",
"api-reference/messaging/get-central-servers",
"api-reference/messaging/get-central-server-channels",
"api-reference/messaging/process-external-message",
"api-reference/messaging/ingest-messages-from-external-platforms",
"api-reference/messaging/submit-a-message-to-the-central-messaging-system",
"api-reference/messaging/mark-message-processing-as-complete"
"rest-reference/messaging/create-server",
"rest-reference/messaging/create-channel",
"rest-reference/messaging/create-central-channel",
"rest-reference/messaging/create-group-channel",
"rest-reference/messaging/get-or-create-dm-channel",
"rest-reference/messaging/send-message-to-channel",
"rest-reference/messaging/get-channel-messages",
"rest-reference/messaging/get-channel-details",
"rest-reference/messaging/get-channel-info",
"rest-reference/messaging/get-channel-participants",
"rest-reference/messaging/update-channel",
"rest-reference/messaging/delete-channel",
"rest-reference/messaging/delete-channel-message",
"rest-reference/messaging/delete-all-channel-messages",
"rest-reference/messaging/delete-all-channel-messages-by-user",
"rest-reference/messaging/add-agent-to-server",
"rest-reference/messaging/add-agent-to-channel",
"rest-reference/messaging/remove-agent-from-server",
"rest-reference/messaging/get-server-agents",
"rest-reference/messaging/get-server-channels",
"rest-reference/messaging/get-central-servers",
"rest-reference/messaging/get-central-server-channels",
"rest-reference/messaging/process-external-message",
"rest-reference/messaging/ingest-messages-from-external-platforms",
"rest-reference/messaging/submit-a-message-to-the-central-messaging-system",
"rest-reference/messaging/mark-message-processing-as-complete"
]
},
{
"group": "SESSIONS API",
"pages": [
"api-reference/messaging/create-session",
"api-reference/messaging/get-session",
"api-reference/messaging/send-session-message",
"api-reference/messaging/get-session-messages",
"api-reference/messaging/renew-session",
"api-reference/messaging/update-session-timeout",
"api-reference/messaging/session-heartbeat",
"api-reference/messaging/end-session",
"api-reference/messaging/list-sessions",
"api-reference/messaging/sessions-health-check"
"rest-reference/messaging/create-session",
"rest-reference/messaging/get-session",
"rest-reference/messaging/send-session-message",
"rest-reference/messaging/get-session-messages",
"rest-reference/messaging/renew-session",
"rest-reference/messaging/update-session-timeout",
"rest-reference/messaging/session-heartbeat",
"rest-reference/messaging/end-session",
"rest-reference/messaging/list-sessions",
"rest-reference/messaging/sessions-health-check"
]
},
{
"group": "MEMORY",
"pages": [
"api-reference/memory/get-agent-memories",
"api-reference/memory/get-room-memories",
"api-reference/memory/create-a-room",
"api-reference/memory/update-a-memory",
"api-reference/memory/delete-all-agent-memories",
"api-reference/memory/delete-all-memories-for-a-room"
"rest-reference/memory/get-agent-memories",
"rest-reference/memory/get-room-memories",
"rest-reference/memory/create-a-room",
"rest-reference/memory/update-a-memory",
"rest-reference/memory/delete-all-agent-memories",
"rest-reference/memory/delete-all-memories-for-a-room"
]
},
{
"group": "ROOMS",
"pages": [
"api-reference/rooms/create-a-room",
"api-reference/rooms/get-room-details",
"api-reference/rooms/get-agent-rooms",
"api-reference/rooms/update-a-room",
"api-reference/rooms/delete-a-room"
"rest-reference/rooms/create-a-room",
"rest-reference/rooms/get-room-details",
"rest-reference/rooms/get-agent-rooms",
"rest-reference/rooms/update-a-room",
"rest-reference/rooms/delete-a-room"
]
},
{
"group": "MEDIA",
"pages": [
"api-reference/media/upload-media-for-agent",
"api-reference/media/upload-media-to-channel"
"rest-reference/media/upload-media-for-agent",
"rest-reference/media/upload-media-to-channel"
]
},
{
"group": "LOGS",
"pages": [
"api-reference/logs/get-agent-logs",
"api-reference/logs/get-system-logs",
"api-reference/logs/get-system-logs-post",
"api-reference/logs/delete-a-specific-log-entry",
"api-reference/logs/clear-system-logs"
"rest-reference/logs/get-agent-logs",
"rest-reference/logs/get-system-logs",
"rest-reference/logs/get-system-logs-post",
"rest-reference/logs/delete-a-specific-log-entry",
"rest-reference/logs/clear-system-logs"
]
},
{
"group": "SYSTEM",
"pages": [
"api-reference/system/basic-health-check",
"api-reference/system/health-check-endpoint",
"api-reference/system/ping-health-check",
"api-reference/system/get-system-status",
"api-reference/system/get-server-debug-info",
"api-reference/system/get-server-debug-info-1",
"api-reference/system/get-local-environment-variables",
"api-reference/system/update-local-environment-variables",
"api-reference/system/stop-the-server"
"rest-reference/system/basic-health-check",
"rest-reference/system/health-check-endpoint",
"rest-reference/system/ping-health-check",
"rest-reference/system/get-system-status",
"rest-reference/system/get-server-debug-info",
"rest-reference/system/get-server-debug-info-1",
"rest-reference/system/get-local-environment-variables",
"rest-reference/system/update-local-environment-variables",
"rest-reference/system/stop-the-server"
]
},
{
"group": "WEBSOCKET",
"pages": ["api-reference/websocket/socketio-real-time-connection"]
"pages": ["rest-reference/websocket/socketio-real-time-connection"]
}
]
},
Expand Down
4 changes: 2 additions & 2 deletions index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ Get started with one of the quick links below, or read on to learn more about el
horizontal
/>
<Card
title="API Reference"
title="REST Reference"
icon="terminal"
href="/api-reference/agents/create-a-new-agent"
href="/rest-reference/agents/create-a-new-agent"
horizontal
/>
<Card
Expand Down
2 changes: 1 addition & 1 deletion projects/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ For a complete list of all available environment variables including database co
Manage environment variables with the CLI
</Card>

<Card title="API Reference" icon="code" href="/api-reference">
<Card title="REST Reference" icon="code" href="/rest-reference">
Explore the REST API that these variables protect
</Card>

Expand Down
2 changes: 1 addition & 1 deletion projects/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ See the [Deploy a Project](/guides/deploy-a-project) guide for detailed instruct
Complete command reference
</Card>

<Card title="API Reference" icon="code" href="/api-reference">
<Card title="REST Reference" icon="code" href="/rest-reference">
REST API documentation
</Card>
</CardGroup>
30 changes: 15 additions & 15 deletions api-reference/index.mdx → rest-reference/index.mdx
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
---
title: "API Reference"
description: "Complete API documentation for the elizaOS platform"
title: "REST Reference"
description: "Complete REST API documentation for the elizaOS platform"
---

Welcome to the elizaOS API Reference. This comprehensive guide covers all available endpoints and services for building and managing AI agents.
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="/api-reference/agents/create-a-new-agent">
<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="/api-reference/messaging/create-server">
<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="/api-reference/memory/get-agent-memories">
<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="/api-reference/rooms/create-a-room">
<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="/api-reference/audio/generate-speech-from-text">
<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="/api-reference/media/upload-media-for-agent">
<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="/api-reference/system/basic-health-check">
<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="/api-reference/logs/get-agent-logs">
<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="/api-reference/websocket/socketio-real-time-connection">
<Card title="WebSocket" icon="wifi" href="/rest-reference/websocket/socketio-real-time-connection">
Real-time WebSocket connections for live agent interactions.
</Card>

Expand All @@ -54,13 +54,13 @@ Welcome to the elizaOS API Reference. This comprehensive guide covers all availa
Set up your API credentials and authentication tokens.
</Step>
<Step title="Create an Agent">
Use the [Create Agent endpoint](/api-reference/agents/create-a-new-agent) to start building.
Use the [Create Agent endpoint](/rest-reference/agents/create-a-new-agent) to start building.
</Step>
<Step title="Configure Messaging">
Set up [messaging channels](/api-reference/messaging/create-channel) for agent communication.
Set up [messaging channels](/rest-reference/messaging/create-channel) for agent communication.
</Step>
<Step title="Test Integration">
Use [health check endpoints](/api-reference/system/basic-health-check) to verify your setup.
Use [health check endpoints](/rest-reference/system/basic-health-check) to verify your setup.
</Step>
</Steps>

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion runtime/sessions-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1953,7 +1953,7 @@ class SessionsAPIClient:
## See Also

<CardGroup cols={2}>
<Card title="WebSocket Integration" icon="wifi" href="/api-reference/websocket/socketio-real-time-connection">
<Card title="WebSocket Integration" icon="wifi" href="/rest-reference/websocket/socketio-real-time-connection">
Add real-time capabilities to your sessions
</Card>
<Card title="Core Concepts" icon="lightbulb" href="/agents/runtime-and-lifecycle">
Expand Down
Loading