企业 API

Bearer token API，用于自动化供应商、合同和归档 PDF 检查。MVP 仅公开接口契约，生产销售等待审批。

认证

Authorization: Bearer API_KEY

接口


POST /api/v1/checks
GET /api/v1/checks/{request_id}
GET /api/v1/checks/{request_id}/report
404 not_found
422 validation_error

POST /api/v1/checks

提交一个 PDF 检查任务

错误

400 invalid_file: 文件不是可读取的 PDF，或当前无法访问该文件。
401 unauthorized: API key 缺失、无效或已被撤销。
413 file_too_large: 上传文件超过当前大小限制。
422 validation_error: 请求参数无效，或 file 与 file_url 同时缺失/同时提供。
429 rate_limited: 请求频率超过当前套餐允许限制。
500 engine_error: 检查引擎无法完成本次请求。

GET /api/v1/checks/{request_id}

获取任务状态和摘要

错误

401 unauthorized: API key 缺失、无效或已被撤销。
404 not_found: 资源不存在，或不属于当前账号。
422 validation_error: 请求参数无效，或 file 与 file_url 同时缺失/同时提供。
429 rate_limited: 请求频率超过当前套餐允许限制。
500 engine_error: 检查引擎无法完成本次请求。

GET /api/v1/checks/{request_id}/report

获取 JSON 报告或 PDF 报告链接

错误

401 unauthorized: API key 缺失、无效或已被撤销。
404 not_found: 资源不存在，或不属于当前账号。
422 validation_error: 请求参数无效，或 file 与 file_url 同时缺失/同时提供。
429 rate_limited: 请求频率超过当前套餐允许限制。
500 engine_error: 检查引擎无法完成本次请求。

GET /api/v1/usage

获取 API 配额和用量

错误

401 unauthorized: API key 缺失、无效或已被撤销。
404 not_found: 资源不存在，或不属于当前账号。
422 validation_error: 请求参数无效，或 file 与 file_url 同时缺失/同时提供。
429 rate_limited: 请求频率超过当前套餐允许限制。
500 engine_error: 检查引擎无法完成本次请求。

POST /api/v1/webhooks/test

测试企业 webhook

错误

401 unauthorized: API key 缺失、无效或已被撤销。
404 not_found: 资源不存在，或不属于当前账号。
422 validation_error: 请求参数无效，或 file 与 file_url 同时缺失/同时提供。
429 rate_limited: 请求频率超过当前套餐允许限制。
500 engine_error: 检查引擎无法完成本次请求。

提交示例

POST /api/v1/checks
checks=structure,pdfa,metadata
→ 202 {"request_id":"chk_...","status":"queued"}