Vidbyte

API documentation

Get a Quiz

Fetch one previously generated quiz by encrypted public id. Use this after your application has persisted the id returned from create, batch create, or list.

GET
/api/v1/quizzes/get/{encrypted_id}

Example request

curl https://api.vidbyte.ai/api/v1/quizzes/get/quiz_9Yv7k12Lm \
  -H "Authorization: Bearer vb_live_your_api_key"

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", "questions": [{ "question": "What does Cache-Control do?" }], "total_questions": 5 }
  }
}

Parameter information

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

encrypted_idstringRequired

The public encrypted identifier previously returned by a create or list route. Pass it back exactly as returned when you want to fetch that resource again.