API 概览
Base URL
https://omnidoc.top/api/v1JSON 请求发送 Content-Type: application/json。API Key 可放在 X-API-Key 请求头，也可作为 Bearer 凭据发送。
| 服务 | 主要路径 | 说明 |
|---|---|---|
| 文件上传 | /upload/* | 上传并确认文档 |
| 文件库 | /storage/files/*、/documents/* | 列表、读取与下载 |
| 翻译 | /jobs/*、/artifacts/* | 创建任务、查询状态与结果 |
| 文档工具 | /document-operations/*、/file-tools/* | 转换、合并、拆分、压缩等 |
| 即时翻译 | /ai/* | 短文本与批量片段翻译 |
| 音视频 | /media-jobs/*、/media-voices/* | 任务和音色 |
| 术语表 | /glossaries/* | 术语与导入导出 |
| 用量与积分 | /usage/*、/billing/credits/* | 用量、余额与结算凭证 |
| 通知 | /sse/*、/webhooks/* | 实时进度与回调 |
可调用的服务与计费见服务与权限。
- 资源 ID 是不透明字符串。
- 创建类请求建议携带
Idempotency-Key，文档操作、音视频任务和音色创建必须携带。 - 列表接口的分页参数以各接口说明为准。
- 返回
429时按错误与重试处理。 - 下载的文件名仅供展示，保存到本地前请取 basename 并按本地文件系统限制处理。
请保存每次响应的 X-Request-Id。联系支持时提供该值、请求时间和接口路径，不要发送完整的 API Key 或文件内容。