Get Note

Gets a single note based on the ID supplied

GET /v1/notes/{noteId}

Try it

Get a single note by ID

cURL

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

200

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

Authorizations

X-API-KEY · string · header · required

X-ACCOUNT-ID · string · header · required

Path Parameters

noteId · string · required

ID of note to get

Response

200

application/json

Note response

status · string

Status of the response

Example:

"ok"

data · object

Show child attributes

data. id · string

Unique identifier for the audio transcription

Example:

"note_EXAMPLE123456789"

data. payload · object

Either markdown or JSON representation of the note. Both can be present as well.

Show child attributes

data.payload. markdown · string

Markdown string of the note

data.payload. json · object

JSON object of the note. The note style used will determine which fields are present. See the SOAP Note example.

data. status · string

Processing status of the note

Example:

"STATUS_DONE"

data. timestamp · object

Show child attributes

data.timestamp. start · integer

Start timestamp

Example:

1731014849730

data.timestamp. complete · integer

Complete timestamp

Example:

1731014853958

date · string<date-time>

Timestamp of the response

Example:

"2024-11-07T21:27:39.000Z"