Get Note

Get a single note by ID

curl --request GET \
  --url https://api.sully.ai/v1/notes/{noteId} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Account-Id: <api-key>'

import requests

url = "https://api.sully.ai/v1/notes/{noteId}"

headers = {
    "X-API-Key": "<api-key>",
    "X-Account-Id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', 'X-Account-Id': '<api-key>'}
};

fetch('https://api.sully.ai/v1/notes/{noteId}', 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/notes/{noteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sully.ai/v1/notes/{noteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("X-Account-Id", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sully.ai/v1/notes/{noteId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["X-Account-Id"] = '<api-key>'

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

{
  "status": "ok",
  "data": {
    "id": "note_EXAMPLE123456789",
    "payload": {
      "markdown": "<string>",
      "json": {}
    },
    "status": "STATUS_DONE",
    "timestamp": {
      "start": 1731014849730,
      "complete": 1731014853958
    }
  },
  "date": "2024-11-07T21:27:39.000Z"
}

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

GET

notes

{noteId}

Get a single note by ID

curl --request GET \
  --url https://api.sully.ai/v1/notes/{noteId} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Account-Id: <api-key>'

import requests

url = "https://api.sully.ai/v1/notes/{noteId}"

headers = {
    "X-API-Key": "<api-key>",
    "X-Account-Id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', 'X-Account-Id': '<api-key>'}
};

fetch('https://api.sully.ai/v1/notes/{noteId}', 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/notes/{noteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sully.ai/v1/notes/{noteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("X-Account-Id", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sully.ai/v1/notes/{noteId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["X-Account-Id"] = '<api-key>'

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

{
  "status": "ok",
  "data": {
    "id": "note_EXAMPLE123456789",
    "payload": {
      "markdown": "<string>",
      "json": {}
    },
    "status": "STATUS_DONE",
    "timestamp": {
      "start": 1731014849730,
      "complete": 1731014853958
    }
  },
  "date": "2024-11-07T21:27:39.000Z"
}

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

Path Parameters

noteId

string

required

ID of note to get

Response

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:27:39.000Z"

Audio Transcriptions

Notes

Note Styles

Codings

Macros

Utils

Events

Schemas

Authorizations

Path Parameters

Response