Skip to content

Create a consultation session ​

POST/session-records/sessions

Request URL ​

text
POST https://open-api.habitaxx.com/v1/ms-ai-fast/session-records/sessions

Request headers ​

http
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

Request body ​

json
{
  "module_type": 1,
  "pet_profile_id": 44,
  "content": "My cat vomited three times today and seems less active.",
  "lang": "en-US",
  "trace_id": "consult-20260914-0001"
}

Request fields ​

FieldTypeRequiredDescription
module_typeintegerYesAlways 1 for Smart Consultation.
pet_profile_idintegerYesPositive numeric pet-profile ID.
contentstringYesInitial complaint or first user message; must not be empty.
langstringNoSession language; defaults to zh-CN.
trace_idstringNoClient trace identifier, maximum 100 characters.

Response example ​

json
{
  "code": 200,
  "message": "success",
  "data": {
    "session_id": "doc_1234567890abcdef",
    "medical_record_id": 10001,
    "medical_record": {
      "id": 10001,
      "pet_profile_id": 44,
      "module_type": 1,
      "status": 1,
      "lang": "en-US",
      "created_at": "2026-09-14T10:00:00"
    },
    "initial_message": {
      "id": 1,
      "role": "user",
      "content": "My cat vomited three times today and seems less active.",
      "content_type": 1,
      "created_at": "2026-09-14T10:00:00"
    }
  }
}

Response fields ​

FieldTypeDescription
session_idstringSession ID for all later consultation requests.
medical_record_idinteger/nullRelated AI record ID.
medical_recordobjectThe AI record created for this session. The current service returns this object on successful creation.
medical_record.idintegerAI record ID; identical to medical_record_id.
medical_record.created_atstringRecord creation time (ISO 8601, UTC+8).
medical_record.pet_profile_idintegerAssociated pet-profile ID.
medical_record.module_typeintegerModule: 1 Smart Consultation, 5 Pet Image Recognition.
medical_record.statusintegerBusiness status (measured: 1 right after session creation, 2 once the report is done); use report_status to decide whether the report is complete.
medical_record.langstringSession language (e.g. en-US).
initial_messageobject/nullSaved first message; it is not a request field.
initial_message.idintegerFirst-message auto-increment ID.
initial_message.created_atstringMessage creation time (ISO 8601, UTC+8).
initial_message.rolestringSpeaker role: always "user".
initial_message.contentstringOriginal value sent in the request body's content.
initial_message.content_typeintegerMessage type: 1 text, 2 image, 3 JSON. Always 1 here.

Common errors ​

HTTP / codemessageTrigger
400缺少主诉content was not sent for module_type=1.
400缺少宠物档案IDpet_profile_id was not sent.
400语言尚未启用: <lang>lang is not enabled in this environment; call GET /locales first.
最近更新

Qijie Open Platform · API Documentation