Create a Quickhit

Create a new Quickhit from a prompt and optional context. This page focuses on the exact request contract, the supported request parameters, and the public response envelope you should expect back.

POST

/api/v1/quickhits/create

Example request

curl https://api.vidbyte.ai/api/v1/quickhits/create \
  -H "Authorization: Bearer vb_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Explain event sourcing to a CRUD engineer",
    "mode": "broad",
    "context": [
      { "type": "text", "label": "audience", "text": "Senior backend engineers" }
    ]
  }'

Example response

{
  "success": true,
  "id": "qh_oT8g2lQm8p",
  "data": {
    "id": "qh_oT8g2lQm8p",
    "topic": "Explain event sourcing to a CRUD engineer",
    "mode": "broad",
    "sections": [{ "key": "mental-model", "content": { "paragraphs": ["Event sourcing persists state changes as immutable facts you can replay later."] } }],
    "pretest_questions": [{ "question": "When do you need immutable history instead of only current state?" }],
    "nextSteps": [{ "heading": "Compare it to audit logging" }]
  },
  "token_stats": { "input_tokens": 382, "output_tokens": 221, "total_tokens": 603 },
  "pricing": { "total_cost": 0.0124, "num_searches": 0 }
}

Parameter information

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