API/Create Note Style

Note Styles

Create Note Style

Creates a note style

POSThttps://api.sully.aihttps://api-testing.sully.ai/v1/note-stylesTry itcURLPythonJavaScriptPHPGoJavaCopy

curl --request POST \
  --url https://api.sully.ai/v1/note-styles \
  --header 'Content-Type: application/json' \
  --header 'X-ACCOUNT-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "sampleNote": "<string>",
  "instructions": []
}'

200400Copy

{
  "status": "ok",
  "data": {
    "template": "[POPULATE THIS TEMPLATE WITH THE INFORMATION FROM THE ENCOUNTER ONLY. DO NOT MAKE ANY ASSUMPTIONS. WRITE THE NOTE FROM THE PHYSICIAN'S PERSPECTIVE. DO NOT MISS ANY DETAIL IN EACH SECTION. MAKE SURE EVERY RELEVANT SENTENCE IN THE TRANSCRIPT IS ACCOUNTED FOR IN THE NOTE PRODUCED.]\n\n[INCLUDE DATE OF ENCOUNTER]\n\nCC: [INSERT CHIEF COMPLAINT]\n\nHPI:\n[SUMMARIZE THE HISTORY OF PRESENT ILLNESS IN PARAGRAPH FORM, FOLLOWING THESE GUIDELINES:]\n•..."
  },
  "date": "2023-11-07T05:31:56Z"
}

Authorizations

arrow-up-rightX-API-KEYstringheaderrequiredarrow-up-rightX-ACCOUNT-IDstringheaderrequired

Body

application/json

Note style to add

arrow-up-rightsampleNotestringrequired

Sample note text to base the style on

arrow-up-rightinstructionsstring[]

Optional instructions for note generation

Response

200200400application/json

Note style response

arrow-up-rightstatusstring

Status of the response

Example:

"ok"

arrow-up-rightdata object

chevron-rightShow child attributeshashtag

arrow-up-rightdatestring

Timestamp of the response

arrow-up-right

Last updated