Skip to content

Create a training quiz question

Workforce module

POST/training-quiz-questionstrainingQuizQuestions.create

A question of a quiz lesson; its correct option is a training quiz key that learners never read. Creates a training quiz question. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability knowledge.sop.publish.
  • OAuth scopes: knowledge.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: TrainingQuizQuestionCreate

trainingQuizQuestions.create: TrainingQuizQuestionCreate
FieldTypeRequiredDescription
training_lesson_idstring (uuid)YesIdentifier of the quiz lesson.
positionintegerYesOrder, from 1.Constraints: range 1 to any
promptstringYesQuestion text.Constraints: length 1 to 500
optionsarray of stringYesAnswer options.
{
  "training_lesson_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "prompt": "What do you do before a lift?",
  "options": [
    "Inspect the sling",
    "Skip it"
  ]
}

Response 201: TrainingQuizQuestion

trainingQuizQuestions.create: TrainingQuizQuestion
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the training quiz question.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
training_lesson_idstring (uuid)YesIdentifier of the quiz lesson.
positionintegerYesOrder, from 1.Constraints: range 1 to any
promptstringYesQuestion text.Constraints: length 1 to 500
optionsarray of stringYesAnswer options.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "training_lesson_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "prompt": "What do you do before a lift?",
  "options": [
    "Inspect the sling",
    "Skip it"
  ]
}

Code samples

curl -X POST "$XOS_BASE_URL/training-quiz-questions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"training_lesson_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"prompt":"What do you do before a lift?","options":["Inspect the sling","Skip it"]}'
const { data } = await xos.trainingQuizQuestions.create({
    "training_lesson_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "position": 1,
    "prompt": "What do you do before a lift?",
    "options": [
      "Inspect the sling",
      "Skip it"
    ]
  });
response = xos.training_quiz_questions.create({"training_lesson_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "position": 1, "prompt": "What do you do before a lift?", "options": ["Inspect the sling", "Skip it"]})
xos training-quiz-questions create --data '{"training_lesson_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"prompt":"What do you do before a lift?","options":["Inspect the sling","Skip it"]}'