API 和 Webhook
通过 REST API 可以进行文档的上传和读取。帐户、文件夹、 标签和连接的管理仍在应用程序中进行。
密钥
在设置 → 开发者中创建。密钥只会在创建时显示一次 — 之后不会再显示，因为仅保存其哈希值。丢失的密钥无法恢复， 需要创建新的，并删除旧的。最多可以有五个密钥，每个密钥的有效期最长为两年。
密钥通过 X-API-Key 头部发送。
API 的功能
| 操作 | 描述 |
|---|---|
POST /api/upload | 上传文件及其选项：格式、方向、类型、货币、模式、文件夹、webhook |
POST /api/upload/url | 从公开地址上传相同文件；我们自己下载文件 |
GET /api/jobs | 列出文档，带过滤器和分页 |
GET /api/jobs/{id} | 状态、读取的数据、找到的内容和结果以目标格式返回 |
GET /api/jobs/{id}/original | 上传的文件 |
DELETE /api/jobs/{id} | 删除到回收站 |
Excel 和 PDF 的结果以 Base64 格式返回。若不需要结果，可以发送
includeResult=false，以节省服务器上的转换。
OpenAPI 格式的接口描述位于 /api/docs；链接在密钥的设置中。描述是从正在运行的代码生成的，因此与 API 的实际功能相符。
API 文档的检查
默认情况下，上传的文档在发送前会进行检查：文档在应用中等待确认，webhook 会在确认后发送。如果进行集成时没有人在屏幕前监控，可以在设置 → 发送前检查中取消 API 通道，或关闭检查。
MCP
对于 AI 代理，MCP 服务器位于 /api/mcp，使用相同的密钥。可以读取和搜索文档，但不能上传；上传将返回一个完成的命令，由代理自行执行。
Webhook
您可以让结果在完成时通过 webhook 发送，而无需查询状态。地址在设置 → 开发者中为整个帐户配置，或在单个上传中通过参数 targetWebhookUrl 设置。设置中的按钮可以发送测试消息。
消息将通过 POST 发送 JSON：文档的标识符、文件名、格式和以目标格式返回的结果。当文档通过检查或重新处理后，将第二次收到带有修正标记（IsCorrection）的 webhook。
消息不带签名。通过将您自己的秘密令牌放入地址来验证发送者。私有网络地址将被拒绝。
递送失败将以越来越长的间隔进行重试，总共尝试 11 次，持续大约四个半小时。每次尝试都会在活动日志中记录，并包含您一方的回应；在文档列表中会显示一个图标来显示递送结果。
限制
API 没有每分钟调用次数的上限；上传受信用额度、文件大小和每个文档最多二十页的限制。拒绝请求将以 400 错误返回，并附带说明原因的代码。MCP 服务器限制为每秒十个请求。