Live surfaceGetting started

Use the existing public API-key routes, not the future-facing resource sketches

Make your first live request

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

Manage keys
Route-accurate reference

First route

/api/v1/quickhits/create

Lowest-friction live route.

Auth

API key header

Bearer and `x-api-key` both work.

Stored IDs

Encrypted token

Quickhits return an external encrypted token for later use.

Quick sequence

01

Create a key in `/settings/api`

The plaintext key is shown once, so copy it into a secure environment variable immediately.

02

Choose a live versioned route

Use quickhits create or roadmaps create under `/api/v1`.

03

Send JSON with your API key

Use `Authorization: Bearer ...` or `x-api-key` plus `Content-Type: application/json`.

04

Persist external identifiers

Store the encrypted quickhit token or returned roadmap ID with your own records.

Recommended first call

Use quickhits first if you want the lightest successful integration. It exercises auth, entitlement, orchestration, and usage reporting in one request.

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.

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.

Related pages

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

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