Create a Quiz

Create a new quiz with the public v1 request contract. This page covers the request fields, the supported steering values, and the exact response you can parse in production.

POST

/api/v1/quizzes/create

Example request

curl https://api.vidbyte.ai/api/v1/quizzes/create \
  -H "Authorization: Bearer vb_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Assess whether junior engineers understand HTTP caching",
    "content": "Cache-Control, ETag, revalidation, and freshness lifetime",
    "quiz_type": "multiple_choice",
    "reasoning_lens": "first_principles_thinking",
    "difficulty": "balanced",
    "length": "medium",
    "assessment_intent": "formative"
  }'

Example response

{
  "success": true,
  "id": "quiz_9Yv7k12Lm",
  "data": {
    "id": "quiz_9Yv7k12Lm",
    "item_type": "quiz",
    "title": "HTTP caching mastery check",
    "description": "Assess whether junior engineers understand freshness, validators, and revalidation.",
    "quiz_type": "multiple_choice",
    "status": "active",
    "version": 1,
    "actions_applied": [],
    "createdAt": "2026-03-12T10:00:00",
    "updatedAt": "2026-03-12T10:05:00",
    "quiz_data": {
      "title": "HTTP caching mastery check",
      "total_questions": 5,
      "questions": [{ "question": "What does Cache-Control do?" }]
    }
  },
  "token_stats": { "input_tokens": 782, "output_tokens": 663, "total_tokens": 1445 },
  "pricing": { "total_cost": 0.0217 }
}

Parameter information

These are the public parameters for /api/v1/quizzes/create. Path parameters and request-body fields are shown together so the page stays focused on the live request contract you actually send.

titlestringOptional

Optional saved title for the quiz resource. Use this when you want the returned quiz to have a predictable human-readable name.