Vidbyte

API documentation

Browse docs

Roadmaps

Keys
OverviewQuickstartAuth & KeysPricingDeveloper guidelinesRate limitsSecurityRoadmapsQuizzesProjectsBlogContactSDKsAgents

Roadmaps API

Roadmaps turn a learning goal into a phased plan. The public API supports create, list, get, and module-specific retrieval, all using encrypted public ids.

1. Why roadmaps are durable resources

A roadmap is not just a blob of text. It is a structured resource with modules and outcomes that your application can render, revisit, or slice into smaller subviews like per-module retrieval.

That makes roadmaps a strong fit for onboarding programs, certification prep, internal training plans, or agent workflows that need a stepwise plan before generating follow-up content.

2. The route family supports both full-resource and module-level retrieval

Use `/create` to generate the roadmap.

Store the roadmap `id` for later retrieval.

Use `/get` for the full roadmap payload.

Use `/get-module` when one module is the only follow-up view you need.

3. Roadmaps are best when you steer sequencing, level, and timeline clearly

This family is a good fit when your product needs curriculum structure instead of a short explainer. Give the model enough context about learner level, scope, and pacing so the roadmap can become a long-lived artifact instead of a vague outline.

Open the create endpoint

curl request

curl request

Roadmap example

curl https://vidbyte-backend.onrender.com/api/v1/roadmaps/create \
  -H "x-api-key: vb_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Build a backend API platform roadmap",
    "experience": "intermediate",
    "timeline": "8 weeks",
    "resource_preference": "reading and docs"
  }'

Endpoints

4 pages
POSTLive

/create

/api/v1/roadmaps/create

Create a new roadmap with learner context, pacing, and resource preferences. The response includes the encrypted public id plus the generated roadmap structure.

Open endpoint page
GETLive

/get

/api/v1/roadmaps/get/{encrypted_id}

Fetch one roadmap by encrypted public id. This route is the standard way to rehydrate a stored roadmap inside your product after creation.

Open endpoint page
GETLive

/list

/api/v1/roadmaps/list

List the roadmaps owned by the authenticated principal. Use this route when your application needs to discover or reconcile previously created roadmap resources.

Open endpoint page
GETLive

/get-module

/api/v1/roadmaps/get/{encrypted_id}/{module_number}

Fetch a single roadmap module by roadmap id and module index. This is the focused retrieval path when you do not want to pull the full roadmap payload again.

Open endpoint page