接口列表

Umo Editor Server 通过 http 或 websocket 接口的形式，增强 Umo Editor Next 的能力，在开发环境下，您可以启动项目后，通过 http://127.0.0.1:1235/openapi 访问 Open API 文档。

目前提供的接口简要说明如下，更详细的信息请查看接口文档和代码注释。

检查服务状态

• GET /：返回服务是否正在运行的信息，如果无法访问该路由，则代表服务可能未启动或服务异常。

Open API 接口文档

• GET /openapi：接口文档，用于查看和测试接口，该接口在生产环境下不可用。

文档导入导出

• POST /import/office：将 Office 等格式的文档转换为 Umo Editor 所支持的格式，支持的格式包括：doc, docx, xls, xlsx, ppt, pptx, odp, odt, ods, rtf, wps, et, dps 等，并可自行扩展。
• POST /import/anyweb：将任意网页内容导入 Umo Editor Next 中。
• POST /export/pdf：将文档导出为 PDF 格式。
• POST /export/image/:type：将文档导出为图片格式，支持 jpeg、png、webp 格式图片的导出。
• POST /export/thumbnail：导出文档缩略图（仅导出文档第一页内容）。

AI 服务代理

• POST /ai/suggestion：AI 智能建议接口，用于生成 Umo Editor Next 中的候选续写等智能建议。
• POST /ai/{provider}/chat/completions：根据 provider 将请求动态代理到不同的 AI 服务商（如 DeepSeek、OpenAI等）。可根据需要进行扩展和修改。该接口的主要作用是将请求转发到指定的 AI 服务商，并返回符合 Umo Editor Next 中 AI 消息的响应结果。具体实现和使用方式请参考代码注释。

文档协作、批注、历史记录等

• GET /collaboration：WebSocket 接口，应通过 ws(s):// 协议连接，该接口的大部分内容是以二进制的形式存储和传输。其配置和相关说明等见源代码。

AI SSE 示例

• POST /mock/sse/normal：SSE 示例接口，返回 text/event-stream，每条 SSE 的 data 字段为 JSON，便于前端按 default 协议解析。该接口为演示用途，便于联调前端 AG-UI 解析与渲染，不会调用上游模型。
• POST /mock/sse/agui：AG-UI SSE 示例接口，返回 text/event-stream，每条 SSE 的 data 字段为 AG-UI 事件 JSON。 该接口为演示用途，便于联调前端 AG-UI 解析与渲染，不会调用上游模型。

文档模板示例

• GET /template：模板列表，返回所有可用的模板信息。
• GET /template/:id：模板详情，返回指定 ID 的模板详情信息。
• POST /template：创建模板，根据请求体创建新的模板并返回模板详情信息。
• PUT /template/:id：更新模板，根据请求体更新指定 ID 的模板信息并返回更新后的模板详情信息。
• DELETE /template/:id：删除模板，根据指定 ID 删除模板并返回删除结果信息。

素材库示例

• GET /mock/file：文件列表，分页返回文件列表，支持 parentId/keyword/type/pageIndex/pageSize 参数。
• GET /mock/file/:id：文件详情，返回指定 ID 的文件详情信息。
• POST /mock/file/upload：文件上传
• POST /mock/file/folder：创建文件夹
• DELETE /mock/file/:id：删除指定文件

图标列表

• GET /icons：图标列表，返回所有可用的图标信息。

静态文件服务

返回 Umo Editor Next 的打包文件和 @umoteam/editor-external 等静态文件，例如：

• GET /static：返回 Umo Editor Next 的主 CSS 文件，可用于配置 Umo Editor Next 的 cdnUrl 配置项。
• GET /static/next/10.0.0/umo-editor-next.css：返回 Umo Editor Next 的样式文件，可用于配置 Umo Editor Next 的 export.styleURL 配置项。