Live create routeReference

The cleanest live entry point into the current public API surface

Quickhits API

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.

Manage keys
Route-accurate reference

Public route

POST /api/v1/quickhits/create

Live API-key path.

Internal follow-up

Expand sections

Live in the backend, but not exposed by the public API-key policy.

Response ids

Encrypted token

Persist the returned `encrypted_token` for downstream app flows.

Why quickhits are the best first integration

The request is intentionally small, the path is live today, and the response already gives you durable identifiers plus usage metadata.

Routes

What this page actually points to

2 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.

POSTInternal only

/api/quickhits/expand

Expand a saved quickhit section.

Auth

Session/JWT auth in the app today

Notes

Useful for product context, but not part of the current API-key public surface.

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 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 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