From 251ef48cdafbe3adf2acdb01d6cd0e478d59e0f8 Mon Sep 17 00:00:00 2001 From: yung algorithm <113615973+yungalgo@users.noreply.github.com> Date: Wed, 22 Oct 2025 12:10:05 -0700 Subject: [PATCH 1/2] swap out api reference for rest reference --- README.md | 2 +- docs.json | 164 +++++++++--------- index.mdx | 4 +- projects/environment-variables.mdx | 2 +- projects/overview.mdx | 2 +- .../agents/create-a-new-agent.mdx | 0 .../agents/create-a-world-for-an-agent.mdx | 0 .../agents/delete-an-agent.mdx | 0 .../agents/get-agent-details.mdx | 0 .../agents/get-agent-panels.mdx | 0 .../agents/get-all-worlds.mdx | 0 .../agents/list-all-agents.mdx | 0 .../agents/start-an-agent.mdx | 0 .../agents/stop-an-agent.mdx | 0 .../agents/update-a-world.mdx | 0 .../agents/update-agent.mdx | 0 .../audio/convert-conversation-to-speech.mdx | 0 .../audio/generate-speech-from-text.mdx | 0 .../audio/process-audio-message.mdx | 0 .../audio/synthesize-speech-from-text.mdx | 0 .../audio/transcribe-audio.mdx | 0 {api-reference => rest-reference}/index.mdx | 30 ++-- .../logs/clear-system-logs.mdx | 0 .../logs/delete-a-specific-log-entry.mdx | 0 .../logs/get-agent-logs.mdx | 0 .../logs/get-system-logs-post.mdx | 0 .../logs/get-system-logs.mdx | 0 .../media/upload-media-for-agent.mdx | 0 .../media/upload-media-to-channel.mdx | 0 .../memory/create-a-room.mdx | 0 .../memory/delete-all-agent-memories.mdx | 0 .../memory/delete-all-memories-for-a-room.mdx | 0 .../memory/get-agent-memories.mdx | 0 .../memory/get-room-memories.mdx | 0 .../memory/update-a-memory.mdx | 0 .../messaging/add-agent-to-channel.mdx | 0 .../messaging/add-agent-to-server.mdx | 0 .../messaging/create-central-channel.mdx | 0 .../messaging/create-channel.mdx | 0 .../messaging/create-group-channel.mdx | 0 .../messaging/create-server.mdx | 0 .../messaging/create-session.mdx | 0 .../delete-all-channel-messages-by-user.mdx | 0 .../messaging/delete-all-channel-messages.mdx | 0 .../messaging/delete-channel-message.mdx | 0 .../messaging/delete-channel.mdx | 0 .../messaging/end-session.mdx | 0 .../messaging/get-central-server-channels.mdx | 0 .../messaging/get-central-servers.mdx | 0 .../messaging/get-channel-details.mdx | 0 .../messaging/get-channel-info.mdx | 0 .../messaging/get-channel-messages.mdx | 0 .../messaging/get-channel-participants.mdx | 0 .../messaging/get-or-create-dm-channel.mdx | 0 .../messaging/get-server-agents.mdx | 0 .../messaging/get-server-channels.mdx | 0 .../messaging/get-session-messages.mdx | 0 .../messaging/get-session.mdx | 0 ...ngest-messages-from-external-platforms.mdx | 0 .../messaging/list-sessions.mdx | 0 .../mark-message-processing-as-complete.mdx | 0 .../messaging/process-external-message.mdx | 0 .../messaging/remove-agent-from-server.mdx | 0 .../messaging/renew-session.mdx | 0 .../messaging/send-message-to-channel.mdx | 0 .../messaging/send-session-message.mdx | 0 .../messaging/session-heartbeat.mdx | 0 .../messaging/sessions-health-check.mdx | 0 ...essage-to-the-central-messaging-system.mdx | 0 .../messaging/update-channel.mdx | 0 .../messaging/update-session-timeout.mdx | 0 .../openapi.yaml | 0 .../rooms/create-a-room.mdx | 0 .../rooms/delete-a-room.mdx | 0 .../rooms/get-agent-rooms.mdx | 0 .../rooms/get-room-details.mdx | 0 .../rooms/update-a-room.mdx | 0 .../system/basic-health-check.mdx | 0 .../get-local-environment-variables.mdx | 0 .../system/get-server-debug-info-1.mdx | 0 .../system/get-server-debug-info.mdx | 0 .../system/get-system-status.mdx | 0 .../system/health-check-endpoint.mdx | 0 .../system/ping-health-check.mdx | 0 .../system/stop-the-server.mdx | 0 .../update-local-environment-variables.mdx | 0 .../socketio-real-time-connection.mdx | 0 runtime/sessions-api.mdx | 2 +- 88 files changed, 103 insertions(+), 103 deletions(-) rename {api-reference => rest-reference}/agents/create-a-new-agent.mdx (100%) rename {api-reference => rest-reference}/agents/create-a-world-for-an-agent.mdx (100%) rename {api-reference => rest-reference}/agents/delete-an-agent.mdx (100%) rename {api-reference => rest-reference}/agents/get-agent-details.mdx (100%) rename {api-reference => rest-reference}/agents/get-agent-panels.mdx (100%) rename {api-reference => rest-reference}/agents/get-all-worlds.mdx (100%) rename {api-reference => rest-reference}/agents/list-all-agents.mdx (100%) rename {api-reference => rest-reference}/agents/start-an-agent.mdx (100%) rename {api-reference => rest-reference}/agents/stop-an-agent.mdx (100%) rename {api-reference => rest-reference}/agents/update-a-world.mdx (100%) rename {api-reference => rest-reference}/agents/update-agent.mdx (100%) rename {api-reference => rest-reference}/audio/convert-conversation-to-speech.mdx (100%) rename {api-reference => rest-reference}/audio/generate-speech-from-text.mdx (100%) rename {api-reference => rest-reference}/audio/process-audio-message.mdx (100%) rename {api-reference => rest-reference}/audio/synthesize-speech-from-text.mdx (100%) rename {api-reference => rest-reference}/audio/transcribe-audio.mdx (100%) rename {api-reference => rest-reference}/index.mdx (57%) rename {api-reference => rest-reference}/logs/clear-system-logs.mdx (100%) rename {api-reference => rest-reference}/logs/delete-a-specific-log-entry.mdx (100%) rename {api-reference => rest-reference}/logs/get-agent-logs.mdx (100%) rename {api-reference => rest-reference}/logs/get-system-logs-post.mdx (100%) rename {api-reference => rest-reference}/logs/get-system-logs.mdx (100%) rename {api-reference => rest-reference}/media/upload-media-for-agent.mdx (100%) rename {api-reference => rest-reference}/media/upload-media-to-channel.mdx (100%) rename {api-reference => rest-reference}/memory/create-a-room.mdx (100%) rename {api-reference => rest-reference}/memory/delete-all-agent-memories.mdx (100%) rename {api-reference => rest-reference}/memory/delete-all-memories-for-a-room.mdx (100%) rename {api-reference => rest-reference}/memory/get-agent-memories.mdx (100%) rename {api-reference => rest-reference}/memory/get-room-memories.mdx (100%) rename {api-reference => rest-reference}/memory/update-a-memory.mdx (100%) rename {api-reference => rest-reference}/messaging/add-agent-to-channel.mdx (100%) rename {api-reference => rest-reference}/messaging/add-agent-to-server.mdx (100%) rename {api-reference => rest-reference}/messaging/create-central-channel.mdx (100%) rename {api-reference => rest-reference}/messaging/create-channel.mdx (100%) rename {api-reference => rest-reference}/messaging/create-group-channel.mdx (100%) rename {api-reference => rest-reference}/messaging/create-server.mdx (100%) rename {api-reference => rest-reference}/messaging/create-session.mdx (100%) rename {api-reference => rest-reference}/messaging/delete-all-channel-messages-by-user.mdx (100%) rename {api-reference => rest-reference}/messaging/delete-all-channel-messages.mdx (100%) rename {api-reference => rest-reference}/messaging/delete-channel-message.mdx (100%) rename {api-reference => rest-reference}/messaging/delete-channel.mdx (100%) rename {api-reference => rest-reference}/messaging/end-session.mdx (100%) rename {api-reference => rest-reference}/messaging/get-central-server-channels.mdx (100%) rename {api-reference => rest-reference}/messaging/get-central-servers.mdx (100%) rename {api-reference => rest-reference}/messaging/get-channel-details.mdx (100%) rename {api-reference => rest-reference}/messaging/get-channel-info.mdx (100%) rename {api-reference => rest-reference}/messaging/get-channel-messages.mdx (100%) rename {api-reference => rest-reference}/messaging/get-channel-participants.mdx (100%) rename {api-reference => rest-reference}/messaging/get-or-create-dm-channel.mdx (100%) rename {api-reference => rest-reference}/messaging/get-server-agents.mdx (100%) rename {api-reference => rest-reference}/messaging/get-server-channels.mdx (100%) rename {api-reference => rest-reference}/messaging/get-session-messages.mdx (100%) rename {api-reference => rest-reference}/messaging/get-session.mdx (100%) rename {api-reference => rest-reference}/messaging/ingest-messages-from-external-platforms.mdx (100%) rename {api-reference => rest-reference}/messaging/list-sessions.mdx (100%) rename {api-reference => rest-reference}/messaging/mark-message-processing-as-complete.mdx (100%) rename {api-reference => rest-reference}/messaging/process-external-message.mdx (100%) rename {api-reference => rest-reference}/messaging/remove-agent-from-server.mdx (100%) rename {api-reference => rest-reference}/messaging/renew-session.mdx (100%) rename {api-reference => rest-reference}/messaging/send-message-to-channel.mdx (100%) rename {api-reference => rest-reference}/messaging/send-session-message.mdx (100%) rename {api-reference => rest-reference}/messaging/session-heartbeat.mdx (100%) rename {api-reference => rest-reference}/messaging/sessions-health-check.mdx (100%) rename {api-reference => rest-reference}/messaging/submit-a-message-to-the-central-messaging-system.mdx (100%) rename {api-reference => rest-reference}/messaging/update-channel.mdx (100%) rename {api-reference => rest-reference}/messaging/update-session-timeout.mdx (100%) rename {api-reference => rest-reference}/openapi.yaml (100%) rename {api-reference => rest-reference}/rooms/create-a-room.mdx (100%) rename {api-reference => rest-reference}/rooms/delete-a-room.mdx (100%) rename {api-reference => rest-reference}/rooms/get-agent-rooms.mdx (100%) rename {api-reference => rest-reference}/rooms/get-room-details.mdx (100%) rename {api-reference => rest-reference}/rooms/update-a-room.mdx (100%) rename {api-reference => rest-reference}/system/basic-health-check.mdx (100%) rename {api-reference => rest-reference}/system/get-local-environment-variables.mdx (100%) rename {api-reference => rest-reference}/system/get-server-debug-info-1.mdx (100%) rename {api-reference => rest-reference}/system/get-server-debug-info.mdx (100%) rename {api-reference => rest-reference}/system/get-system-status.mdx (100%) rename {api-reference => rest-reference}/system/health-check-endpoint.mdx (100%) rename {api-reference => rest-reference}/system/ping-health-check.mdx (100%) rename {api-reference => rest-reference}/system/stop-the-server.mdx (100%) rename {api-reference => rest-reference}/system/update-local-environment-variables.mdx (100%) rename {api-reference => rest-reference}/websocket/socketio-real-time-connection.mdx (100%) diff --git a/README.md b/README.md index b93f81e..94e5ed1 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs.json b/docs.json index 17347c1..5966fe0 100644 --- a/docs.json +++ b/docs.json @@ -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"] } ] }, diff --git a/index.mdx b/index.mdx index 9f845c6..bccf74d 100644 --- a/index.mdx +++ b/index.mdx @@ -35,9 +35,9 @@ Get started with one of the quick links below, or read on to learn more about el horizontal /> - + Explore the REST API that these variables protect diff --git a/projects/overview.mdx b/projects/overview.mdx index cfcf26b..224b171 100644 --- a/projects/overview.mdx +++ b/projects/overview.mdx @@ -415,7 +415,7 @@ See the [Deploy a Project](/guides/deploy-a-project) guide for detailed instruct Complete command reference - + REST API documentation diff --git a/api-reference/agents/create-a-new-agent.mdx b/rest-reference/agents/create-a-new-agent.mdx similarity index 100% rename from api-reference/agents/create-a-new-agent.mdx rename to rest-reference/agents/create-a-new-agent.mdx diff --git a/api-reference/agents/create-a-world-for-an-agent.mdx b/rest-reference/agents/create-a-world-for-an-agent.mdx similarity index 100% rename from api-reference/agents/create-a-world-for-an-agent.mdx rename to rest-reference/agents/create-a-world-for-an-agent.mdx diff --git a/api-reference/agents/delete-an-agent.mdx b/rest-reference/agents/delete-an-agent.mdx similarity index 100% rename from api-reference/agents/delete-an-agent.mdx rename to rest-reference/agents/delete-an-agent.mdx diff --git a/api-reference/agents/get-agent-details.mdx b/rest-reference/agents/get-agent-details.mdx similarity index 100% rename from api-reference/agents/get-agent-details.mdx rename to rest-reference/agents/get-agent-details.mdx diff --git a/api-reference/agents/get-agent-panels.mdx b/rest-reference/agents/get-agent-panels.mdx similarity index 100% rename from api-reference/agents/get-agent-panels.mdx rename to rest-reference/agents/get-agent-panels.mdx diff --git a/api-reference/agents/get-all-worlds.mdx b/rest-reference/agents/get-all-worlds.mdx similarity index 100% rename from api-reference/agents/get-all-worlds.mdx rename to rest-reference/agents/get-all-worlds.mdx diff --git a/api-reference/agents/list-all-agents.mdx b/rest-reference/agents/list-all-agents.mdx similarity index 100% rename from api-reference/agents/list-all-agents.mdx rename to rest-reference/agents/list-all-agents.mdx diff --git a/api-reference/agents/start-an-agent.mdx b/rest-reference/agents/start-an-agent.mdx similarity index 100% rename from api-reference/agents/start-an-agent.mdx rename to rest-reference/agents/start-an-agent.mdx diff --git a/api-reference/agents/stop-an-agent.mdx b/rest-reference/agents/stop-an-agent.mdx similarity index 100% rename from api-reference/agents/stop-an-agent.mdx rename to rest-reference/agents/stop-an-agent.mdx diff --git a/api-reference/agents/update-a-world.mdx b/rest-reference/agents/update-a-world.mdx similarity index 100% rename from api-reference/agents/update-a-world.mdx rename to rest-reference/agents/update-a-world.mdx diff --git a/api-reference/agents/update-agent.mdx b/rest-reference/agents/update-agent.mdx similarity index 100% rename from api-reference/agents/update-agent.mdx rename to rest-reference/agents/update-agent.mdx diff --git a/api-reference/audio/convert-conversation-to-speech.mdx b/rest-reference/audio/convert-conversation-to-speech.mdx similarity index 100% rename from api-reference/audio/convert-conversation-to-speech.mdx rename to rest-reference/audio/convert-conversation-to-speech.mdx diff --git a/api-reference/audio/generate-speech-from-text.mdx b/rest-reference/audio/generate-speech-from-text.mdx similarity index 100% rename from api-reference/audio/generate-speech-from-text.mdx rename to rest-reference/audio/generate-speech-from-text.mdx diff --git a/api-reference/audio/process-audio-message.mdx b/rest-reference/audio/process-audio-message.mdx similarity index 100% rename from api-reference/audio/process-audio-message.mdx rename to rest-reference/audio/process-audio-message.mdx diff --git a/api-reference/audio/synthesize-speech-from-text.mdx b/rest-reference/audio/synthesize-speech-from-text.mdx similarity index 100% rename from api-reference/audio/synthesize-speech-from-text.mdx rename to rest-reference/audio/synthesize-speech-from-text.mdx diff --git a/api-reference/audio/transcribe-audio.mdx b/rest-reference/audio/transcribe-audio.mdx similarity index 100% rename from api-reference/audio/transcribe-audio.mdx rename to rest-reference/audio/transcribe-audio.mdx diff --git a/api-reference/index.mdx b/rest-reference/index.mdx similarity index 57% rename from api-reference/index.mdx rename to rest-reference/index.mdx index d504c6b..40eb585 100644 --- a/api-reference/index.mdx +++ b/rest-reference/index.mdx @@ -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 - + Create, manage, and control AI agents. Handle agent lifecycle, configuration, and world management. - + Real-time messaging system for agent communication. Create servers, channels, and manage conversations. - + Agent memory management. Store, retrieve, and organize agent memories and contextual information. - + Virtual spaces for agent interactions. Create and manage rooms for organized conversations. ## Media & Audio - + Speech synthesis, transcription, and audio processing capabilities. - + Media upload and management for agents and channels. ## System & Monitoring - + System status, health checks, and server management endpoints. - + Logging and debugging tools for agents and system operations. - + Real-time WebSocket connections for live agent interactions. @@ -54,13 +54,13 @@ Welcome to the elizaOS API Reference. This comprehensive guide covers all availa Set up your API credentials and authentication tokens. - 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. - Set up [messaging channels](/api-reference/messaging/create-channel) for agent communication. + Set up [messaging channels](/rest-reference/messaging/create-channel) for agent communication. - 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. diff --git a/api-reference/logs/clear-system-logs.mdx b/rest-reference/logs/clear-system-logs.mdx similarity index 100% rename from api-reference/logs/clear-system-logs.mdx rename to rest-reference/logs/clear-system-logs.mdx diff --git a/api-reference/logs/delete-a-specific-log-entry.mdx b/rest-reference/logs/delete-a-specific-log-entry.mdx similarity index 100% rename from api-reference/logs/delete-a-specific-log-entry.mdx rename to rest-reference/logs/delete-a-specific-log-entry.mdx diff --git a/api-reference/logs/get-agent-logs.mdx b/rest-reference/logs/get-agent-logs.mdx similarity index 100% rename from api-reference/logs/get-agent-logs.mdx rename to rest-reference/logs/get-agent-logs.mdx diff --git a/api-reference/logs/get-system-logs-post.mdx b/rest-reference/logs/get-system-logs-post.mdx similarity index 100% rename from api-reference/logs/get-system-logs-post.mdx rename to rest-reference/logs/get-system-logs-post.mdx diff --git a/api-reference/logs/get-system-logs.mdx b/rest-reference/logs/get-system-logs.mdx similarity index 100% rename from api-reference/logs/get-system-logs.mdx rename to rest-reference/logs/get-system-logs.mdx diff --git a/api-reference/media/upload-media-for-agent.mdx b/rest-reference/media/upload-media-for-agent.mdx similarity index 100% rename from api-reference/media/upload-media-for-agent.mdx rename to rest-reference/media/upload-media-for-agent.mdx diff --git a/api-reference/media/upload-media-to-channel.mdx b/rest-reference/media/upload-media-to-channel.mdx similarity index 100% rename from api-reference/media/upload-media-to-channel.mdx rename to rest-reference/media/upload-media-to-channel.mdx diff --git a/api-reference/memory/create-a-room.mdx b/rest-reference/memory/create-a-room.mdx similarity index 100% rename from api-reference/memory/create-a-room.mdx rename to rest-reference/memory/create-a-room.mdx diff --git a/api-reference/memory/delete-all-agent-memories.mdx b/rest-reference/memory/delete-all-agent-memories.mdx similarity index 100% rename from api-reference/memory/delete-all-agent-memories.mdx rename to rest-reference/memory/delete-all-agent-memories.mdx diff --git a/api-reference/memory/delete-all-memories-for-a-room.mdx b/rest-reference/memory/delete-all-memories-for-a-room.mdx similarity index 100% rename from api-reference/memory/delete-all-memories-for-a-room.mdx rename to rest-reference/memory/delete-all-memories-for-a-room.mdx diff --git a/api-reference/memory/get-agent-memories.mdx b/rest-reference/memory/get-agent-memories.mdx similarity index 100% rename from api-reference/memory/get-agent-memories.mdx rename to rest-reference/memory/get-agent-memories.mdx diff --git a/api-reference/memory/get-room-memories.mdx b/rest-reference/memory/get-room-memories.mdx similarity index 100% rename from api-reference/memory/get-room-memories.mdx rename to rest-reference/memory/get-room-memories.mdx diff --git a/api-reference/memory/update-a-memory.mdx b/rest-reference/memory/update-a-memory.mdx similarity index 100% rename from api-reference/memory/update-a-memory.mdx rename to rest-reference/memory/update-a-memory.mdx diff --git a/api-reference/messaging/add-agent-to-channel.mdx b/rest-reference/messaging/add-agent-to-channel.mdx similarity index 100% rename from api-reference/messaging/add-agent-to-channel.mdx rename to rest-reference/messaging/add-agent-to-channel.mdx diff --git a/api-reference/messaging/add-agent-to-server.mdx b/rest-reference/messaging/add-agent-to-server.mdx similarity index 100% rename from api-reference/messaging/add-agent-to-server.mdx rename to rest-reference/messaging/add-agent-to-server.mdx diff --git a/api-reference/messaging/create-central-channel.mdx b/rest-reference/messaging/create-central-channel.mdx similarity index 100% rename from api-reference/messaging/create-central-channel.mdx rename to rest-reference/messaging/create-central-channel.mdx diff --git a/api-reference/messaging/create-channel.mdx b/rest-reference/messaging/create-channel.mdx similarity index 100% rename from api-reference/messaging/create-channel.mdx rename to rest-reference/messaging/create-channel.mdx diff --git a/api-reference/messaging/create-group-channel.mdx b/rest-reference/messaging/create-group-channel.mdx similarity index 100% rename from api-reference/messaging/create-group-channel.mdx rename to rest-reference/messaging/create-group-channel.mdx diff --git a/api-reference/messaging/create-server.mdx b/rest-reference/messaging/create-server.mdx similarity index 100% rename from api-reference/messaging/create-server.mdx rename to rest-reference/messaging/create-server.mdx diff --git a/api-reference/messaging/create-session.mdx b/rest-reference/messaging/create-session.mdx similarity index 100% rename from api-reference/messaging/create-session.mdx rename to rest-reference/messaging/create-session.mdx diff --git a/api-reference/messaging/delete-all-channel-messages-by-user.mdx b/rest-reference/messaging/delete-all-channel-messages-by-user.mdx similarity index 100% rename from api-reference/messaging/delete-all-channel-messages-by-user.mdx rename to rest-reference/messaging/delete-all-channel-messages-by-user.mdx diff --git a/api-reference/messaging/delete-all-channel-messages.mdx b/rest-reference/messaging/delete-all-channel-messages.mdx similarity index 100% rename from api-reference/messaging/delete-all-channel-messages.mdx rename to rest-reference/messaging/delete-all-channel-messages.mdx diff --git a/api-reference/messaging/delete-channel-message.mdx b/rest-reference/messaging/delete-channel-message.mdx similarity index 100% rename from api-reference/messaging/delete-channel-message.mdx rename to rest-reference/messaging/delete-channel-message.mdx diff --git a/api-reference/messaging/delete-channel.mdx b/rest-reference/messaging/delete-channel.mdx similarity index 100% rename from api-reference/messaging/delete-channel.mdx rename to rest-reference/messaging/delete-channel.mdx diff --git a/api-reference/messaging/end-session.mdx b/rest-reference/messaging/end-session.mdx similarity index 100% rename from api-reference/messaging/end-session.mdx rename to rest-reference/messaging/end-session.mdx diff --git a/api-reference/messaging/get-central-server-channels.mdx b/rest-reference/messaging/get-central-server-channels.mdx similarity index 100% rename from api-reference/messaging/get-central-server-channels.mdx rename to rest-reference/messaging/get-central-server-channels.mdx diff --git a/api-reference/messaging/get-central-servers.mdx b/rest-reference/messaging/get-central-servers.mdx similarity index 100% rename from api-reference/messaging/get-central-servers.mdx rename to rest-reference/messaging/get-central-servers.mdx diff --git a/api-reference/messaging/get-channel-details.mdx b/rest-reference/messaging/get-channel-details.mdx similarity index 100% rename from api-reference/messaging/get-channel-details.mdx rename to rest-reference/messaging/get-channel-details.mdx diff --git a/api-reference/messaging/get-channel-info.mdx b/rest-reference/messaging/get-channel-info.mdx similarity index 100% rename from api-reference/messaging/get-channel-info.mdx rename to rest-reference/messaging/get-channel-info.mdx diff --git a/api-reference/messaging/get-channel-messages.mdx b/rest-reference/messaging/get-channel-messages.mdx similarity index 100% rename from api-reference/messaging/get-channel-messages.mdx rename to rest-reference/messaging/get-channel-messages.mdx diff --git a/api-reference/messaging/get-channel-participants.mdx b/rest-reference/messaging/get-channel-participants.mdx similarity index 100% rename from api-reference/messaging/get-channel-participants.mdx rename to rest-reference/messaging/get-channel-participants.mdx diff --git a/api-reference/messaging/get-or-create-dm-channel.mdx b/rest-reference/messaging/get-or-create-dm-channel.mdx similarity index 100% rename from api-reference/messaging/get-or-create-dm-channel.mdx rename to rest-reference/messaging/get-or-create-dm-channel.mdx diff --git a/api-reference/messaging/get-server-agents.mdx b/rest-reference/messaging/get-server-agents.mdx similarity index 100% rename from api-reference/messaging/get-server-agents.mdx rename to rest-reference/messaging/get-server-agents.mdx diff --git a/api-reference/messaging/get-server-channels.mdx b/rest-reference/messaging/get-server-channels.mdx similarity index 100% rename from api-reference/messaging/get-server-channels.mdx rename to rest-reference/messaging/get-server-channels.mdx diff --git a/api-reference/messaging/get-session-messages.mdx b/rest-reference/messaging/get-session-messages.mdx similarity index 100% rename from api-reference/messaging/get-session-messages.mdx rename to rest-reference/messaging/get-session-messages.mdx diff --git a/api-reference/messaging/get-session.mdx b/rest-reference/messaging/get-session.mdx similarity index 100% rename from api-reference/messaging/get-session.mdx rename to rest-reference/messaging/get-session.mdx diff --git a/api-reference/messaging/ingest-messages-from-external-platforms.mdx b/rest-reference/messaging/ingest-messages-from-external-platforms.mdx similarity index 100% rename from api-reference/messaging/ingest-messages-from-external-platforms.mdx rename to rest-reference/messaging/ingest-messages-from-external-platforms.mdx diff --git a/api-reference/messaging/list-sessions.mdx b/rest-reference/messaging/list-sessions.mdx similarity index 100% rename from api-reference/messaging/list-sessions.mdx rename to rest-reference/messaging/list-sessions.mdx diff --git a/api-reference/messaging/mark-message-processing-as-complete.mdx b/rest-reference/messaging/mark-message-processing-as-complete.mdx similarity index 100% rename from api-reference/messaging/mark-message-processing-as-complete.mdx rename to rest-reference/messaging/mark-message-processing-as-complete.mdx diff --git a/api-reference/messaging/process-external-message.mdx b/rest-reference/messaging/process-external-message.mdx similarity index 100% rename from api-reference/messaging/process-external-message.mdx rename to rest-reference/messaging/process-external-message.mdx diff --git a/api-reference/messaging/remove-agent-from-server.mdx b/rest-reference/messaging/remove-agent-from-server.mdx similarity index 100% rename from api-reference/messaging/remove-agent-from-server.mdx rename to rest-reference/messaging/remove-agent-from-server.mdx diff --git a/api-reference/messaging/renew-session.mdx b/rest-reference/messaging/renew-session.mdx similarity index 100% rename from api-reference/messaging/renew-session.mdx rename to rest-reference/messaging/renew-session.mdx diff --git a/api-reference/messaging/send-message-to-channel.mdx b/rest-reference/messaging/send-message-to-channel.mdx similarity index 100% rename from api-reference/messaging/send-message-to-channel.mdx rename to rest-reference/messaging/send-message-to-channel.mdx diff --git a/api-reference/messaging/send-session-message.mdx b/rest-reference/messaging/send-session-message.mdx similarity index 100% rename from api-reference/messaging/send-session-message.mdx rename to rest-reference/messaging/send-session-message.mdx diff --git a/api-reference/messaging/session-heartbeat.mdx b/rest-reference/messaging/session-heartbeat.mdx similarity index 100% rename from api-reference/messaging/session-heartbeat.mdx rename to rest-reference/messaging/session-heartbeat.mdx diff --git a/api-reference/messaging/sessions-health-check.mdx b/rest-reference/messaging/sessions-health-check.mdx similarity index 100% rename from api-reference/messaging/sessions-health-check.mdx rename to rest-reference/messaging/sessions-health-check.mdx diff --git a/api-reference/messaging/submit-a-message-to-the-central-messaging-system.mdx b/rest-reference/messaging/submit-a-message-to-the-central-messaging-system.mdx similarity index 100% rename from api-reference/messaging/submit-a-message-to-the-central-messaging-system.mdx rename to rest-reference/messaging/submit-a-message-to-the-central-messaging-system.mdx diff --git a/api-reference/messaging/update-channel.mdx b/rest-reference/messaging/update-channel.mdx similarity index 100% rename from api-reference/messaging/update-channel.mdx rename to rest-reference/messaging/update-channel.mdx diff --git a/api-reference/messaging/update-session-timeout.mdx b/rest-reference/messaging/update-session-timeout.mdx similarity index 100% rename from api-reference/messaging/update-session-timeout.mdx rename to rest-reference/messaging/update-session-timeout.mdx diff --git a/api-reference/openapi.yaml b/rest-reference/openapi.yaml similarity index 100% rename from api-reference/openapi.yaml rename to rest-reference/openapi.yaml diff --git a/api-reference/rooms/create-a-room.mdx b/rest-reference/rooms/create-a-room.mdx similarity index 100% rename from api-reference/rooms/create-a-room.mdx rename to rest-reference/rooms/create-a-room.mdx diff --git a/api-reference/rooms/delete-a-room.mdx b/rest-reference/rooms/delete-a-room.mdx similarity index 100% rename from api-reference/rooms/delete-a-room.mdx rename to rest-reference/rooms/delete-a-room.mdx diff --git a/api-reference/rooms/get-agent-rooms.mdx b/rest-reference/rooms/get-agent-rooms.mdx similarity index 100% rename from api-reference/rooms/get-agent-rooms.mdx rename to rest-reference/rooms/get-agent-rooms.mdx diff --git a/api-reference/rooms/get-room-details.mdx b/rest-reference/rooms/get-room-details.mdx similarity index 100% rename from api-reference/rooms/get-room-details.mdx rename to rest-reference/rooms/get-room-details.mdx diff --git a/api-reference/rooms/update-a-room.mdx b/rest-reference/rooms/update-a-room.mdx similarity index 100% rename from api-reference/rooms/update-a-room.mdx rename to rest-reference/rooms/update-a-room.mdx diff --git a/api-reference/system/basic-health-check.mdx b/rest-reference/system/basic-health-check.mdx similarity index 100% rename from api-reference/system/basic-health-check.mdx rename to rest-reference/system/basic-health-check.mdx diff --git a/api-reference/system/get-local-environment-variables.mdx b/rest-reference/system/get-local-environment-variables.mdx similarity index 100% rename from api-reference/system/get-local-environment-variables.mdx rename to rest-reference/system/get-local-environment-variables.mdx diff --git a/api-reference/system/get-server-debug-info-1.mdx b/rest-reference/system/get-server-debug-info-1.mdx similarity index 100% rename from api-reference/system/get-server-debug-info-1.mdx rename to rest-reference/system/get-server-debug-info-1.mdx diff --git a/api-reference/system/get-server-debug-info.mdx b/rest-reference/system/get-server-debug-info.mdx similarity index 100% rename from api-reference/system/get-server-debug-info.mdx rename to rest-reference/system/get-server-debug-info.mdx diff --git a/api-reference/system/get-system-status.mdx b/rest-reference/system/get-system-status.mdx similarity index 100% rename from api-reference/system/get-system-status.mdx rename to rest-reference/system/get-system-status.mdx diff --git a/api-reference/system/health-check-endpoint.mdx b/rest-reference/system/health-check-endpoint.mdx similarity index 100% rename from api-reference/system/health-check-endpoint.mdx rename to rest-reference/system/health-check-endpoint.mdx diff --git a/api-reference/system/ping-health-check.mdx b/rest-reference/system/ping-health-check.mdx similarity index 100% rename from api-reference/system/ping-health-check.mdx rename to rest-reference/system/ping-health-check.mdx diff --git a/api-reference/system/stop-the-server.mdx b/rest-reference/system/stop-the-server.mdx similarity index 100% rename from api-reference/system/stop-the-server.mdx rename to rest-reference/system/stop-the-server.mdx diff --git a/api-reference/system/update-local-environment-variables.mdx b/rest-reference/system/update-local-environment-variables.mdx similarity index 100% rename from api-reference/system/update-local-environment-variables.mdx rename to rest-reference/system/update-local-environment-variables.mdx diff --git a/api-reference/websocket/socketio-real-time-connection.mdx b/rest-reference/websocket/socketio-real-time-connection.mdx similarity index 100% rename from api-reference/websocket/socketio-real-time-connection.mdx rename to rest-reference/websocket/socketio-real-time-connection.mdx diff --git a/runtime/sessions-api.mdx b/runtime/sessions-api.mdx index 6a6a021..bc87de8 100644 --- a/runtime/sessions-api.mdx +++ b/runtime/sessions-api.mdx @@ -1953,7 +1953,7 @@ class SessionsAPIClient: ## See Also - + Add real-time capabilities to your sessions From ee2d036c2a6f89f76297fd99337d164935a62d80 Mon Sep 17 00:00:00 2001 From: yung algorithm <113615973+yungalgo@users.noreply.github.com> Date: Wed, 22 Oct 2025 12:16:04 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 94e5ed1..29479ac 100644 --- a/README.md +++ b/README.md @@ -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