API 和 Webhook

通过 REST API 可进行发票、收据及其他商业文档的上传和读取。帐户、文件夹、标签和连接的管理仍在应用中进行。

密钥

在设置 → 开发者中创建。密钥只会在创建时显示一次——之后不再显示，因为只会保存其哈希值。丢失的密钥无法恢复，需要重新创建并删除旧密钥。最多可以拥有五个密钥，每个密钥的有效期可选最长为两年。

每当新密钥创建时，帐户所有者将收到电子邮件通知，过期前两周也会收到相应通知。请参见电子邮件通知。

密钥在请求头中通过X-API-Key发送。

操作	描述
`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 实际功能相符。

默认情况下，上传的文档在发送前会进行检查：文档会在应用中等待确认，然后 webhook 才会发送。若您正在构建无人值守的集成，可以在设置 → 发送前检查中取消 API 通道，或关闭检查。

对于 AI 代理，MCP 服务器位于 /api/mcp，使用相同的密钥。它可以读取和查找文档，但无法上传；上传将返回一个完成的命令，由代理自行执行。

不必查询状态，而是等结果准备好后接收通知。地址在设置 → 开发者中为整个帐户设置，或在单个上传中通过参数 targetWebhookUrl 设置。设置中的按钮将发送测试消息。

将发送 JSON 格式的 POST 消息：文档标识符、文件名、格式及在目标格式下的结果。当文档通过检查或重新处理时，第二次将带有修正标志 (IsCorrection) 发送 webhook。

消息不进行签名。通过在地址中添加您的私密令牌来验证发送者。私有网络的地址将被拒绝。

如果 webhook 在所有尝试后均未送达，约四个半小时后将发送电子邮件。在一次故障中只发送一次，后续的失败将记录在活动中。如果 webhook 地址被他人更改，您也会收到电子邮件通知。

失败的交付将以逐渐增加的延迟进行重试，最多进行 11 次尝试，约四个半小时内完成。每次尝试都会记录在活动中，包括您的响应；在文档列表中，将显示交付结果的图标。

API 没有自身每分钟调用次数的上限；上传受到积分、文件大小（根据套餐）和每个文档最多 20 页的限制。拒绝访问时将返回带有原因的 400 错误代码。MCP 服务器的请求限制为每秒 10 次。