Vidbyte

API documentation

Browse docs

Create a Quickhit

Keys
OverviewQuickstartAuth & KeysConnectorsContext adapterImport from connectorsDeveloper guidelinesRate limitsSecurityResponse ShapeQuickhitsRoadmapsQuizzesExamsProjectsBlogContactoverview/create/get/list
POSTLivePOSTFocused route reference

POST /api/v1/quickhits/create

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.

Manage keys
Stable public contract

Public endpoint

/api/v1/quickhits/create

Maps to

/api/quickhits/create

What to know first

Best first integration if you want the smallest, fastest content-generation request.

Method

POST

Send this operation to /api/v1/quickhits/create on the versioned public host.

Authentication

API key

API key via Authorization: Bearer or x-api-key

Resource model

Direct

Best first integration if you want the smallest, fastest content-generation request.

Highlights

What this operation does

Generate a QuickHit from a topic and optional context.
Best first integration if you want the smallest, fastest content-generation request.
Store the encrypted `id` returned by create and list routes exactly as returned if you need to fetch the resource again later.

Request details

Request parameters

Request parameters

These are the parameters that shape /api/v1/quickhits/create. Path parameters and request-body fields are shown together because the docs stay focused on the public route contract.

promptstringRequired

Primary user request, learning goal, or topic for generation.

modestringOptional

QuickHit steering mode. The current validator accepts `broad` or `narrow`.

Default

broad

View supported values2 options
broad

Generate a wider explainer that surveys the topic from several angles.

narrow

Stay tightly focused on one slice of the topic instead of branching outward.

contextobject[]Optional

Optional typed context objects. Use this field to send source text, documents, prior Vidbyte resources, or content you imported from a connected provider into the request.

View supported values9 options
text

Inline plain text you want the route to read directly.

doc

A document payload or extracted document text normalized into the context layer.

pdf

A PDF payload or extracted PDF text normalized into the context layer.

quickhit

A previously generated QuickHit identified by its encrypted public id.

roadmap

A previously generated roadmap identified by its encrypted public id.

quiz

A previously generated quiz identified by its encrypted public id.

exam

A previously generated exam identified by its encrypted public id.

project

A previously generated project identified by its encrypted public id.

vidbyte_project

An alias for project-backed context in the current middleware.

Response shape

What the response contract guarantees

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.