Quickstart

npm install @hawkings/sdk

pnpm add @hawkings/sdk

yarn add @hawkings/sdk

bun add @hawkings/sdk

composer require hawkings/sdk

import Hawkings from "@hawkings/sdk";

const hk = new Hawkings();

const course = await hk.courses.create({
  name: "Intro to Special Relativity",
  language: "en",
  hours: 12,
});

console.log(course.id);

$hk = new \Hawkings\Client();

$course = $hk->courses->create([
    'name' => 'Intro to Special Relativity',
    'language' => 'en',
    'hours' => 12,
]);

echo $course->id;

from hawkings import Hawkings

hk = Hawkings()

course = hk.courses.create(
    name="Intro to Special Relativity",
    language="en",
    hours=12,
)

print(course.id)

curl https://api.hawkings.education/v1/courses \
  -H "x-api-key: $HAWKINGS_API_KEY" \
  -H "X-Learning-Platform-Code: $HAWKINGS_PLATFORM_CODE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Intro to Special Relativity",
    "language": "en",
    "hours": 12
  }'

await hk.courses.generateSyllabus(course.id, {
  brief: "An introductory undergraduate course on special relativity, " +
         "ending with the equivalence of mass and energy.",
});

// Poll until ready (≈ 30s)
const ready = await hk.poll(() => hk.courses.retrieve(course.id), {
  until: c => c.status === "ready",
});

$hk->courses->generateSyllabus($course->id, [
    'brief' => 'An introductory undergraduate course on special relativity, '
             . 'ending with the equivalence of mass and energy.',
]);

// Poll until ready (≈ 30s)
$ready = $hk->poll(
    fn () => $hk->courses->retrieve($course->id),
    ['until' => fn ($c) => $c->status === 'ready'],
);

const full = await hk.courses.retrieve(course.id, {
  expand: ["cohorts", "cohorts.lessons", "cohorts.lessons.activities"],
});

$full = $hk->courses->retrieve($course->id, [
    'expand' => ['cohorts', 'cohorts.lessons', 'cohorts.lessons.activities'],
]);