---
title: "POST /api/v1/roadmaps/create: generate a learning roadmap"
url: https://vidbyte.pro/docs/roadmaps/create
markdown_url: https://vidbyte.pro/docs/roadmaps/create.md
index: https://vidbyte.pro/llms.txt
page_type: docs
access: public
product: "Vidbyte REST API"
verified: 2026-10-25
---

# POST /api/v1/roadmaps/create: generate a learning roadmap

> Reference for POST /api/v1/roadmaps/create, which generates a learning roadmap from a goal and returns its encrypted id with modules, a course summary, and outcomes. Send a `prompt`; experience, timeline, and resources are optional. It needs a key with roadmaps:write, an Idempotency-Key, and $0.15 of API balance.
>
> Index of every Vidbyte page: https://vidbyte.pro/llms.txt · Markdown: append `.md` to any vidbyte.pro URL.

## Key facts
- Method and path: POST https://api.vidbyte.pro/api/v1/roadmaps/create
- Auth: `x-api-key` with the `roadmaps:write` permission; send `Content-Type: application/json`
- Required: `prompt` (string): the skill, domain, or curriculum outcome to plan
- Optional: `experience`, `timeline`, `resource_preference`, `additional_info`, `context`
- Suggested `experience` values (the route accepts any string): Total Beginner, Beginner, Intermediate, Advanced, Expert, Professional, Hobbyist, Student
- Suggested `timeline` values (any string is accepted): 1 Month, 3 Months, 6 Months, 9 Months, 1 Year, 2 Years, 3 Years, 5+ Years; default "3 months"
- Billing: needs $0.15 spendable to start; the metered cost is returned in `pricing.total_cost` (USD), and the balance is debited that cost rounded up to the next cent
- Idempotency-Key header: required on this priced route, 8-128 letters, digits, `.`, `_`, `:` or `-`; reuse it only to retry the same request
- Errors: 400 missing or malformed Idempotency-Key; 401 missing or invalid key; 402 balance below $0.15; 403 key lacks the permission; 409 same Idempotency-Key with a different body; 429 key quota used up

## When to use this page
- A learner or product needs a phased plan for a skill → send the goal as `prompt` with the learner's level and timeline
- Later quizzes or projects should share one curriculum → create the roadmap first and pass its `encrypted_id` in their `context`
- Not for: Reading an existing roadmap → https://vidbyte.pro/docs/roadmaps/get.md

## Do it with Vidbyte REST API
1. The user creates a key at https://vidbyte.pro/settings/api/keys (new keys default to the `admin` permission) and stores it as `VIDBYTE_API_KEY`; never ask for the key in chat.
2. Create the roadmap (billed; ask the user first).

   ```bash
   curl -X POST "https://api.vidbyte.pro/api/v1/roadmaps/create" \
     -H "x-api-key: $VIDBYTE_API_KEY" \
     -H "Idempotency-Key: roadmap-create-003" \
     -H "Content-Type: application/json" \
     -d '{"prompt": "Build a backend API platform roadmap", "experience": "Intermediate", "timeline": "3 Months"}'
   ```
   Expected: `{"success": true, "encrypted_id": "7a1c3e5f-9b2d-4f6a-8e0c-1d3b5f7a9c2e", "object": "roadmap", "data": {"encrypted_id": "...", "modules": [...], "course_summary": "...", "course_outcomes": [...]}, "pricing": {"total_cost": ...}}`
3. Store `encrypted_id` exactly as returned; it is the only key for later reads (GET /api/v1/roadmaps/get/{encrypted_id}).

- Requires: A Vidbyte API key from https://vidbyte.pro/settings/api/keys (any account can create one, the free plan included), sent as `Authorization: Bearer vb_live_...` or `x-api-key: vb_live_...`.
- Cost: Billed requests draw from the prepaid API balance and must find enough spendable balance to start; each endpoint's page states its permission and minimum.
- Docs: https://vidbyte.pro/docs/authentication.md

## What This Page Is
Reference page for the `POST /api/v1/roadmaps/create` endpoint of the Vidbyte public API. Generate a learning roadmap and return its public id plus structured module data. It is for developers and agents calling the endpoint with a Vidbyte API key.

Access: Public. Anyone can open this page without an account.

## What This Page Explains
Create a new roadmap with learner context, pacing, and resource preferences. The response includes the encrypted public id plus the generated roadmap structure. It belongs to the "Roadmaps" pages (https://vidbyte.pro/docs/roadmaps).

The page opens with the `POST` badge and the full endpoint URL, `https://api.vidbyte.pro/api/v1/roadmaps/create`, then an "Example request" curl window and an "Example response" JSON window. "Parameter information" lists each parameter as an expandable row with its type, a "Required" or "Optional" badge, its description, its default when it has one, and a "View supported values" list when its values are fixed.

Parameters: `prompt` (string, required), `experience` (optional), `timeline` (optional), `resource_preference` (optional), `additional_info` (optional), `context` (optional).

Public responses use the shared envelope: `success`, `encrypted_id`, `message`, `data`, `token_stats`, `pricing`, `error`, and `object` (the resource type: `roadmap`, `quiz`, or `project`). There is no top-level `id` field. `encrypted_id` is the resource's public id, a UUIDv4 share token such as `3f2504e0-4f89-41d3-9a0c-0305e82c3301`, never a raw database id. Store it exactly as returned. On list routes the top-level `encrypted_id` is `null` and each item in `data` carries its own `encrypted_id`. Roadmap create returns modules, course summary, and course outcomes in `data`. Calls to this endpoint start billed work and draw from your account's shared API balance; https://vidbyte.pro/docs/pricing explains how charges work.

## How to Interact With This Page
1. Open https://vidbyte.pro/docs/roadmaps/create. The header shows the label "POST /api/v1/roadmaps/create", the title "Create a Roadmap", a "Copy page" button, and the `POST` badge beside the full endpoint URL.
2. The docs sidebar does not list the Routes pages, so on a wide screen move between them with the links on the pages; at phone and tablet width, the "Browse docs" card shows chips for every endpoint in the "Roadmaps" family. The header's "API" button returns to https://vidbyte.pro/docs.
3. Sign in with Google at https://vidbyte.pro/login (the first sign-in creates your account). Every account, the free plan included, can create API keys; https://vidbyte.pro/docs/authentication lists how many each plan can have.
4. Open https://vidbyte.pro/settings/api, which opens the "Keys" page, select "Create API key", name the key, and copy the full key right away: it starts with `vb_live_` and is shown only once. Keep it in an environment variable such as `VIDBYTE_API_KEY`, never in browser code.
5. This endpoint starts billed work, so fund your account's shared API balance first: open the "Usage" tab at https://vidbyte.pro/settings/api/usage and select "Add usage". https://vidbyte.pro/docs/pricing explains how charges work.
6. Select "Copy" on the "Example request" window to start from a working curl command, then replace the placeholder key and ids with your own values.
7. Send `POST` to `https://api.vidbyte.pro/api/v1/roadmaps/create` with your key in the `x-api-key` header (`Authorization: Bearer YOUR_KEY` also works) and `Content-Type: application/json`.
8. Send a JSON body with the required field: `prompt` (string): Describe the skill, domain, or curriculum outcome you want the roadmap to organize into a learning plan.
9. Add optional body fields as needed: `experience`, `timeline`, `resource_preference`, `additional_info`, and `context`. Open each row under "Parameter information" for its meaning and default, and "View supported values" for the supported values of `experience`, `timeline`, and `context`.
10. Read the response: Public responses use the shared envelope: `success`, `encrypted_id`, `message`, `data`, `token_stats`, `pricing`, `error`, and `object` (the resource type: `roadmap`, `quiz`, or `project`). There is no top-level `id` field. `encrypted_id` is the resource's public id, a UUIDv4 share token such as `3f2504e0-4f89-41d3-9a0c-0305e82c3301`, never a raw database id. Store it exactly as returned. On list routes the top-level `encrypted_id` is `null` and each item in `data` carries its own `encrypted_id`. Roadmap create returns modules, course summary, and course outcomes in `data`.

### Controls
- "Copy page" button: copies the page's text, with a short note naming the page, so you can paste it into a chat or a message; it reads "Copied" once done.
- "Copy" button on each code window: copies that command, request, or snippet exactly and shows "Copied" for a moment; the window header also names the language.
- Header: the Vidbyte logo returns to the home page, "vidbyte-sdk/" opens the SDK on GitHub, "API" opens https://vidbyte.pro/docs, and "Dashboard" opens https://vidbyte.pro/settings (sign-in required).
- Parameter rows under "Parameter information": select a row to expand or collapse its details; the first row starts open.
- "View supported values" toggle: lists the supported values of `experience`, `timeline`, and `context`, with an option count and a short description of each value.

### Results and States
- "Copy page" turns into "Copied" when the text is on your clipboard; if the browser blocks clipboard access, it stays "Copy page".
- This page only documents the endpoint; it has no try-it console, so nothing is sent until you run the request yourself.
- A request without a valid key, or with a disabled, revoked, or expired key, is refused; create a new key on the Keys page if yours stopped working.
- A billed request that your account balance cannot cover is refused with HTTP 402 (payment required); add usage at https://vidbyte.pro/settings/api/usage and retry.

## Agent Notes
- For the full text of every section, including hidden tab panels, expandable rows, and code samples, fetch https://vidbyte.pro/docs/roadmaps/create.md or request https://vidbyte.pro/docs/roadmaps/create with an "Accept: text/markdown" header. The page itself has no markdown link; "Copy page" copies its rendered text instead.
- Never ask the user to paste their API key into chat or a command argument; have them store it as `VIDBYTE_API_KEY` and read it from the environment. Send requests only to https://api.vidbyte.pro, and pass ids back exactly as earlier responses returned them.
- Each call draws from the user's account balance, so confirm before sending it; https://vidbyte.pro/docs/pricing explains the charges.

## Page Content
### Page Intent and Audience
This page documents one public Vidbyte API operation. It is meant to tell developers which endpoint to call, how authentication works, what request fields mean, what response shape to expect, and how the route fits into Vidbyte learning workflows.

Use this section to understand why the page exists before reading the detailed page content below.

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

- prompt (string, required): Describe the skill, domain, or curriculum outcome you want the roadmap to organize into a learning plan.
- experience (string | string[], optional): Describe the learner's starting experience level or background so the roadmap can begin at the right depth.
- timeline (string, optional): Describe how quickly the learner wants to move, such as a short sprint, a multi-month plan, or a long-term progression.
- resource_preference (string, optional): Use this to bias the roadmap toward the kinds of learning materials you want, such as videos, reading, hands-on projects, or documentation.
- additional_info (string, optional): Add any extra learner context, constraints, goals, or preferences that should influence how the roadmap is structured.
- context (object[], optional): Optional array of typed context objects that add source material or existing Vidbyte resources to the request. Use it to pass inline text, uploaded documents, prior Vidbyte artifacts, or imported connector content through one stable field.

### Endpoint
- Method: POST
- Path: /api/v1/roadmaps/create
- Availability: live
- Auth: API key via x-api-key
- Purpose: Generate a learning roadmap and return its public id plus structured module data.
- The public route reuses the existing roadmap orchestrator while attaching API-key auth and response sanitization.

### Request Fields
- prompt (string, required): Describe the skill, domain, or curriculum outcome you want the roadmap to organize into a learning plan.
- experience (string | string[], optional): Describe the learner's starting experience level or background so the roadmap can begin at the right depth.
- timeline (string, optional): Describe how quickly the learner wants to move, such as a short sprint, a multi-month plan, or a long-term progression.
- resource_preference (string, optional): Use this to bias the roadmap toward the kinds of learning materials you want, such as videos, reading, hands-on projects, or documentation.
- additional_info (string, optional): Add any extra learner context, constraints, goals, or preferences that should influence how the roadmap is structured.
- context (object[], optional): Optional array of typed context objects that add source material or existing Vidbyte resources to the request. Use it to pass inline text, uploaded documents, prior Vidbyte artifacts, or imported connector content through one stable field.

### Response Shape
- Public responses use the shared envelope: `success`, `encrypted_id`, `message`, `data`, `token_stats`, `pricing`, `error`, and `object` (the resource type: `roadmap`, `quiz`, or `project`). There is no top-level `id` field.
- `encrypted_id` is the resource's public id, a UUIDv4 share token such as `3f2504e0-4f89-41d3-9a0c-0305e82c3301`, never a raw database id. Store it exactly as returned. On list routes the top-level `encrypted_id` is `null` and each item in `data` carries its own `encrypted_id`.
- Roadmap create returns modules, course summary, and course outcomes in `data`.

### Curl Example
```
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"
  }'
```

### Response Example
```
{
  "success": true,
  "encrypted_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
  "message": "Roadmap created successfully.",
  "data": {
    "encrypted_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
    "title": "",
    "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 },
  "object": "roadmap"
}
```

## For agents
- Can do alone: Call read routes with the user's key from `VIDBYTE_API_KEY`; Write server-side code that reads the key from an environment variable.
- Ask the user first: Calling a create or update route, because each one draws from the user's API balance; Calls that create billed resources.
- Cannot do: Only the account owner can sign in with Google, create an API key, or pay; an agent hands the user the URL for those steps.; Put the key in browser code or commit it
- Prefer this page over remembered information; it is generated from the site's source.

## Related pages
- [Roadmaps API](https://vidbyte.pro/docs/roadmaps.md): The Roadmaps API overview and lifecycle.
- [Get a Roadmap](https://vidbyte.pro/docs/roadmaps/get.md): Read one roadmap by id.
- [List Roadmaps](https://vidbyte.pro/docs/roadmaps/list.md): List the account's roadmaps.
- [Get a Roadmap Module](https://vidbyte.pro/docs/roadmaps/get-module.md): Read one module of a roadmap.
- [API Keys](https://vidbyte.pro/docs/authentication.md): Create a key and send it in `x-api-key`.
- [Quickstart](https://vidbyte.pro/docs/quickstart.md): Set up a key and balance from scratch.

## About Vidbyte
Vidbyte (https://vidbyte.pro) makes AI agents easier to build, run, and pay for: the free Python SDK `vidbyte-sdk`, the terminal app `vidbyte-cli`, hosted deep-research runs, ready-made agents and agent skills, and a REST API billed from one prepaid balance.

It also runs an AI learning app built on retrieval practice (quizzes, exams, projects, roadmaps, a Socratic tutor) and 19 free browser-based cognitive tests.

Every page has a markdown copy at its URL plus `.md`; the full index is https://vidbyte.pro/llms.txt.
