POST
/
v1
/
trace-learn
/
share
/
with-tutor
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.shareTraceLearnResultWithTutor({
  body: {},
})
{
  "shared": true,
  "notificationCount": 1,
  "invitedEmailCount": 1,
  "studentId": "<string>"
}

Body

application/json
​
studentId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
resultKind
enum<string>
required
Available options:
child_progress,
diagnostic_result
​
resultId
string

a string at most 128 character(s) long

Maximum string length: 128
​
diagnosticId
string

a string at most 128 character(s) long

Maximum string length: 128
​
tutorEmail
string

a string at most 320 character(s) long

Maximum string length: 320

Response

Success

​
shared
boolean
required
​
notificationCount
integer
required

a non-negative number

Required range: x >= 0
​
invitedEmailCount
integer
required

a non-negative number

Required range: x >= 0
​
studentId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
resultKind
enum<string>
required
Available options:
child_progress,
diagnostic_result