POST
/
v1
/
learning
/
parent
/
children
/
{studentId}
/
start-learning
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.startTraceLearnParentLearning({
  studentId: process.env.TX_AGENT_KIT_STUDENT_ID ?? "studentId",
})
{
  "studentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entitlementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "trialStartedAt": "<string>",
  "trialEndsAt": "<string>"
}

Path Parameters

studentId
string
required

Response

Success

studentId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
entitlementId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
accessKind
enum<string>
required
Available options:
trial,
existing
trialStartedAt
string | null
required
trialEndsAt
string | null
required