The LearnHouse API, typed

Runs everywhere JavaScript does

Quickstart

npm install @learnhouse/sdk

import { createClient } from '@learnhouse/sdk'

// Dashboard → Developers → API Access → Create Token. It starts with lh_.
const lh = createClient({
  baseUrl: process.env.LEARNHOUSE_URL!,   // your instance, without /api/v1
  token: process.env.LEARNHOUSE_TOKEN!,
})

import { createClient } from '@learnhouse/sdk'

// On the instance's own domain, the learner's session cookie is enough.
const lh = createClient({
  baseUrl: 'https://learn.your-school.com',
  credentials: 'include',
})

const org = await lh.orgs.get('your-school')
const courses = await lh.courses.list('your-school', { limit: 12 })
const course = await lh.courses.getMeta(courses[0].course_uuid!)   // chapters and activities

for (const chapter of course.chapters ?? []) {
  console.log(chapter.name, chapter.activities?.map((a) => a.name))
}

Responses are typed from the API's schema: course.chapters autocompletes, and a typo in a field name is a compile error, not a runtime surprise.

Server or browser?

More in Authentication.

Everything else

The resources (orgs, courses, activities, trail…) cover the common reads and progress. For anything else, call any endpoint by its path, still fully typed:

const meta = await lh.GET('/api/v1/courses/{course_uuid}/meta', {
  params: { path: { course_uuid: 'course_…' }, query: { slim: true } },
})

See Typed requests & errors, and the API reference for every endpoint.

Pairs with the React component

@learnhouse/react uses this SDK. Fetch on your server with an API token, render in the browser:

const activity = await lh.activities.get('activity_…')
return <LearnHouseActivity activity={activity} courseId="course_…" baseUrl={LEARNHOUSE_URL} />