Generate structured learning plans with modules, outcomes, and pacing

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's encrypted_id for later retrieval.

Use /get for the full roadmap payload.

Use GET /get/{encrypted_id}/{module_number} 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.

curl request

Roadmap example

bash
curl https://api.vidbyte.pro/api/v1/roadmaps/create \ -H "x-api-key: vb_live_your_api_key" \ -H "Idempotency-Key: roadmap-create-001" \ -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