Getting Started
Note Styles
Audio Transcriptions
Macros
Schemas
Notes
Create Note
Creates a new note
POST
/
v1
/
notes
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": "2023-12-25",
"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"
}
Body
application/json
Note to add
The body is of type object
.
Response
200
application/json
Note response
The response is of type object
.
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": "2023-12-25",
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.