Skip to main content

API Reference

The Tutor Nexus API is built on Cloudflare Workers with Hono and follows OpenAPI 3.0 specifications.

Base URL​

EnvironmentURL
Productionhttps://api.tutor-nexus.com
Staginghttps://staging.api.tutor-nexus.com
Localhttp://localhost:8787

Authentication​

All API requests require authentication via Lucia Auth session cookie or Bearer token.

# Session cookie (browser)
curl -H "Cookie: lucia_session=..." https://api.tutor-nexus.com/api/v1/sessions

# Bearer token (CLI)
curl -H "Authorization: Bearer <token>" https://api.tutor-nexus.com/api/v1/sessions

Rate Limits​

TierRequests/DayRequests/Minute
Anonymous101
Free10010
Paid50060
BYOKUnlimited100

API Versioning​

Current version: v1

API versions are URL-prefixed: /api/v1/

Endpoints​

EndpointDescription
SessionsCreate and manage tutoring sessions
CoursesBrowse course outlines and instructors
TransfersResolve transfer credit rules
UsersUser profiles and settings

OpenAPI Documentation​

Interactive API documentation available at:

  • Swagger UI: https://api.tutor-nexus.com/docs
  • ReDoc: https://api.tutor-nexus.com/redoc

SDKs​

Official and community SDKs for easier integration:

LanguagePackagePurpose
TypeScript@tutor-nexus/sdkPrimary SDK for web/Node.js apps
Pythontutor-nexus-pyData science and scripting
Gogithub.com/tutornexus/mcpMCP server for IDE integration

SDKs are auto-generated from the OpenAPI spec at build time.

Error Handling​

All errors follow RFC 7807 Problem Details:

{
  "type": "https://api.tutor-nexus.com/errors/validation",
  "title": "Validation Error",
  "status": 400,
  "detail": "Invalid course ID format",
  "instance": "/api/v1/courses/cmpt-120",
  "errors": [
    {
      "field": "courseId",
      "message": "Must match pattern: ^[A-Z]{3,4} \\d{3}$"
    }
  ]
}

Quick Reference​

import { TutorNexus } from '@tutor-nexus/sdk';

const client = new TutorNexus({
  apiKey: process.env.TUTOR_NEXUS_API_KEY,
});

// List sessions
const sessions = await client.sessions.list({
  limit: 10,
  status: 'active',
});

// Get a course
const course = await client.courses.get('CMPT 120');

// Resolve transfer
const transfer = await client.transfers.resolve({
  sourceCourse: 'CMPT 120',
  sourceInstitution: 'sfu',
  targetInstitution: 'ubc',
});

See Also​