API 文档
合同智能平台开放 API v1 接口文档
Base URL
https://xsure.xtek.ai/open-api/v1鉴权方式
所有 API 请求需要在 HTTP Header 中携带 API Key 进行鉴权:
Authorization: Bearer YOUR_API_KEY在 开放 API 管理页面 创建 API Key。 每个 Key 可以设置不同的权限和速率限制。
通用说明
1. 所有请求和响应均使用 JSON 格式,Content-Type 为 application/json(文件上传接口除外)
2. 成功响应包含 "success": true 和 "data" 字段
3. 错误响应包含 "success": false 和 "error" 字段
4. 速率限制信息通过响应头返回:X-RateLimit-Limit、X-RateLimit-Remaining
5. 文件上传接口使用 multipart/form-data 格式,最大文件大小 50MB
系统
GET
/health健康检查公开文档解析
POST
/parse解析文件parseGET
/parse/supported-types获取支持的文件类型parse文档比对
POST
/compare文本比对comparePOST
/compare/files文件比对compare风险审核
POST
/audit合同风险审核audit关键信息提取
POST
/extract提取合同关键信息extract综合处理
POST
/compare-and-audit比对 + 审核一体化compare + audit错误码说明
| HTTP 状态码 | 说明 | 处理建议 |
|---|---|---|
| 200 | 请求成功 | 正常处理响应数据 |
| 400 | 请求参数错误 | 检查请求参数是否完整、格式是否正确 |
| 401 | 未授权 | 检查 API Key 是否正确、是否已过期 |
| 403 | 权限不足 | 检查 API Key 是否具有该接口的调用权限 |
| 429 | 请求频率超限 | 降低请求频率,参考响应头中的限制信息 |
| 500 | 服务器内部错误 | 稍后重试,如持续出现请联系支持 |
如有问题或建议,请在平台内提交反馈
