Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

elizaOS REST API - Elysia

A simple REST API server for chatting with an elizaOS agent using Elysia (Bun's fast web framework).

No API keys or external services required for local mode. Uses:

  • plugin-sql with PGLite by default for local storage
  • plugin-eliza-classic for pattern-matching responses (no LLM needed)

Quick Start

# From the monorepo root, install dependencies
cd /path/to/eliza
bun install

# Start the server
bun run examples/rest-api/elysia/server.ts

Note: This example must be run from the monorepo root to resolve workspace dependencies.

The server will start at http://localhost:3000

API Endpoints

GET /

Returns information about the agent.

curl http://localhost:3000/

GET /health

Health check endpoint.

curl http://localhost:3000/health

POST /chat

Send a message to the agent.

curl -X POST http://localhost:3000/chat \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello, how are you?"}'

Response:

{
  "response": "How do you do. Please state your problem.",
  "character": "Eliza",
  "userId": "generated-uuid"
}

Configuration

Set the PORT environment variable to change the default port:

PORT=8080 bun run start

Validate

bun run test
bun run typecheck

The test suite imports the Elysia app without binding port 3000 and verifies CORS plus request validation.

Why Elysia?

Elysia is a fast, type-safe web framework designed for Bun. It provides:

  • End-to-end type safety
  • Automatic request validation
  • High performance
  • Excellent developer experience