韦尼克 Logo
韦尼克平台
AI Document Platform
⌘K
开发文档API 调试台AI接入助手

Docs Map

文档目录

产品介绍能力全景API 直连方案收费标准
首页API 直连方案

API 直连方案

提供智能合同 API 直连所需的接口文档。

上一页
能力全景
下一页
收费标准

接口文档

当前智能合同仅开放 1 个核心接口,即“合同生成”。

合同生成

  • 接口地址:POST https://saas.api.yoo-ai.com/contract/build
  • 接口能力:根据一句话或一段需求描述生成完整合同文档。
  • 返回内容:合同标题、分类、下载链接、预览图、预览地址和基础元信息。

请求头

参数名类型必填说明
Authorizationstring是Bearer {token}
Content-Typestring是固定为 application/json

请求体

参数名类型必填说明
textstring是合同需求描述,例如“生成一份租房合同”

请求示例

{
  "text": "生成一份租房合同"
}

响应字段

字段类型说明
codeint状态码
msgstring返回消息
dataobject合同结果对象
data.contract_idstring合同唯一标识
data.titlestring合同标题
data.categorystring合同分类
data.sub_classstring合同子分类
data.documentstring合同文档下载地址
data.imagearray合同分页预览图列表
data.pageint合同页数
data.file_sizenumber合同文件大小,单位通常为 KB
data.file_typestring合同文件类型,例如 docx
data.prototypestring合同封面图
data.tagsarray合同相关标签
data.tags_specialarray特殊标签列表
data.clause_listarray合同条款列表
data.title_matcharray标题匹配结果
data.introducestring合同内容摘要
data.preview_urlstring合同在线预览地址
request_idstring请求追踪 ID,便于排查问题

响应示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "contract_id": "387a82b057db2239459dfc8975e8ed31",
    "title": "房屋租赁合同样版",
    "category": "租赁合同",
    "sub_class": "租房合同",
    "document": "https://doc-01.yoojober.cn/generate/contract/2025-08/f3882ec1172d15891f40f949f109b33d.docx",
    "image": [
      "https://image.yoojober.com/contract_temp/2025-08/54526ada97db3680f9642d97d8aabe6b.png",
      "https://image.yoojober.com/contract_temp/2025-08/42a2d1ced4a7249666757c9109cde740.png"
    ],
    "page": 7,
    "file_size": 28.86,
    "file_type": "docx",
    "prototype": "https://image.yoojober.com/contract_temp/2025-08/ed4c7dac4f8c37d4560ca59ab4589709.png",
    "tags": [
      "租赁",
      "房屋",
      "标准",
      "合同",
      "租赁合同",
      "租房合同"
    ],
    "tags_special": [
      "租赁合同",
      "租房合同"
    ],
    "clause_list": [],
    "title_match": [],
    "introduce": "该合同用于房屋租赁场景,涵盖用途、租金、保证金、维修和违约责任等主要条款。",
    "preview_url": "https://contract.yoo-ai.com/contractdetails?id=387a82b057db2239459dfc8975e8ed31"
  },
  "request_id": "YOO-saas-api68945654b6970"
}