Skip to content

API Reference

🚧 This page is a work in progress. English documentation is being translated.

YuanBot provides RESTful API and WebSocket endpoints.

Base URL: http://localhost:8000

Endpoints Overview

CategoryPrefixDescription
Auth/api/authLogin, logout, token refresh
Chat/api/chatSend message & get AI reply
Persona/api/personaPersona management
Providers/api/providersAI provider management
Memory/api/memoryMemory queries
TTS/api/ttsText-to-speech
Health/healthzLiveness probe

For detailed API documentation, please refer to the Chinese documentation.


English translation coming soon. 🌸

Made with 🌸 by Grabrun