API 概览

DocParse4AI API 基础路径为 /api/v1, 接口设计兼容常见文档解析 API(如 SoMark)。

Base URL

# 生产环境(推荐)
https://www.docparse4ai.com/api/v1

# 站点根地址
https://www.docparse4ai.com

认证方式

所有解析接口通过 api_key 表单字段认证,在控制台创建密钥后使用。

控制台接口使用 Authorization: Bearer <token> JWT 头。

接口列表

方法路径说明
POST/api/v1/parse/sync同步解析,立即返回结果
POST/api/v1/parse/async异步提交,返回 task_id
POST/api/v1/parse/async_check轮询异步任务状态
POST/api/v1/usage查询 API Key 用量
GET/health服务健康检查

通用响应格式

{
  "code": 0,           // 0=成功,非0=错误
  "message": "任务成功",
  "data": { ... }      // 业务数据,失败时可能为 null
}

详细文档