Create Note

Creates a new note

POST /v1/notes

Create a new clinical note

cURL

curl --request POST \
  --url https://api.sully.ai/v1/notes \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Account-Id: <api-key>' \
  --data @- <<EOF
{
  "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.",
  "noteType": {
    "type": "note_style",
    "description": "<string>",
    "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
  },
  "date": "2026-09-07",
  "language": "en",
  "patientInfo": {
    "name": "<string>",
    "dateOfBirth": "<string>",
    "gender": "<string>"
  },
  "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>"
}
EOF

200

{
  "status": "ok",
  "data": {
    "noteId": "note_EXAMPLE123456789"
  },
  "date": "2024-11-07T21:24:51.000Z"
}

Authorizations

X-API-Key · string · header · required

Required together with the other Sully authentication header.

X-Account-Id · string · header · required

Required together with the other Sully authentication header.

Body

application/json

Note to add

transcript · string · required

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

Required string length: 1 - 100000

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."

noteType · object · required

Configuration object specifying the style and format of the generated note

Show child attributes

date · string

Optional encounter date string; ISO-8601 is recommended.

Examples:

"2026-09-07"

"2026-09-07T12:00:00Z"

language · enum<string> · default: en

Language code for the generated note output. This setting is independent of the transcript's language and defaults to English ('en'). Transcription locale tags such as 'es-419' and the multilingual value 'multi' are not accepted.

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

Example:

"en"

patientInfo · object | null

Optional patient information

Show child attributes

previousNote · string

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

Maximum string length: 50000

context · string

Additional context for note generation. This field is optional.

Maximum string length: 50000

instructions · string[]

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.

Maximum string length: 50000

Response

200

application/json

Note response

status · string

Status of the response

Example:

"ok"

data · object

Show child attributes

date · string<date-time>

Timestamp of the response

Example:

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