Skip to content

宠物档案 ​

宠物档案用于维护最终用户的宠物基础信息。它是宠物 AI 的支撑资源:智能问诊和图片识别都需要一个 pet_profile_id 才能开始会话。

调用前准备 ​

  • 通过身份认证换取 ACCESS_TOKEN,业务请求使用 Authorization: Bearer <ACCESS_TOKEN>。
  • 网关基础 URL:https://open-api.habitaxx.com/v1/ms-ai-fast
  • 先调用查询宠物档案列表或创建宠物档案拿到档案的 id,它就是后续接口要用的 pet_profile_id。

接口一览 ​

接口方法用途
/pet-profilesPOST创建宠物档案,name 必填。
/pet-profilesGET按 page + limit 分页查询当前用户的宠物档案。
/pet-profiles/{pet_profile_id}GET查询档案详情,并返回按 record_type 分组的扩展记录。
/pet-profiles/{pet_profile_id}PATCH部分更新档案字段。
/pet-profiles/{pet_profile_id}DELETE逻辑删除档案。

完整字段、校验规则和错误处理见接口总览。

典型调用链 ​

text
①(需要标准品种时)GET /pets/pet-info        ← 先取 breed_code
        ↓  items[].breed_code
② POST /pet-profiles(新增档案)或 GET /pet-profiles(查询列表)
        ↓  取得 id
③ GET /pet-profiles/{pet_profile_id}(校验数据是否正确)
        ↓  pet_profile_id
④ POST /session-records/sessions(创建问诊会话)

breed_code 不是自由文本:只有品种库查询返回的编码才能写入档案。没有标准品种(例如异宠)时只填 pet_variety 文本即可。

关键约定 ​

  • ID 是数字:pet_profile_id 是数值,例如 44。它同时用于宠物档案、智能问诊和图片识别接口。
  • 体重是字符串:weight 形如 "10.10kg",带单位,不是 JSON number。
  • 分页参数是 page + limit:limit 默认 10,最大 200。
  • 删除是逻辑删除:删除后该档案及其扩展记录对当前用户不可再读,但历史问诊会话和报告仍可按会话 ID 查询。
  • locale 只影响展示:它决定 breed_display_name 用哪种语言返回,不会写入档案,也不会翻译用户填写的文本。详见语言与 locale。
最近更新

栖界开放平台 · API Documentation