Skip to content

Create a note

POST
/v1/note
curl --request POST \
--url http://localhost:8090/v1/note \
--header 'Content-Type: application/json' \
--data '{ "text": "example", "tag": "finding", "actor": "example", "nodeIds": [ "example" ], "sessionId": "example" }'

sessionId may be a session name; the backend resolves it to the id. tag defaults to note.

Media typeapplication/json
object
text
required
string
tag
string
default: note
Allowed values: finding decision reminder note
actor
string
nodeIds
Array<string>
sessionId

Session name or id

string

The created note

Media typeapplication/json
object
id
required
string
text
required
string
tag
required
string
actor
string
nullable
nodeIds
required
Array<string>
at
required

ISO timestamp

string
stale
required
boolean
staleReason
string
nullable

Example generated

{
"id": "example",
"text": "example",
"tag": "example",
"actor": "example",
"nodeIds": [
"example"
],
"at": "example",
"stale": true,
"staleReason": "example"
}