API/Create Note

Notes Create Note Creates a new note POST https://api.sully.ai / v1 / notes Try it cURL Python JavaScript PHP Go Java Copy curl --request POST \ --url https://api.sully.ai/v1/notes \ --h

Notes

Create Note

Creates a new note

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

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>"
}'

200400Copy

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

Authorizations

​X-API-KEYstringheaderrequired​X-ACCOUNT-IDstringheaderrequired

Body

application/json

Note to add

​transcriptstringrequired

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

​datestring

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

​languageenum<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,zhExample:

"en"

​noteTypeobject

Configuration object specifying the style and format of the generated note

Show child attributes

​patientInfoobject

Optional patient information

Show child attributes

​previousNotestring

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

​contextstring | null

Additional context for note generation. This field is optional.

​instructionsstring[] | 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."
]

​medicationListstring

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

Response

200200400application/json

Note response

​statusstring

Status of the response

Example:

"ok"

​dataobject

Show child attributes

​datestring

Timestamp of the response

Example:

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