---
title: "GET /api/v1/roadmaps/get/{encrypted_id}/{module_number}: read one roadmap module"
url: https://vidbyte.pro/docs/roadmaps/get-module
markdown_url: https://vidbyte.pro/docs/roadmaps/get-module.md
index: https://vidbyte.pro/llms.txt
page_type: docs
access: public
product: "Vidbyte REST API"
verified: 2026-10-25
---

# GET /api/v1/roadmaps/get/{encrypted_id}/{module_number}: read one roadmap module

> Reference for GET /api/v1/roadmaps/get/{encrypted_id}/{module_number}, which returns one module of a roadmap by the roadmap's encrypted id and a zero-based module number. It needs roadmaps:read, is not billed, and returns 404 when the number is past the last module.
>
> Index of every Vidbyte page: https://vidbyte.pro/llms.txt · Markdown: append `.md` to any vidbyte.pro URL.

## Key facts
- Method and path: GET https://api.vidbyte.pro/api/v1/roadmaps/get/{encrypted_id}/{module_number}
- Auth: `x-api-key` with the `roadmaps:read` permission
- Path parameters: `encrypted_id` (string) and `module_number` (integer, zero-based: 0 is the first module)
- Returns: `data.module` with its title and resources, plus `data.module_number`, `data.encrypted_id`, and the roadmap's `title` and `prompt`
- 404: the roadmap is not on this account, or `module_number` is negative or past the last module
- Billing: reads are not billed; every route is rate limited per API key

## When to use this page
- A learner is on one module and the app needs only that module's resources → call this route
- An agent is generating a quiz for one module → fetch the module, then pass it as quiz content
- Not for: The whole 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. Fetch the first module (number 0).

   ```bash
   curl "https://api.vidbyte.pro/api/v1/roadmaps/get/7a1c3e5f-9b2d-4f6a-8e0c-1d3b5f7a9c2e/0" \
     -H "x-api-key: $VIDBYTE_API_KEY"
   ```
   Expected: `{"success": true, "encrypted_id": "7a1c3e5f-9b2d-4f6a-8e0c-1d3b5f7a9c2e", "object": "roadmap", "data": {"encrypted_id": "7a1c3e5f-9b2d-4f6a-8e0c-1d3b5f7a9c2e", "module_number": 0, "module": {"title": "...", "resources": [...]}, "title": "...", "prompt": "..."}}`

- 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 `GET /api/v1/roadmaps/get/{encrypted_id}/{module_number}` endpoint of the Vidbyte public API. Fetch a specific roadmap module by public roadmap id and module index. 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
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. It belongs to the "Roadmaps" pages (https://vidbyte.pro/docs/roadmaps).

The page opens with the `GET` badge and the full endpoint URL, `https://api.vidbyte.pro/api/v1/roadmaps/get/{encrypted_id}/{module_number}`, 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: `{encrypted_id}` in the path, `{module_number}` in the path.

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`. This read endpoint does not draw from your API balance.

## How to Interact With This Page
1. Open https://vidbyte.pro/docs/roadmaps/get-module. The header shows the label "GET /api/v1/roadmaps/get/{encrypted_id}/{module_number}", the title "Get a Roadmap Module", a "Copy page" button, and the `GET` 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. 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.
6. Send `GET` to `https://api.vidbyte.pro/api/v1/roadmaps/get/{encrypted_id}/{module_number}` with your key in the `x-api-key` header (`Authorization: Bearer YOUR_KEY` also works).
7. Fill the path: replace `{encrypted_id}` with the public encrypted identifier previously returned by a create or list route; replace `{module_number}` with the zero-based module position you want to fetch from the roadmap, where `0` is the first module.
8. No query parameters are needed beyond the path.
9. 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`.

### 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.

### 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.

## Agent Notes
- For the full text of every section, including hidden tab panels, expandable rows, and code samples, fetch https://vidbyte.pro/docs/roadmaps/get-module.md or request https://vidbyte.pro/docs/roadmaps/get-module 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.

## 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/get/{encrypted_id}/{module_number}. Path, query, and request-body parameters are shown together so the page stays focused on the live request contract you actually send.

- encrypted_id (string, required): The public encrypted identifier previously returned by a create or list route. Pass it back exactly as returned when you want to fetch that resource again.
- module_number (integer, required): The zero-based module position you want to fetch from the roadmap, where `0` is the first module.

### Endpoint
- Method: GET
- Path: /api/v1/roadmaps/get/{encrypted_id}/{module_number}
- Availability: live
- Auth: API key via x-api-key
- Purpose: Fetch a specific roadmap module by public roadmap id and module index.
- Helpful when you want resource-level views without pulling the entire roadmap repeatedly.

### Request Fields
- encrypted_id (string, required): The public encrypted identifier previously returned by a create or list route. Pass it back exactly as returned when you want to fetch that resource again.
- module_number (integer, required): The zero-based module position you want to fetch from the roadmap, where `0` is the first module.

### 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`.

### Curl Example
```
curl https://api.vidbyte.pro/api/v1/roadmaps/get/3f2504e0-4f89-41d3-9a0c-0305e82c3301/0 \
  -H "x-api-key: vb_live_your_api_key"
```

### Response Example
```
{
  "success": true,
  "encrypted_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
  "message": "Roadmap retrieved successfully.",
  "data": {
    "encrypted_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
    "module_number": 0,
    "module": { "title": "API fundamentals", "resources": [{ "title": "Design a versioned contract", "type": "reading" }] },
    "title": "",
    "prompt": "Build a backend API platform roadmap"
  },
  "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.
- [Create a Roadmap](https://vidbyte.pro/docs/roadmaps/create.md): Generate a roadmap.
- [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.
- [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.
