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_KEYRoadmaps
GET
/v1/roadmapsReturns 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/generateGenerates a new roadmap based on the provided topic.
Body
{
"topic": "Machine Learning",
"level": "beginner",
"language": "en"
}