API Documentation
The Umo Editor Server enhances the capabilities of Umo Editor Next through HTTP or WebSocket interfaces. In the development environment, after starting the project, you can access the Swagger documentation at http://127.0.0.1:1235/docs.
A brief description of the currently provided interfaces is as follows. For more detailed information, please refer to the interface documentation and code comments.
Check Service Status
GET /: Returns information about whether the service is running. If this route is inaccessible, it indicates that the service is not started or is experiencing issues.
API Documentation
GET /docs: API documentation for viewing and testing interfaces. This interface is not available in the production environment.
Collaborative Editing, Document Comments, etc.
GET /provider: WebSocket interface, which should be connected via the ws(s):// protocol. Most of the content of this interface is stored and transmitted in binary form. For its configuration and related instructions, please refer to the source code.
AI Service Provider Proxy
GET | POST /ai/{provider}/{endpoint}: Dynamically proxies GET and POST requests to different AI service providers (e.g., DeepSeek, OpenAI, Moonshot AI) based on theproviderandendpointparameters. This can be extended and modified as needed. The main purpose of this interface is to forward requests to the specified AI service provider and return the response. For specific implementation and usage, please refer to the code comments.
Document Export
POST /export/pdf: Export the document as a PDF.POST /export/image/:type: Export the document as an image, supportsjpeg,png,webpformats.