Create Note Style

Create a new note style template

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

import requests

url = "https://api.sully.ai/v1/note-styles"

payload = {
    "sampleNote": "<string>",
    "instructions": []
}
headers = {
    "X-API-Key": "<api-key>",
    "X-Account-Id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': '<api-key>',
    'X-Account-Id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({sampleNote: '<string>', instructions: []})
};

fetch('https://api.sully.ai/v1/note-styles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sully.ai/v1/note-styles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sampleNote' => '<string>',
    'instructions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>",
    "X-Account-Id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sully.ai/v1/note-styles"

	payload := strings.NewReader("{\n  \"sampleNote\": \"<string>\",\n  \"instructions\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("X-Account-Id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sully.ai/v1/note-styles")
  .header("X-API-Key", "<api-key>")
  .header("X-Account-Id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sampleNote\": \"<string>\",\n  \"instructions\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sully.ai/v1/note-styles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["X-Account-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sampleNote\": \"<string>\",\n  \"instructions\": []\n}"

response = http.request(request)
puts response.read_body

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

{
  "status": "error",
  "data": {
    "message": "<string>",
    "code": "<string>",
    "validationErrors": {}
  },
  "date": "2023-11-07T05:31:56Z",
  "errorType": "<string>"
}

{
  "message": "<string>"
}

{
  "status": "error",
  "data": {
    "message": "<string>",
    "code": "<string>",
    "validationErrors": {}
  },
  "date": "2023-11-07T05:31:56Z",
  "errorType": "<string>"
}

POST

note-styles

Create a new note style template

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

import requests

url = "https://api.sully.ai/v1/note-styles"

payload = {
    "sampleNote": "<string>",
    "instructions": []
}
headers = {
    "X-API-Key": "<api-key>",
    "X-Account-Id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': '<api-key>',
    'X-Account-Id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({sampleNote: '<string>', instructions: []})
};

fetch('https://api.sully.ai/v1/note-styles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sully.ai/v1/note-styles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sampleNote' => '<string>',
    'instructions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>",
    "X-Account-Id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sully.ai/v1/note-styles"

	payload := strings.NewReader("{\n  \"sampleNote\": \"<string>\",\n  \"instructions\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("X-Account-Id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sully.ai/v1/note-styles")
  .header("X-API-Key", "<api-key>")
  .header("X-Account-Id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sampleNote\": \"<string>\",\n  \"instructions\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sully.ai/v1/note-styles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["X-Account-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sampleNote\": \"<string>\",\n  \"instructions\": []\n}"

response = http.request(request)
puts response.read_body

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

{
  "status": "error",
  "data": {
    "message": "<string>",
    "code": "<string>",
    "validationErrors": {}
  },
  "date": "2023-11-07T05:31:56Z",
  "errorType": "<string>"
}

{
  "message": "<string>"
}

{
  "status": "error",
  "data": {
    "message": "<string>",
    "code": "<string>",
    "validationErrors": {}
  },
  "date": "2023-11-07T05:31:56Z",
  "errorType": "<string>"
}

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 style to add

sampleNote

string

required

Sample note text to base the style on

instructions

string[]

Optional instructions for note generation

Response

Note style response

status

string

Status of the response

Example:

"ok"

data

object

Show child attributes

date

string<date-time>

Timestamp of the response

Audio Transcriptions

Notes

Note Styles

Codings

Macros

Utils

Events

Schemas

Create Note Style

Authorizations

Body

Response