跳转到主要内容
StartOCR

api

API 参考

使用 API Key 提交 OCR、查询任务、导出结果并管理 Webhooks。

使用 StartOCR HTTP API 从你的应用提交图片与 PDF。

OpenAPI 文档：/api/openapi.json

认证

在 设置 → API Keys 创建密钥（需先登录）。可选权限：

权限访问范围
submitPOST /api/ocr（默认包含）
readGET /api/tasks、GET /api/tasks/:id、导出
exportDELETE /api/tasks/:id
Authorization: Bearer YOUR_API_KEY

提交任务

POST https://startocr.com/api/ocr
Content-Type: application/json

默认引擎为 paddle-ai-studio。成功返回 taskId。

查询 / 列表 / 删除

  • GET /api/tasks/{taskId}（需 read）
  • GET /api/tasks?page=1&pageSize=20
  • DELETE /api/tasks/{taskId}（需 export）

导出

GET https://startocr.com/api/export/{taskId}/docx

格式：docx、xlsx、pdf。

Webhooks

在 设置 → Webhooks 配置 HTTPS 端点，接收 ocr.done / ocr.failed。使用端点签名密钥校验 X-Webhook-Signature。

计费

按文档页数预扣页数。Team 计划成员共享所有者余额。创建失败自动退还。