Once you have requested and received your upgraded Access Token here a conversation can be started with the Smart Symptom Checker.

📘
The upgraded JWT token is obtained after logging in, getting the terms and coditions and accepting them.

Start a conversation

To start a new conversation, either a request should be made to the initial endpoint, providing a number of mandatory key/value pairs in the body.

Body

Request body schema: application/json

Key	Type	Description
`gender`	`string`	Gender of the person symptom check is for. Must be either "male" or "female"
`age`	`integer`	Age of the person symptom check is for. Must be in a numeric integer format, e.g. 26
`initial_query`	`string`	Symptom(s) being experienced. Multiple symptoms can be separated using "and", e.g. "shaking and coughing"

Key

Type

Description

gender

string

Gender of the person symptom check is for. Must be either "male" or "female"

age

integer

Age of the person symptom check is for. Must be in a numeric integer format, e.g. 26

initial_query

string

Symptom(s) being experienced.

Multiple symptoms can be separated using "and", e.g. "shaking and coughing"

Example request:

curl -X POST https://portal.your.md/api/v1/chat \
     -H "Authorization: eyJraWQiOi10Y2RmY2Q0OS1kM2QyJFRlZGMtYThlZi02MDY5ZjRmZWYwNmMiLCJhbFhiOiJSUzI1NiJ9.eyJzdWIiOiJ5bWRNb3JzZV9pcGp6ZlRtMmwwRlhvd01zaXBIaWlObGZmZVlLb1ZPeWZmcmhyYmJpcGlzN2pXSlkiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImRldmljZV9pZCI6InBhcnRuZXJfcmFtcF83NDdlNWE0OTlkNTYzNjI0ZGFjMjBmYTQ4NGU1ZjQwMzczYmNiODg5YmI2NzIzYzRmNTExMjgyOTY0NmFlZWI2IiwiaXNzIjoieW1kLWludGVybmFsLXNlcnZpY2UtcHJvZCIsImp0aSI6ImZiMmNjZjJiLTNlZDYtNGRkMi04NWY4LWM1NThiODUxN2U3ZCIsImlhdCI6MTY0Nzg2MjAxOSwiZXhwIjoxNjQ3ODYzODE5fQ.rLQknhj00FvBI6fAKOcutyE3kpcO9PSJI60-PGynuU-rpAGVFXGl3oJQjlmEiJdj6cm3_bGqJbZUFXiJ56eDUwJ13coLTcQwoBPwAf2tActpJnjRMJivCB_b_sialoYRH0OZkiOysmEV01L4aHq8R535UpVlY4U-wxhhD7JYhLpo-e9BRbl2EgQhuFXLzl3s4ZPCSH7yMLn5KqfJIgcCoqL2f6nduZbFVXeKCmMjh5F2hs6QdKZPbBBVZBG9an6ACncvnwgqvUC00CmzEh76znjI8Xxeq1wSmwNYpBXQS3mPjUCpJAXIk5kjCSucu0BHngHYYBU3tL4Ifcs-vhgLqQ" \
     -H "x-api-key: GrNh3vPVdckgA9mCHxdmaSM2ucaywMZ9HbRJ1qTa"\
     -H "Content-Type: application/json" -d '
        {
          "gender": "male",
          "age": 26,
          "initial_symptom": "shaking and coughing",
    		}      
		}'

Depending on the initial symptom(s) provided during the initiation, the API will immediately start an Assessment Flow, or provide information to the user.