POST
/
v1
/
trace-learn
/
tutor
/
assignments
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.createTraceLearnTutorAssignment({
  body: {},
})
{
  "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
        }
      ]
    }
  },
  "audience": {
    "studentIds": [
      "<string>"
    ],
    "label": "<string>"
  },
  "timing": {
    "totalSeconds": 123,
    "allowPause": true,
    "showTimeRemaining": true,
    "immediateFeedback": true
  },
  "publication": {
    "createdStudentAssignmentIds": [
      "<string>"
    ],
    "contentFrozen": true,
    "sections": [
      {
        "name": "<string>",
        "questionCount": 123
      }
    ]
  }
}

Body

application/json
title
string
required

a string at most 160 character(s) long

Required string length: 1 - 160
type
enum<string>
required
Available options:
mini-test,
test,
practice
subjectIds
enum<string>[]
required
Available options:
maths,
english,
verbal-reasoning,
non-verbal-reasoning
questionCount
number
required
timeLimitMinutes
number | null
required
dueAt
string | null
required

a string at least 10 character(s) long

Minimum string length: 10
assigneeStudentIds
string[]
required

a string at most 128 character(s) long

Required string length: 1 - 128
publishImmediately
boolean
required
skillIds
string[]
sections
object[]

Response

Success

assignment
object
required
audience
object
required
timing
object
required
publication
object
required