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.getTraceLearnLessonInstanceRuntime({
instanceId: process.env.TX_AGENT_KIT_INSTANCE_ID ?? "instanceId",
}){
"instance": {
"instanceId": "<string>",
"skillId": "<string>",
"skillTitle": "<string>",
"subjectId": "<string>",
"blockCount": 123,
"preQuestionCount": 123,
"transferQuestionCount": 123,
"expiresAt": "<string>",
"subjectMismatch": true
},
"blocks": [
{
"ordinal": 123,
"engineKind": "<string>",
"payload": "<unknown>",
"allowHints": true,
"maxRetries": 123
}
],
"preQuestions": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectId": "<string>",
"skillId": "<string>",
"answerMode": "<string>",
"answerKind": "<string>",
"interactionMode": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"answerKey": {},
"explanation": "<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": "<unknown>"
}
],
"transferQuestions": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectId": "<string>",
"skillId": "<string>",
"answerMode": "<string>",
"answerKind": "<string>",
"interactionMode": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"answerKey": {},
"explanation": "<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": "<unknown>"
}
],
"cursor": {
"index": 1
}
}Trace Learn
Trace learn lesson instance runtime
GET
/
v1
/
trace-learn
/
learn
/
instances
/
{instanceId}
/
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.getTraceLearnLessonInstanceRuntime({
instanceId: process.env.TX_AGENT_KIT_INSTANCE_ID ?? "instanceId",
}){
"instance": {
"instanceId": "<string>",
"skillId": "<string>",
"skillTitle": "<string>",
"subjectId": "<string>",
"blockCount": 123,
"preQuestionCount": 123,
"transferQuestionCount": 123,
"expiresAt": "<string>",
"subjectMismatch": true
},
"blocks": [
{
"ordinal": 123,
"engineKind": "<string>",
"payload": "<unknown>",
"allowHints": true,
"maxRetries": 123
}
],
"preQuestions": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectId": "<string>",
"skillId": "<string>",
"answerMode": "<string>",
"answerKind": "<string>",
"interactionMode": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"answerKey": {},
"explanation": "<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": "<unknown>"
}
],
"transferQuestions": [
{
"id": "<string>",
"questionVersionId": "<string>",
"subjectId": "<string>",
"skillId": "<string>",
"answerMode": "<string>",
"answerKind": "<string>",
"interactionMode": "<string>",
"prompt": "<string>",
"options": [
"<string>"
],
"answerKey": {},
"explanation": "<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": "<unknown>"
}
],
"cursor": {
"index": 1
}
}Path Parameters
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}$⌘I