开放 API 文档
企业合同智能审查 Agent 全部 API 端点的详细文档,参考 Swagger / Postman 风格编排。
API 基础地址
http://localhost:3000认证方式
当前为本地演示,无需认证。生产环境建议通过 API Key 或 Bearer Token 鉴权。
POST
/api/review合同审查
上传单个合同文件(PDF / Word / 文本),系统自动解析文档、识别合同类型,调用 AI 在数秒内完成风险条款识别并返回审查结果,包括风险评分、风险数量及修改建议。
请求参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
file | File (FormData) | 是 | 合同文件,支持 .pdf、.docx、.txt 格式,单文件不超过 10MB。 |
响应字段
| 字段 | 类型 | 描述 |
|---|---|---|
reviewId | string | 审查记录唯一 ID,用于后续查询与报告导出。 |
contract_type | string | AI 识别的合同类型,如「采购合同」。 |
contract_title | string | AI 提取的合同标题。 |
risk_score | number | 整体风险评分(0-100),越高风险越大。 |
risk_count | number | 识别出的风险条款总数。 |
high_risk_count | number | 高风险条款数量。 |
summary | string | AI 生成的审查摘要。 |
mock | boolean | 是否为演示模式(未配置 Claude API 时为 true)。 |
cURL 命令
curl -X POST http://localhost:3000/api/review请求示例
curl -X POST http://localhost:3000/api/review \
-F "file=@采购合同.pdf"响应示例
{
"reviewId": "a1b2c3d4-5678-90ef-...",
"contract_type": "采购合同",
"contract_title": "XX公司办公用品采购合同",
"risk_score": 72,
"risk_count": 8,
"high_risk_count": 3,
"summary": "该合同在付款条款、违约责任等方面存在较高风险,建议修改后签署。",
"mock": false
}