Create an Exam

Create a new exam with pacing, difficulty, and organizational controls. The response includes the encrypted public id plus the generated assessment structure.

POST

/api/v1/exams/create

Example request

curl https://api.vidbyte.ai/api/v1/exams/create \
  -H "Authorization: Bearer vb_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Create a cloud fundamentals exam",
    "content": "IAM, VPCs, networking, observability, and storage tiers",
    "difficulty_level": "progressive",
    "time_density": "standard",
    "question_count": 18,
    "target_duration_minutes": 55
  }'

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, "estimated_duration_minutes": 55 }
  },
  "token_stats": { "input_tokens": 1021, "output_tokens": 1304, "total_tokens": 2325 },
  "pricing": { "total_cost": 0.0348 }
}

Parameter information

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

promptstringRequired

The main topic, task, or learning objective you want Vidbyte to generate from. This is the core instruction the route uses.