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.getTraceLearnHomeworkRuntime({
type: process.env.TX_AGENT_KIT_TYPE ?? "type",
assignmentId: process.env.TX_AGENT_KIT_ASSIGNMENT_ID ?? "assignmentId",
}){
"assignment": {
"id": "<string>",
"title": "<string>",
"subjectName": "<string>",
"questionCount": 123,
"dueAt": "<string>",
"dueLabel": "<string>",
"timeLimitMinutes": 123,
"assignedStudentIds": [
"<string>"
]
},
"timer": {
"totalSeconds": 123,
"allowPause": true,
"showTimeRemaining": true
},
"feedback": {
"immediate": true,
"allowRetryInPlace": true
},
"lesson": {
"id": "<string>",
"segmentId": "<string>",
"title": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"durationSeconds": 123,
"blocks": [
{
"id": "<string>",
"title": "<string>",
"content": "<string>",
"items": [
{
"term": "<string>",
"definition": "<string>"
}
],
"visualParts": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
]
}
],
"quiz": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"explanation": "<string>",
"expectedTimeSeconds": 123,
"clozeTemplate": "<string>",
"clozeBlanks": [
{
"id": "<string>",
"options": [
"<string>"
]
}
],
"matchingLeftLabel": "<string>",
"matchingRightLabel": "<string>",
"matchingPairs": [
{
"left": "<string>",
"right": "<string>"
}
],
"sequenceChips": [
{
"id": "<string>",
"label": "<string>"
}
]
}
]
},
"questions": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"explanation": "<string>",
"expectedTimeSeconds": 123,
"clozeTemplate": "<string>",
"clozeBlanks": [
{
"id": "<string>",
"options": [
"<string>"
]
}
],
"matchingLeftLabel": "<string>",
"matchingRightLabel": "<string>",
"matchingPairs": [
{
"left": "<string>",
"right": "<string>"
}
],
"sequenceChips": [
{
"id": "<string>",
"label": "<string>"
}
]
}
]
}Trace Learn
Trace learn homework runtime
GET
/
v1
/
trace-learn
/
homework
/
{type}
/
{assignmentId}
/
runtime
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.getTraceLearnHomeworkRuntime({
type: process.env.TX_AGENT_KIT_TYPE ?? "type",
assignmentId: process.env.TX_AGENT_KIT_ASSIGNMENT_ID ?? "assignmentId",
}){
"assignment": {
"id": "<string>",
"title": "<string>",
"subjectName": "<string>",
"questionCount": 123,
"dueAt": "<string>",
"dueLabel": "<string>",
"timeLimitMinutes": 123,
"assignedStudentIds": [
"<string>"
]
},
"timer": {
"totalSeconds": 123,
"allowPause": true,
"showTimeRemaining": true
},
"feedback": {
"immediate": true,
"allowRetryInPlace": true
},
"lesson": {
"id": "<string>",
"segmentId": "<string>",
"title": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"durationSeconds": 123,
"blocks": [
{
"id": "<string>",
"title": "<string>",
"content": "<string>",
"items": [
{
"term": "<string>",
"definition": "<string>"
}
],
"visualParts": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
]
}
],
"quiz": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"explanation": "<string>",
"expectedTimeSeconds": 123,
"clozeTemplate": "<string>",
"clozeBlanks": [
{
"id": "<string>",
"options": [
"<string>"
]
}
],
"matchingLeftLabel": "<string>",
"matchingRightLabel": "<string>",
"matchingPairs": [
{
"left": "<string>",
"right": "<string>"
}
],
"sequenceChips": [
{
"id": "<string>",
"label": "<string>"
}
]
}
]
},
"questions": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectName": "<string>",
"topicId": "<string>",
"topicName": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"explanation": "<string>",
"expectedTimeSeconds": 123,
"clozeTemplate": "<string>",
"clozeBlanks": [
{
"id": "<string>",
"options": [
"<string>"
]
}
],
"matchingLeftLabel": "<string>",
"matchingRightLabel": "<string>",
"matchingPairs": [
{
"left": "<string>",
"right": "<string>"
}
],
"sequenceChips": [
{
"id": "<string>",
"label": "<string>"
}
]
}
]
}Path Parameters
Available options:
mini-test, test, practice Response
Success
Show child attributes
Show child attributes
Available options:
not-started, in-progress, submitted, reviewed, abandoned Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I