User Preferences

Update user personalization preferences for clinical note generation

PATCH /api/v1/user/preferences

cURL

cURL

curl --request PATCH \
  --url https://sdp.suki.ai/api/v1/user/preferences \
  --header 'Content-Type: application/json' \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>'

200

{
  "preference": {
    "personalization_preference": {
      "section_format": [
        {
          "loinc": "10164-2",
          "style": "NARRATIVE"
        }
      ],
      "verbosity": "CONCISE"
    }
  }
}

Use this endpoint to update and save a user’s personalization preferences. These settings are saved at the user level, not per session, and will be applied to all of the user’s future interactions. For details, see Personalization. Section format preferences use LOINC codes to identify note sections.

This is a PATCH request. Send only the fields you want to change. There is no partner-facing GET for preferences. Persist the values your UI shows, or call PATCH again when the clinician changes style.

Call this endpoint before ambient session starts. Preferences apply to future notes for that provider. Do not send verbosity or section_format in ambient session context. For settings UI, including what happens if style changes during a recording, refer to Note Personalization guide for recommendations.

Code examples

Python

import requests

url = "https://sdp.suki-stage.com/api/v1/user/preferences"
headers = {
    "sdp_suki_token": "<sdp_suki_token>",
    "sdp_provider_id": "<sdp_provider_id>",
    "Content-Type": "application/json"
}

payload = {
    "personalization_preference": {
        "verbosity": "CONCISE",  # Options: CONCISE, BALANCED, DETAILED
        "section_format": [
            {
                "loinc": "10164-2",
                "style": "NARRATIVE"  # Options: NARRATIVE, BULLETED
            }
        ]
    }
}

response = requests.patch(url, json=payload, headers=headers)

if response.status_code == 200:
    data = response.json()
    print("Preferences updated successfully")
    print(f"Updated preferences: {data}")
else:
    print(f"Failed to update preferences: {response.status_code}")
    print(response.json())

TypeScript

const response = await fetch('https://sdp.suki-stage.com/api/v1/user/preferences', {
  method: 'PATCH',
    headers: {
      'sdp_suki_token': '<sdp_suki_token>',
      'sdp_provider_id': '<sdp_provider_id>',
      'Content-Type': 'application/json'
    },
  body: JSON.stringify({
    personalization_preference: {
      verbosity: 'CONCISE', // Options: CONCISE, BALANCED, DETAILED
      section_format: [
        {
          loinc: '10164-2',
          style: 'NARRATIVE' // Options: NARRATIVE, BULLETED
        }
      ]
    }
  })
});

if (response.ok) {
  const data = await response.json();
  console.log('Preferences updated successfully');
  console.log('Updated preferences:', data);
} else {
  const error = await response.json();
  console.error(`Failed to update preferences: ${response.status}`, error);
}

Authorizations

sdp_suki_token · string · header · required

Suki access token (suki_token) from Login or Register. Expires after one hour.

Headers

sdp_provider_id · string

Optional for standard partners.

Required for:

• Bearer authentication. Use the same provider_id returned by the Login or Register API.
• Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Example:

"provider-123"

Body

application/json

Personalization settings to create or update for the authenticated user.

personalization_preference · object

Optional - Personalization settings such as note verbosity and section format.

Show child attributes

Response

200

application/json

Request succeeded.

Response body for the /user/preferences endpoint

preference · object

Updated user preference settings

Show child attributes