GET
/
v1
/
learning
/
student
/
paths
/
{subjectId}
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

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

const response = await client.studentExperience.getStudentExperiencePath({
  subjectId: process.env.TX_AGENT_KIT_SUBJECT_ID ?? "subjectId",
})
{
  "title": "<string>",
  "backdrop": "<string>",
  "completed": 1,
  "total": 1,
  "islands": [
    {
      "lessonId": "<string>",
      "title": "<string>",
      "topicId": "<string>",
      "position": 1,
      "chapter": "<string>",
      "sessionId": "<string>"
    }
  ]
}

Path Parameters

subjectId
enum<string>
required
Available options:
maths,
english,
verbal-reasoning,
non-verbal-reasoning

Response

Success

subjectId
enum<string>
required
Available options:
maths,
english,
verbal-reasoning,
non-verbal-reasoning
title
string
required
backdrop
string
required
completed
integer
required

a non-negative number

Required range: x >= 0
total
integer
required

a non-negative number

Required range: x >= 0
islands
object[]
required