Quickhits API
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.
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.
The route family is intentionally simple
Use `/create` for the first generation call.
Persist the returned encrypted `id` exactly as returned.
Use `/list` to show saved QuickHits in your product.
Use `/get` when you need to revisit one specific QuickHit later.
QuickHits are still the best first live integration
This family is the fastest way to validate key auth, context handling, pricing fields, and the shared response envelope with the smallest operational lift.
Endpoints
/create
/api/v1/quickhits/create
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.
/get
/api/v1/quickhits/get/{encrypted_id}
Fetch one previously generated Quickhit by its encrypted public identifier. Use this after you have stored the `id` returned from create or list operations.
/list
/api/v1/quickhits/list
List the Quickhits owned by the authenticated API principal. This is the retrieval path you use to resync your application state with stored Quickhit resources.