GET
/
v1
/
learning
/
tutor
/
students
/
{studentId}
/
notes
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.traceLearn.listTraceLearnTutorStudentNotes({
  studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? "studentId",
  query: {},
})
{
  "studentId": "<string>",
  "notes": [
    {
      "id": "<string>",
      "studentId": "<string>",
      "sessionDate": "<string>",
      "tags": [],
      "body": "<string>",
      "authorDisplayName": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

Path Parameters

studentId
string
required

Query Parameters

limit
string

a string to be decoded into a number

cursor
string

a string at most 2048 character(s) long

Maximum string length: 2048
from
string

a string matching the pattern ^\d{4}-\d{2}-\d{2}$

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string

a string matching the pattern ^\d{4}-\d{2}-\d{2}$

Pattern: ^\d{4}-\d{2}-\d{2}$
tag
enum<string>
Available options:
strength,
concern,
homework,
follow_up

Response

Success

studentId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
notes
object[]
required
nextCursor
string | null