Skip to content

快速开始 ​

本页带你完成“已认证并成功创建一条智能问诊会话”的最小接入准备。创建会话只是完整问诊流程的起点;要得到问诊总结和报告,还需要继续执行关键词分析、追问、SSE 流消费和报告轮询。

BASE_URLhttps://open-api.habitaxx.com

1. 准备接入信息 ​

请从开放平台控制台获取以下信息:

名称示例占位值说明
API Keyqj_live_your_api_key通过 x-api-key 请求头传递
项目编号prj_your_project_no项目页面展示的公开编号
业务用户 IDyour_user_001由接入方定义,同一项目内应保持稳定
Runtime 宠物档案 ID44当前业务用户可用的数字宠物档案 ID;44 仅为示例,不能直接复制使用

先准备可用的宠物档案 ID

智能问诊和图片识别都需要数字 pet_profile_id。可以先调用宠物档案的新增档案或查询列表接口取得该 ID。

pet_profile_id 是数值(例如 44),不是字符串编码;它同时用于宠物档案、智能问诊和图片识别接口。

2. 获取 Access Token ​

POST/v1/auth/token
bash
curl --location 'https://open-api.habitaxx.com/v1/auth/token' \
  --header 'x-api-key: qj_live_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "project_no": "prj_your_project_no",
    "user_id": "your_user_001"
  }'

响应示例:

json
{
  "code": 200,
  "message": "success",
  "data": {
    "access_token": "eyJ...replace_with_access_token",
    "token_type": "Bearer",
    "expires_in": 86400
  }
}

将响应中的 access_token 保存为环境变量:

bash
export ACCESS_TOKEN='eyJ...replace_with_access_token'

3. 查询当前环境可用语言 ​

lang 不是任意可填写的语言代码。请先查询当前环境已启用的语言,再把返回值之一传入创建会话请求。

GET/v1/ms-ai-fast/locales
bash
curl --location 'https://open-api.habitaxx.com/v1/ms-ai-fast/locales' \
  --header "Authorization: Bearer ${ACCESS_TOKEN}"

响应中的 data 是可用语言列表。列表因环境配置而异;以下仅为结构示例:

json
{
  "code": 200,
  "message": "success",
  "data": ["zh-CN", "zh-Hant-HK", "en-US"]
}

本示例在下一步使用 en-US。如果它不在你的实际响应中,请替换为列表中的语言,例如 zh-CN 或 zh-Hant-HK。

4. 创建智能问诊会话 ​

POST/v1/ms-ai-fast/session-records/sessions
bash
curl --location 'https://open-api.habitaxx.com/v1/ms-ai-fast/session-records/sessions' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --data '{
    "module_type": 1,
    "pet_profile_id": 44,
    "content": "My cat has been vomiting since this morning.",
    "lang": "en-US"
  }'

响应中的 session_id 是后续问诊、保存消息和生成报告所需的会话 ID。请求中的 content 已被保存为 initial_message.content。请保存 session_id,不要把不同用户的 session_id 混用。

json
{
  "code": 200,
  "message": "success",
  "data": {
    "session_id": "doc_<SESSION_ID>",
    "medical_record_id": 10001,
    "medical_record": {},
    "initial_message": {
      "session_id": "doc_<SESSION_ID>",
      "role": "user",
      "content": "My cat has been vomiting since this morning.",
      "content_type": 1
    }
  }
}

创建会话不等于完成问诊

本请求只创建会话并保存首条主诉。接下来必须按完整流程调用 keywords、reason-info、analysis、related-question 等接口,并正确消费 SSE 的 done 事件,才能继续问诊和生成报告。

下一步 ​

最近更新

栖界开放平台 · API Documentation