Get an Exam

Fetch one exam by encrypted public id. Use this to rehydrate a stored exam in your application after the create flow has completed.

GET

/api/v1/exams/get/{encrypted_id}

Example request

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

Example response

{
  "success": true,
  "id": "exam_2Fkp90Qz",
  "data": {
    "id": "exam_2Fkp90Qz",
    "item_type": "exam",
    "title": "Cloud fundamentals exam",
    "description": "Assess IAM, VPC, storage, and observability fundamentals.",
    "status": "active",
    "version": 1,
    "actions_applied": [],
    "createdAt": "2026-03-12T10:00:00",
    "updatedAt": "2026-03-12T10:05:00",
    "exam_data": { "title": "Cloud fundamentals exam", "sections": [{ "title": "Cloud fundamentals" }], "total_questions": 18 }
  }
}

Parameter information

These are the public parameters for /api/v1/exams/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.