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

/api/v1/roadmaps/get/{encrypted_id}

Example request

curl https://api.vidbyte.ai/api/v1/roadmaps/get/rdm_Qj3Y5N0k2b \
  -H "Authorization: Bearer vb_live_your_api_key"

Example response

{
  "success": true,
  "id": "rdm_Qj3Y5N0k2b",
  "data": {
    "title": "Backend API platform roadmap",
    "prompt": "Build a backend API platform roadmap",
    "modules": [{ "title": "API fundamentals", "resources": [{ "title": "Design a versioned contract", "type": "reading" }] }]
  }
}

Parameter information

These are the public parameters for /api/v1/roadmaps/get/{encrypted_id}. Path parameters and request-body fields 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.