POST
/
v1
/
notes
Create a new clinical note
curl --request POST \
  --url https://api.sully.ai/v1/notes \
  --header 'Content-Type: application/json' \
  --header 'X-ACCOUNT-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "transcript": "Hey, how'\''s it going? Good good yeah, so what'\''s going on? Yeah, hi I'\''m Edward yeah hi hi Edward. How'\''s it going? Yeah, good good. So I'\''ve been having a couple of issues like my back pain and knee pain.",
  "date": "<string>",
  "language": "en",
  "noteType": {
    "description": "<string>",
    "type": "note_style",
    "template": "write a standard clinical SOAP note with the following sections: - **Subjective**: Contains detailed HPI. - **Objective**: Contains PE and ROS. - **Assessment**: Contains differential diagnoses with corresponding plans. - **Patient Instructions**: Contains a list of instructions for the patient.",
    "includeJson": true
  },
  "patientInfo": {
    "name": "<string>",
    "dateOfBirth": "2023-12-25",
    "gender": "male"
  },
  "previousNote": "<string>",
  "context": "<string>",
  "instructions": [
    "Use a professional and concise tone.",
    "Include key details without unnecessary elaboration.",
    "Ensure clarity for a general audience."
  ],
  "medicationList": "<string>"
}'
{
  "status": "ok",
  "data": {
    "noteId": "note_EXAMPLE123456789"
  },
  "date": "2024-11-07T21:24:51.000Z"
}

Authorizations

​
X-API-KEY
string
header
required
​
X-ACCOUNT-ID
string
header
required

Body

application/json

Note to add

​
transcript
string
required

The raw medical transcript text to be processed into a clinical note

Example:

"Hey, how's it going? Good good yeah, so what's going on? Yeah, hi I'm Edward yeah hi hi Edward. How's it going? Yeah, good good. So I've been having a couple of issues like my back pain and knee pain."

​
date
string

Date of the patient encounter in ISO format (YYYY-MM-DD) or ISO datetime format (YYYY-MM-DDTHH:mm:ssZ)

​
language
enum<string>
default:en

Language code for the transcript content. While multiple languages are supported, English ('en') is recommended for optimal output quality and accuracy.

Available options:
en,
es,
fr,
de,
it,
pt,
ru,
zh
Example:

"en"

​
noteType
object

Configuration object specifying the style and format of the generated note

​
patientInfo
object

Optional patient information

​
previousNote
string

Reference to a previous note if this is a follow-up. This field is optional.

​
context
string | null

Additional context for note generation. This field is optional.

​
instructions
string[] | null

Special instructions for note generation. This field is optional.

Example:
[
  "Use a professional and concise tone.",
  "Include key details without unnecessary elaboration.",
  "Ensure clarity for a general audience."
]
​
medicationList
string

List of up to 50 medications (comma separated) to use as reference for fixing spelling errors. This field is optional.

Response

Note response

​
status
string

Status of the response

Example:

"ok"

​
data
object
​
date
string<date-time>

Timestamp of the response

Example:

"2024-11-07T21:24:51.000Z"