Short explainers and structured study notes from a topic or source material
QuickHits are the lowest-friction content family in the Vidbyte API. Use them to turn a topic into a concise explainer, then list or fetch the resulting resource later by its encrypted id.
Core routes
3
Create, list, and get.
Best first integration
Yes
QuickHits are the easiest route family to wire up first.
Public identifier
Encrypted token
The create route returns the QuickHit token as `id`.
When to use QuickHits
Use QuickHits when your product needs structured explanation output faster than a full roadmap or assessment flow. They work well for coaching UIs, retrieval prompts, contextual explainers, and study-assistant features.
They are also a good staging artifact in a larger workflow: for example, generate a QuickHit first, then pass it back into `context` when generating a quiz or roadmap.
Routes
What this page actually points to
/api/v1/quickhits/create
Generate a QuickHit from a topic and optional context.
Auth
API key via Authorization: Bearer or x-api-key
Maps to
/api/quickhits/create
Notes
Best first integration if you want the smallest, fastest content-generation request.
Request fields
Primary user request, learning goal, or topic for generation.
QuickHit steering mode. The current validator accepts `broad` or `narrow`.
Default
broad
Optional typed context objects. Supported types today are `text`, `doc`, `pdf`, `quickhit`, `roadmap`, `quiz`, `exam`, `project`, and `vidbyte_project`.
Response shape
Public responses use the shared envelope: `success`, `id`, `message`, `data`, `token_stats`, `pricing`, and `error`.
The `id` field is always a public/encrypted identifier boundary, never a raw MongoDB `_id`.
QuickHit create returns the encrypted QuickHit token as `id` so you can fetch it later.
/api/v1/quickhits/list
List QuickHits generated by the authenticated API principal.
Auth
API key via Authorization: Bearer or x-api-key
Maps to
/api/quickhits/list
Notes
Use this to sync your external system with previously generated QuickHits.
Response shape
Public responses use the shared envelope: `success`, `id`, `message`, `data`, `token_stats`, `pricing`, and `error`.
The `id` field is always a public/encrypted identifier boundary, never a raw MongoDB `_id`.
The `data` array contains previously generated QuickHits owned by the authenticated user.
/api/v1/quickhits/get/{encrypted_id}
Fetch one QuickHit by encrypted public id.
Auth
API key via Authorization: Bearer or x-api-key
Maps to
/api/quickhits/get/{encrypted_id}
Notes
Always persist the returned public id from create/list. Raw database ids are never part of the public contract.
Request fields
Encrypted public identifier returned by a create or list route.
Response shape
Public responses use the shared envelope: `success`, `id`, `message`, `data`, `token_stats`, `pricing`, and `error`.
The `id` field is always a public/encrypted identifier boundary, never a raw MongoDB `_id`.
Related pages
Quickstart
The shortest integration path is: create a key in settings, send it as either a bearer token or `x-api-key`, call a create route, and store the returned public `id` for later retrieval.
Roadmaps
Roadmaps turn a learning goal into a phased plan. The public API supports create, list, get, and module-specific retrieval, all using encrypted public ids.
Quizzes
The Quizzes API covers the full quiz lifecycle: create a quiz, batch-generate multiple quizzes, list and fetch saved quizzes, and progressively update an existing quiz by semantic action groups.