POST
/
v1
/
trace-learn
/
tutor
/
students
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.createTraceLearnTutorStudent({
  body: {},
})
{
  "student": {
    "id": "<string>",
    "displayName": "<string>",
    "avatarId": "<string>",
    "yearGroup": "<string>",
    "targetSchool": "<string>",
    "overallScore": 50,
    "streakDays": 123,
    "lastActiveAt": "<string>",
    "weakTopicNames": [
      "<string>"
    ],
    "strongTopicNames": [
      "<string>"
    ]
  },
  "credential": {
    "username": "<string>",
    "pinSet": true,
    "setupRequired": true
  },
  "link": {
    "id": "<string>"
  },
  "welcomeEmail": {
    "notificationId": "<string>",
    "recipientEmail": "<string>",
    "templateId": "<string>",
    "sentAt": "<string>"
  },
  "message": "<string>"
}

Body

application/json
displayName
string
required

a string at most 160 character(s) long

Required string length: 1 - 160
parentEmail
string
required

a string matching the pattern ^[^\s@]+@[^\s@]+.[^\s@]+$

Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
yearGroup
enum<string>
required
Available options:
Year 4,
Year 5,
Year 6
targetSchool
string | null

a string at most 160 character(s) long

Maximum string length: 160
avatarId
string

a string at most 128 character(s) long

Required string length: 1 - 128

Response

Success

student
object
required
credential
object
required
welcomeEmail
object
required
message
string
required