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,
    "createdAt": "<string>",
    "assignedByName": "<string>",
    "canDelete": true,
    "assignedStudentIds": [
      "<string>"
    ],
    "resultSummary": {
      "assignedCount": 123,
      "completedCount": 123,
      "completionRatePercent": 50,
      "classAveragePercent": 50,
      "perStudent": [
        {
          "studentId": "<string>",
          "scorePercent": 50
        }
      ]
    }
  },
  "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>"
          }
        ],
        "passage": "<string>",
        "explanation": "<string>",
        "componentKey": "<string>",
        "componentId": "<string>",
        "props": {}
      }
    ],
    "quiz": [
      {
        "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>"
            }
          ]
        }
      }
    ],
    "contentVersion": 2,
    "lessonNumber": 123,
    "lessonCount": 123,
    "attempt": {
      "attemptId": "<string>",
      "blockPosition": 1,
      "quizPosition": 1,
      "revision": 1,
      "resumed": true,
      "answers": [
        "<unknown>"
      ],
      "verdicts": {}
    }
  },
  "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>"
          }
        ]
      }
    }
  ],
  "sections": [
    {
      "name": "<string>",
      "startQuestion": 123,
      "endQuestion": 123
    }
  ]
}

Path Parameters

type
enum<string>
required
Available options:
mini-test,
test,
practice
assignmentId
string
required

Response

Success

assignment
object
required
state
enum<string>
required
Available options:
not-started,
in-progress,
submitted,
reviewed,
abandoned
timer
object
required
feedback
object
required
lesson
object
required
questions
object[]
required
sections
object[]