API 文档

合同智能平台开放 API v1 接口文档

Base URLhttps://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-LimitX-RateLimit-Remaining

5. 文件上传接口使用 multipart/form-data 格式,最大文件大小 50MB

系统

GET/health健康检查公开

文档解析

POST/parse解析文件parse
GET/parse/supported-types获取支持的文件类型parse

文档比对

POST/compare文本比对compare
POST/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服务器内部错误稍后重试,如持续出现请联系支持

如有问题或建议,请在平台内提交反馈