开发文档
接入总览
DocUnwrap 的三种接入方式 —— MCP(AI 客户端)、REST API(程序调用)、API Key(共同前置)。
DocUnwrap 的文档解析能力(PDF → Markdown/JSON,含扫描件 OCR)有三条接入路径,按你的 使用场景选:
| 路径 | 适合谁 | 形态 |
|---|---|---|
| MCP | 在 Claude / Cursor / VS Code / ZCode 等 AI 客户端里让 agent 直接解析文档 | 一个 URL 端点,4 个精选工具 |
| REST API | 自己写程序调用(脚本、后端、自动化) | POST /api/v1/parse + GET /api/v1/tasks/:id |
| API Key | 以上两者的共同前置 | docunwrap_live_… 密钥 |
一分钟选型
- 想「丢给 AI 一个 PDF 链接,它解析完直接用」→ MCP,配一次端点,后续零代码。
- 想集成进自己的服务/流水线 → REST API,异步提交 + 轮询。
- 两条路都要 → 同一把 key 通吃,计费与限额语义完全一致(按页计费、每 key 限流)。
无论走哪条路,第一步都是先创建一把 API Key。
计费口径(三条路径一致)
按实际解析页数计费,任务完成时扣减 credits,创建任务不预扣:
| 模型 | 单价(credits/页) |
|---|---|
基准(glm-ocr / paddleocr-vl) | 1 |
mineru4 | 2 |
teleocr | 3 |
model=auto 时按网关实际路由的模型计费。余额不足一页时提交会被拒(insufficient_credits)。