Create a session note
curl --request POST \
--url https://api.example.com/v1/session_notes \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"session_id": "<string>",
"note": "<string>",
"identifier": ""
}
}
'import requests
url = "https://api.example.com/v1/session_notes"
payload = { "data": {
"session_id": "<string>",
"note": "<string>",
"identifier": ""
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({data: {session_id: '<string>', note: '<string>', identifier: ''}})
};
fetch('https://api.example.com/v1/session_notes', 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.example.com/v1/session_notes",
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([
'data' => [
'session_id' => '<string>',
'note' => '<string>',
'identifier' => ''
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/v1/session_notes"
payload := strings.NewReader("{\n \"data\": {\n \"session_id\": \"<string>\",\n \"note\": \"<string>\",\n \"identifier\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/session_notes")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"session_id\": \"<string>\",\n \"note\": \"<string>\",\n \"identifier\": \"\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/session_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"session_id\": \"<string>\",\n \"note\": \"<string>\",\n \"identifier\": \"\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>"
}
}"<string>""<string>"{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Sessions
Create a session note
Add a note annotation to a session. By default each call appends a new note with an auto-generated UUIDv4 identifier, so multiple notes accumulate on the same session. Callers may supply a non-empty identifier to upsert on (session_id, name=‘note’, identifier) — repeated calls with the same identifier overwrite the existing note, matching the semantics of structured annotations.
POST
/
v1
/
session_notes
Create a session note
curl --request POST \
--url https://api.example.com/v1/session_notes \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"session_id": "<string>",
"note": "<string>",
"identifier": ""
}
}
'import requests
url = "https://api.example.com/v1/session_notes"
payload = { "data": {
"session_id": "<string>",
"note": "<string>",
"identifier": ""
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({data: {session_id: '<string>', note: '<string>', identifier: ''}})
};
fetch('https://api.example.com/v1/session_notes', 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.example.com/v1/session_notes",
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([
'data' => [
'session_id' => '<string>',
'note' => '<string>',
'identifier' => ''
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/v1/session_notes"
payload := strings.NewReader("{\n \"data\": {\n \"session_id\": \"<string>\",\n \"note\": \"<string>\",\n \"identifier\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/session_notes")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"session_id\": \"<string>\",\n \"note\": \"<string>\",\n \"identifier\": \"\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/session_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"session_id\": \"<string>\",\n \"note\": \"<string>\",\n \"identifier\": \"\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>"
}
}"<string>""<string>"{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Was this page helpful?
⌘I