Server Actions API
欢迎来到 DeepTrans Studio Server Actions API 文档中心!本指南旨在帮助您快速上手,了解如何有效地使用本文档提供的交互功能来测试和理解 DeepTrans Studio Server Actions,并掌握 API 访问的关键要素。
重要提示:
- 本页内容:主要介绍 Server Actions 文档的交互方式、全局访问配置(如 Base URL、认证信息)以及文档贡献流程。
- API 端点详情:所有具体的 Server Actions(包括其参数、请求/响应结构、功能描述及示例)内容是根据我们的代码自动生成的,并包含了最新的功能注释。请务必查阅这些自动生成的页面以获取最准确和详细的端点信息。
API 端点
以下是 DeepTrans Studio 提供的所有 API 端点,按功能分类组织。所有 API 端点均基于 Next.js App Router 的 Route Handlers 实现。
认证与授权
用户认证、登录和授权相关的 API
GET/POST
/api/auth/[...nextauth]NextAuth 认证
NextAuth.js 提供的认证端点,支持多种认证方式
POST
/api/auth/email-login邮箱登录
使用邮箱和验证码登录
POST
/api/auth/send-code发送验证码
向指定邮箱发送登录验证码
GET
/api/auth/oauth/[provider]OAuth 登录
支持 GitHub、Google 等 OAuth 提供商登录
项目管理
项目、文档、分段等项目管理相关的 API
POST
/api/projects/[id]/init项目初始化
初始化项目,持久化解析产物。支持通过 action 参数执行 persist 操作
GET
/api/projects/[id]/init查询初始化状态
查询项目初始化过程中的状态,包括分段进度、术语提取进度、预览内容等
POST
/api/projects/[id]/parse文档解析
解析项目中的文档,提取文本内容(支持 DOCX、PDF 等格式)
POST
/api/projects/[id]/segment文档分段
将文档内容分段,支持预览模式和完整模式
GET
/api/projects/[id]/segment查询分段进度
查询文档分段的进度和结果
POST
/api/projects/[id]/terms术语提取
从文档中提取术语
POST
/api/projects/[id]/terms/apply应用术语
将术语应用到文档中
POST
/api/projects/[id]/terms/preview术语预览
预览术语应用效果
GET
/api/projects/[id]/doc获取项目文档
获取项目中的文档信息
批量操作
批量预翻译、批量质量保证等批量处理任务相关的 API
POST
/api/batch-pre-translate/start启动批量预翻译
启动批量预翻译任务
GET
/api/batch-pre-translate/progress查询批量预翻译进度
查询批量预翻译任务的进度
POST
/api/batch-pre-translate/persist持久化批量预翻译结果
将批量预翻译结果持久化到数据库
POST
/api/batch-quality-assure/start启动批量质量保证
启动批量质量保证任务
GET
/api/batch-quality-assure/progress查询批量质量保证进度
查询批量质量保证任务的进度
POST
/api/batch-quality-assure/persist持久化批量质量保证结果
将批量质量保证结果持久化到数据库
POST
/api/batch-quality-assure/cancel取消批量质量保证任务
取消正在进行的批量质量保证任务
词典
词典查询和管理相关的 API
GET
/api/dictionary/lookup词典查询
查询词典中的术语,支持公共、项目和私有词典的联合查询
记忆库
翻译记忆库导入、搜索和管理相关的 API
POST
/api/memories/import导入记忆库
导入翻译记忆库文件(支持 TMX、CSV 等格式)
POST
/api/memories/import-progress查询导入进度
查询记忆库导入任务的进度
POST
/api/memories/hybrid-search混合搜索
在记忆库中进行混合搜索(向量检索 + 关键词匹配)
GET
/api/memories/hybrid-search获取搜索统计
获取记忆库搜索的统计信息
文档处理
文档预览、导出等文档处理相关的 API
GET
/api/document/preview/[itemId]文档预览
预览文档项的内容
GET
/api/export/markdown导出 Markdown
将文档导出为 Markdown 格式
GET
/api/export/word导出 Word
将文档导出为 Word 格式
工作流
工作流执行相关的 API
POST
/api/items/[id]/workflow执行工作流
对指定的文档项执行工作流(预翻译、质量保证、后编辑等)
其他服务
文件上传、聊天、邮件等辅助服务相关的 API
POST
/api/upload-proxy文件上传代理
代理文件上传到对象存储(MinIO)
POST
/api/chat聊天
AI 聊天对话接口
GET
/api/explorer-tabs资源管理器标签
获取资源管理器的标签页信息
POST
/api/send-email发送邮件
发送邮件通知
API 访问配置
服务器地址 (Base URL)
Server Actions 请求的基础 URL 因您的 DeepTrans Studio 部署环境而异:
本地开发环境
http://localhost:3000生产环境
https://your-domain.com在进行 Server Actions 调用时,请务必确认您配置的 Base URL 是正确的。
认证信息 (Session Token)
DeepTrans Studio 使用 NextAuth 进行身份验证,Server Actions 会自动从会话中获取用户信息。
- 浏览器环境:Server Actions 会自动使用当前登录用户的会话信息,无需手动传递认证信息。
- 服务器端调用:如果您在服务器端调用 Server Actions,需要确保请求上下文中包含有效的用户会话。
- API 路由:对于需要通过 API 路由访问的功能,请使用 NextAuth 的 Session Token 进行认证。
重要安全提示:
- Session Token 是访问您应用数据的凭证,具有较高权限。请务必将其视为敏感信息并妥善保管,严禁在任何客户端(如浏览器、移动应用前端)代码中硬编码或直接暴露。
- 推荐将认证信息存储在安全的服务器端环境,并通过后端服务代理对 DeepTrans Studio Server Actions 的调用。
关于 Server Actions 以及本文档
文档的组成与来源
本指南页
提供如何使用 Server Actions 文档、进行交互测试以及 API 访问的通用配置信息。
Server Actions 端点详情页
侧边栏"API 端点"分组下的所有页面,均由我们的代码自动生成。这些页面包含了每个端点的详细描述、参数、请求/响应示例和最新的功能注解。