Doc2X API 介绍与入口选择
先选对调用方式
| 目标 | 入口 | 鉴权与结果 |
|---|---|---|
| 在自己的程序中解析 PDF | PDF API | 开放平台 API Key;预上传→状态→导出→下载。 |
| 识别 JPG/PNG 文档图片 | 图片 API | 同步或异步二选一;保存 Markdown 和图片资源。 |
| 获取版面块、阅读顺序、坐标 | v3 JSON | PDF 解析显式选择 v3-2026;保存 data.result。 |
| 在支持 MCP 的 Agent 中使用上述 API | MCP | API Key 注入本地服务器;保存 uid 和本地输出路径。 |
| 用个人账户命令行解析、翻译、批处理 | CLI | CLI OAuth/桌面账户登录;不把 API Key 当登录 Token。 |
| 让 Agent 按 CLI 工作流操作 | CLI Skills | 单独安装技能与 CLI;仍需登录、额度和任务授权。 |
公开解析 API 的导出参数为 md/tex/docx。网页支持的 Excel、保版 Word、图片翻译或其他格式,不自动意味着存在相同公开 API。需要文档翻译可查看独立 CLI/网页教程;本节不虚构翻译 API endpoint。Zotero 客户端插件也不使用开放平台的 API 资源。
最小接入步骤
- 在开放平台登录,创建/管理 API Key,检查配额与账户限制。
- 先用一份有权处理的小型 PDF,按 PDF 完整示例提交。密钥放环境变量,示例占位符不能直接使用。
- 保存返回
uid,区分上传、解析、导出、下载阶段。只轮询 GET 状态,不反复 POST 新任务。 - 成功后下载正文与配套图片到本地,在目标编辑器核对内容;再决定是否扩大批量。
重要提醒
- API 结果与关联图片临时保留约24小时,尽快保存;单独保存 Markdown 不等于图片也已保存。
- 开放平台、CLI、网页的输入大小和格式条件分别确认。超额、并发或页数错误按实际服务响应处理,不假设每个账户有相同上限。
- 超时和断网不证明任务未创建;保留原 uid 后续查询,避免重复消耗。
- API Key、签名上传/下载 URL 不应公开分享。反馈问题提供脱敏任务/请求 ID、时间、错误码与当前阶段,不附原始私有文档或密钥。