packages/examples/rest-api/express/README.md
A simple REST API server for chatting with an elizaOS agent using Express.js.
No API keys or external services required! Uses:
plugin-localdb for local JSON-based storageplugin-eliza-classic for pattern-matching responses (no LLM needed)# Install dependencies
bun install
# Start the server
bun run start
The server will start at http://localhost:3000
Returns information about the agent.
curl http://localhost:3000/
Health check endpoint.
curl http://localhost:3000/health
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"
}
Set the PORT environment variable to change the default port:
PORT=8080 bun run start