Skip to main content

The SAI Flow

Customize SAI for your business​

Pro subscribers can:

  • Set preferred language for their LLM
  • Define a custom name for their AI to replace "SAI"
  • Set custom system-level instructions
  • Set product upselling instructions

Define Products that SAI can upsell​

Our server expects custom upsell offerings to be structured as follows:

[{
  id: string
  name: string
  longDescription: string
  imageUrl: string
  productUrl: string | null
  shortDescription?: string
  keywords?: string[]
  biomarkers?: string[]
}, ...]
  • The imageUrl is used to display the product in chat by SAI.
  • productUrl is provided so the user can link to the product directly from the chat.
  • longDescription and keywords are used by SAI to understand when the provided product is relevant to the conversation.
  • biomarkers are only relevant for biomarker-testing products.

Example:

[{
    "id": "siphox_easydraw_core",
    "name": "Core Health Program",
    "longDescription": "Get a complete overview of your body's health, detect hidden risks, and stay on top of your metabolic, cardiovascular, and hormonal wellness.",
    "imageUrl": "cdn.sanity.io/images/q2ivj963/production/94bcf48332cae7b9bd35fa900bfd5b169ce744ab-1200x1074.jpg",
    "productUrl": "siphoxhealth.com/pricing/easydraw-core-program",
    "biomarkers": [
      "HDL Cholesterol",
      "LDL Cholesterol",
      "Triglycerides",
      "Thyroid Stimulating Hormone (TSH)",
      ...
    ]
  },
  {
    "id": "easydraw_heart_metabolic",
    "name": "Heart & Metabolic Program",
    "longDescription": "Take at-home blood biomarker tests focusing on cardiovascular & metabolic health, assessing key areas like cholesterol and inflammation at your selected testing frequency. These tests cover crucial biomarkers, providing personalized insights to help manage and reduce disease risks.",
    "imageUrl": "cdn.sanity.io/images/q2ivj963/production/a0205f9d012f87a3c833684362cf09bbe6e679ef-1200x1074.jpg",
    "productUrl": "siphoxhealth.com/pricing/easydraw-heart-and-metabolic-program",
    "biomarkers": [
      "HDL Cholesterol",
      "LDL Cholesterol",
      "Triglycerides",
      ...
    ]
  }, ...
]

Create a user​

If a user doesn't already exist in SiPhox, you'll need to create a user profile for them so that you can provide user context for SAI conversations.

Add Data For User​

This provides SAI with important context that increases the aptitude and precision of the recommendations SAI is able to provide for the end-user. Data you can add to a user profile includes:

  • Blood biomarker json data
  • Third-party blood test report files (pdf, jpg, png), option to run this async
  • questionnaire data

Poll for Async File Upload Status​

If a file is uploaded for a user with the async flag turned on (recommended), you can poll for the status of the upload using this endpoint.

Manage Chats​

Send SAI message and receive response​

Update conversation metadata with Notes or Tags​

List conversations, optionally filtering by date, length, or user​

Delete a conversation​