API Endpoints

The RouteRadiant API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

Authenticate your API requests using your API key. If you do not include your key when making an API request, or use one that is incorrect or disabled, RouteRadiant returns an error.

Header
Authorization: Bearer YOUR_API_KEY

Roadmaps

GET/v1/roadmaps

Returns a list of roadmaps belonging to the authenticated user.

Parameters

  • limitOptional. A limit on the number of objects to be returned. Limit can range between 1 and 100.
  • pageOptional. The page number to return.
POST/v1/roadmaps/generate

Generates a new roadmap based on the provided topic.

Body

{ "topic": "Machine Learning", "level": "beginner", "language": "en" }

Courses

POST/v1/courses/generate

Generates a focused course for a single topic. Accepts the same shape as roadmap generation plus an optional syllabus hint to steer the outline.

{ "topic": "React Hooks", "level": "intermediate", "language": "en" }
GET/v1/courses/:id

Returns the full course document for the given id, including all modules and lessons. Omit an enrollment token to read only public courses.

Pagination

List endpoints return a page of results plus a has_more flag. Combine page andlimit to walk through large collections; limit accepts 1–100 and defaults to 20. When has_more is false, you have reached the final page.

Errors

Errors return a JSON body with an error object containing a type and a human-readable message. Common status codes:

  • 400 — malformed request or missing required field.
  • 401 — missing or invalid API key.
  • 403 — key lacks permission for the resource.
  • 404 — resource does not exist or is private.
  • 429 — rate limit exceeded; retry after Retry-After.

Best Practices

Generation endpoints can take several seconds, so call them server-side and poll or await the result rather than timing out a client request. Cache list responses for the roadmap and course indexes you render most often, and always pass an explicit language so content matches your users. Keys should be stored server-side and rotated on a schedule — see theAuthentication guide.