POST /api/v1/roadmaps/create

Create a Roadmap

This page offers a clear overview of Create a Roadmap. It helps you explore this topic and find a useful next step.

POST

https://vidbyte-backend.onrender.com/api/v1/roadmaps/create

Example request

bash

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"
  }'

Example response

JSON

{
  "success": true,
  "id": "rdm_Qj3Y5N0k2b",
  "message": "Roadmap created successfully",
  "data": {
    "modules": [{ "title": "API fundamentals", "resources": [{ "title": "Design a versioned contract", "type": "reading" }] }],
    "course_summary": "A phased roadmap for designing and shipping an API platform.",
    "course_outcomes": ["Ship a public API contract", "Understand auth and usage accounting"],
    "course_audio_script": "Module 1 introduces the contract, auth boundary, and usage model."
  },
  "token_stats": { "input_tokens": 611, "output_tokens": 941, "total_tokens": 1552 },
  "pricing": { "total_cost": 0.0241, "num_searches": 0 }
}

Parameter information

These are the public parameters for /api/v1/roadmaps/create. Path parameters and request-body fields are shown together so the page stays focused on the live request contract you actually send.

promptstringRequired

Describe the skill, domain, or curriculum outcome you want the roadmap to organize into a learning plan.