Live surfaceGetting started

A route-first reference for the current external API surface

Vidbyte API reference

Vidbyte's API docs now separate what is live today from what is still product direction. The public API-key surface currently ships versioned create routes for quickhits and roadmaps, while quizzes, exams, and projects remain internal or preview-only.

Manage keys
Route-accurate reference

Public routes live

2

Quickhits create and roadmaps create currently accept API keys.

Auth model

Bearer or x-api-key

Middleware resolves API keys before subscription and entitlement checks.

Preview areas

3 families

Quizzes, exams, and projects still need a public versioned route layer.

Current posture

Use the versioned `/api/v1/.../create` routes for the current external API-key surface.
Routes under `/api/sandbox` are real backend routes, but they are not yet approved for public API-key requests.
The docs intentionally label future resource-style endpoints as preview so the reference stays trustworthy.

What is live now

Today, the reliable external surface is narrow by design: create a quickhit or create a roadmap through `/api/v1` with an API key.

Those versioned routes map into the existing internal orchestrators and still benefit from the same auth, subscription, entitlement, and rate-limit middleware chain.

What is still becoming public

Quiz, exam, and project generation already exist in the backend under sandbox routes, but they remain app-authenticated internals rather than API-key-approved public contracts.

Routes

What this page actually points to

4 entries
POSTLive

/api/v1/quickhits/create

Create a QuickHit through the current versioned public API contract.

Auth

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

Maps to

/api/quickhits/create

Notes

This is the main live API-key route for quickhit generation today.

Request fields

promptstringRequired

Topic or concept to explain.

modestringOptional

Generation mode forwarded to the internal quickhits route.

Default

broad

contextobject[]Optional

Reserved in the versioned request model. The mapped backend flow is still prompt-first.

Response shape

Returns `success`, `quickhit_id`, `encrypted_token`, and `data`.

The `encrypted_token` is the durable external reference for later app retrieval flows.

POSTLive

/api/v1/roadmaps/create

Create a roadmap through the current versioned public API contract.

Auth

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

Maps to

/api/roadmap/create

Notes

The versioned route creates the record, then forwards into the internal roadmap orchestrator.

Request fields

promptstringRequired

Learning objective or curriculum request.

timelinestringOptional

Preferred pacing string passed into roadmap generation.

Default

3 months

experiencestring | string[]Optional

Learner experience level. Strings are normalized into the backend list form.

resource_preferencestringOptional

Optional bias toward a resource style.

contextobject[]Optional

Reserved in the versioned request model while the live route remains primarily prompt-driven.

Response shape

Returns `success`, `roadmap_id`, `message`, `data.modules`, `token_stats`, and `pricing`.

The public versioned surface currently ships create only. Versioned list/get routes are still pending.

POSTInternal only

/api/sandbox/create_quiz

Generate a quiz from content using sandbox orchestration.

Auth

Session/JWT auth in the app today

Notes

This route is live in the backend but is not yet approved by `is_api_key_route` for external API-key access.

POSTPreview

/api/v1/projects

Planned versioned project create route described by the product design.

Auth

Planned API key support

Notes

This shape is design direction, not a shipped backend path.

Related pages

Live surface

Quickstart

The fastest path is: create a key in settings, send it as a bearer token or `x-api-key`, then call the live quickhits or roadmaps create route under `/api/v1`.

Open page
Live behavior

Authentication

The backend accepts API keys through either `Authorization: Bearer vb_live_...` or `x-api-key`. Once a key is resolved, the request still has to pass permission checks, subscription validation, entitlement checks, and rate limiting.

Open page
Live create route

Roadmaps

Roadmaps currently expose a live public create route under `/api/v1/roadmaps/create`. Assistant-style follow-up interactions and resource-level quiz retrieval exist in the backend, but they remain internal app-authenticated routes for now.

Open page
Live create route

Quickhits

Quickhits have a live versioned create route for external API-key callers. Section expansion remains an internal app route, so the public docs focus on the shipped create contract and clearly separate later lifecycle actions.

Open page