POST
/
v1
/
trace-learn
/
diagnostic
/
start
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.startTraceLearnDiagnostic()
{
  "attemptId": "<string>",
  "studentId": "<string>",
  "attemptNumber": 2,
  "resumed": true,
  "revision": 1,
  "position": 1,
  "answers": [
    "<unknown>"
  ],
  "questionCount": 1,
  "timeLimitSeconds": 1,
  "deadlineAt": "<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>"
          }
        ]
      }
    }
  ],
  "resultId": "<string>"
}

Response

Success

attemptId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
studentId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
attemptNumber
integer
required

a number greater than or equal to 1

Required range: x >= 1
status
enum<string>
required
Available options:
in_progress,
completed
resumed
boolean
required
revision
integer
required

a non-negative number

Required range: x >= 0
position
integer
required

a non-negative number

Required range: x >= 0
answers
any[]
required
questionCount
integer
required

a non-negative number

Required range: x >= 0
timeLimitSeconds
integer
required

a non-negative number

Required range: x >= 0
deadlineAt
string
required

a string at least 10 character(s) long

Minimum string length: 10
questions
object[]
required
resultId
string | null

a string at most 128 character(s) long

Required string length: 1 - 128