Live create routeReference

One public versioned create route, with additional roadmap flows still internal

Roadmaps API

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.

Manage keys
Route-accurate reference

Public route

POST /api/v1/roadmaps/create

Live API-key path.

Internal follow-up

Assistant + resource quizzes

Existing backend routes, not versioned public endpoints yet.

Defaults

Timeline + experience

The current route normalizes pacing and experience inputs into the internal roadmap flow.

Current public contract

The public route creates the roadmap record and then runs the existing roadmap orchestrator.

If you need list, get, or assistant flows through the external API, those still need a versioned public route layer.

Routes

What this page actually points to

3 entries
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/roadmap/assistant

Chat with the roadmap learning assistant on an existing roadmap resource.

Auth

Session/JWT auth in the app today

Notes

This route exists in the backend but is not currently exposed through the API-key policy surface.

GETInternal only

/api/roadmap/{roadmap_id}/modules/{module_index}/resources/{resource_index}/quizzes

Retrieve quizzes attached to a roadmap resource.

Auth

Session/JWT auth in the app today

Notes

Not currently versioned under `/api/v1`.

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

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