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.answerStudentExperienceQuestion({
sessionId: process.env.TX_AGENT_KIT_SESSION_ID ?? "sessionId",
body: {},
}){
"id": "<string>",
"lessonId": "<string>",
"revision": 1,
"position": 1,
"lesson": {
"id": "<string>",
"title": "<string>",
"topicId": "<string>",
"contentVersion": 1,
"slides": [
{
"id": "<string>",
"title": "<string>",
"body": "<string>",
"bullets": [
"<string>"
],
"visual": {
"kind": "word_grid",
"rows": 3,
"columns": 3,
"cells": [
"<string>"
],
"caption": "<string>"
}
}
],
"interactive": {
"kind": "<string>",
"spec": {}
},
"helpsheet": {
"title": "<string>",
"sections": [
{
"heading": "<string>",
"body": "<string>",
"bullets": [
"<string>"
],
"visual": {
"kind": "word_grid",
"rows": 3,
"columns": 3,
"cells": [
"<string>"
],
"caption": "<string>"
}
}
]
},
"video": {
"url": "<string>",
"title": "<string>",
"posterUrl": "<string>"
}
},
"questions": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"expectedTimeSeconds": 123,
"passage": "<string>",
"clozeTemplate": "<string>",
"clozeBlanks": [
{
"id": "<string>",
"options": [
"<string>"
]
}
],
"matchingLeftLabel": "<string>",
"matchingRightLabel": "<string>",
"matchingLeftItems": [
"<string>"
],
"matchingRightOptions": [
"<string>"
],
"sequenceChips": [
{
"id": "<string>",
"label": "<string>"
}
],
"stimulus": {
"kind": "analogy-grid",
"a": "<string>",
"b": "<string>",
"c": "<string>",
"visualTerms": {
"a": {
"kind": "l-shape-dot",
"description": "<string>"
},
"b": {
"kind": "l-shape-dot",
"description": "<string>"
},
"c": {
"kind": "l-shape-dot",
"description": "<string>"
}
},
"visualOptions": [
{
"kind": "l-shape-dot",
"description": "<string>"
}
]
}
}
],
"answers": [
{
"questionId": "<string>",
"value": "<unknown>",
"correct": true,
"explanation": {
"summary": "<string>",
"steps": [
"<string>"
],
"visual": {
"kind": "word_grid",
"rows": 3,
"columns": 3,
"cells": [
"<string>"
],
"caption": "<string>"
}
},
"coinsAwarded": 1,
"supported": true,
"answeredAt": "<string>",
"selectedAnswerIndex": 123,
"correctAnswerIndex": 123,
"correctAnswer": "<unknown>"
}
],
"coinsAwarded": 1,
"completedAt": "<string>",
"activeMs": 1,
"interactiveTipsSeen": true
}Student experience
Answer student experience question
POST
/
v1
/
learning
/
student
/
sessions
/
{sessionId}
/
answers
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.answerStudentExperienceQuestion({
sessionId: process.env.TX_AGENT_KIT_SESSION_ID ?? "sessionId",
body: {},
}){
"id": "<string>",
"lessonId": "<string>",
"revision": 1,
"position": 1,
"lesson": {
"id": "<string>",
"title": "<string>",
"topicId": "<string>",
"contentVersion": 1,
"slides": [
{
"id": "<string>",
"title": "<string>",
"body": "<string>",
"bullets": [
"<string>"
],
"visual": {
"kind": "word_grid",
"rows": 3,
"columns": 3,
"cells": [
"<string>"
],
"caption": "<string>"
}
}
],
"interactive": {
"kind": "<string>",
"spec": {}
},
"helpsheet": {
"title": "<string>",
"sections": [
{
"heading": "<string>",
"body": "<string>",
"bullets": [
"<string>"
],
"visual": {
"kind": "word_grid",
"rows": 3,
"columns": 3,
"cells": [
"<string>"
],
"caption": "<string>"
}
}
]
},
"video": {
"url": "<string>",
"title": "<string>",
"posterUrl": "<string>"
}
},
"questions": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"expectedTimeSeconds": 123,
"passage": "<string>",
"clozeTemplate": "<string>",
"clozeBlanks": [
{
"id": "<string>",
"options": [
"<string>"
]
}
],
"matchingLeftLabel": "<string>",
"matchingRightLabel": "<string>",
"matchingLeftItems": [
"<string>"
],
"matchingRightOptions": [
"<string>"
],
"sequenceChips": [
{
"id": "<string>",
"label": "<string>"
}
],
"stimulus": {
"kind": "analogy-grid",
"a": "<string>",
"b": "<string>",
"c": "<string>",
"visualTerms": {
"a": {
"kind": "l-shape-dot",
"description": "<string>"
},
"b": {
"kind": "l-shape-dot",
"description": "<string>"
},
"c": {
"kind": "l-shape-dot",
"description": "<string>"
}
},
"visualOptions": [
{
"kind": "l-shape-dot",
"description": "<string>"
}
]
}
}
],
"answers": [
{
"questionId": "<string>",
"value": "<unknown>",
"correct": true,
"explanation": {
"summary": "<string>",
"steps": [
"<string>"
],
"visual": {
"kind": "word_grid",
"rows": 3,
"columns": 3,
"cells": [
"<string>"
],
"caption": "<string>"
}
},
"coinsAwarded": 1,
"supported": true,
"answeredAt": "<string>",
"selectedAnswerIndex": 123,
"correctAnswerIndex": 123,
"correctAnswer": "<unknown>"
}
],
"coinsAwarded": 1,
"completedAt": "<string>",
"activeMs": 1,
"interactiveTipsSeen": true
}Path Parameters
Body
application/json
Response
Success
Available options:
islands, revise Available options:
learn, questions_only Available options:
in_progress, completed a non-negative number
Required range:
x >= 0Available options:
slides, interactive, questions, review a non-negative number
Required range:
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
a non-negative number
Required range:
x >= 0a non-negative number
Required range:
x >= 0⌘I