GET /
Get a Roadmap
Fetch one roadmap by encrypted public id. This route is the standard way to rehydrate a stored roadmap inside your product after creation.
GET
https://api.vidbyte.pro/ api/ v1/ roadmaps/ get/ {encrypted_id}
Example request
bash
curl https://api.vidbyte.pro/api/v1/roadmaps/get/3f2504e0-4f89-41d3-9a0c-0305e82c3301 \
-H "x-api-key: vb_live_your_api_key"Example response
JSON
{
"success": true,
"encrypted_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"message": "Roadmap retrieved successfully.",
"data": {
"encrypted_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"title": "",
"prompt": "Build a backend API platform roadmap",
"modules": [{ "title": "API fundamentals", "resources": [{ "title": "Design a versioned contract", "type": "reading" }] }]
},
"object": "roadmap"
}Parameter information
These are the public parameters for /api/v1/roadmaps/get/{encrypted_id}. Path, query, and request-body parameters are shown together so the page stays focused on the live request contract you actually send.
encrypted_idstringRequired
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.