Skip to main content
PATCH
/
api
/
v1
/
user
/
preferences
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>'
{
  "preference": {
    "personalization_preference": {
      "section_format": [
        {
          "loinc": "10164-2",
          "style": "NARRATIVE"
        }
      ],
      "verbosity": "CONCISE"
    }
  }
}
Use this endpoint to update and save a user’s preferences. These settings are saved at the user level, not per , and will be applied to all of the user’s future interactions. For details, see Personalization. Section format preferences use codes to identify note sections.
This is a PATCH request, you only need to send the fields you want to change.
For the best results, we recommend that you call this endpoint before the main interaction begins (for example, before audio streaming starts or before you call the /end endpoint).This ensures the user’s preferences are applied before content is generated. However, you can call this endpoint at any time to update the settings.

​
Code examples

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())

Headers

​
sdp_suki_token
string
required

sdp_suki_token

​
sdp_provider_id
string

Unique identifier for the provider. Optional for standard partners. Required for Single Auth Token authentication, where multiple providers share the same partner_token.

Example:

"provider-123"

Body

application/json

The request body must be a JSON object containing a preference object.

User preference settings for personalization

​
personalization_preference
object

Optional - Settings for content generation customization

Response

Success Response

Response body for the /user/preferences endpoint

​
preference
object

Updated user preference settings

Last modified on June 12, 2026