Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
How to walk lists and how to fetch related objects in one round-trip.
{
"data": [ /* up to `limit` records */ ],
"has_more": true,
"next_cursor": "crs_01HX9..."
}
let cursor: string | undefined;
do {
const page = await hk.courses.list({ limit: 100, starting_after: cursor });
for (const c of page.data) console.log(c.id);
cursor = page.has_more ? page.next_cursor : undefined;
} while (cursor);
$cursor = null;
do {
$page = $hk->courses->list(['limit' => 100, 'starting_after' => $cursor]);
foreach ($page->data as $c) {
echo $c->id . "\n";
}
$cursor = $page->has_more ? $page->next_cursor : null;
} while ($cursor);
for await (const course of hk.courses.list({ limit: 100 })) {
console.log(course.id);
}
foreach ($hk->courses->list(['limit' => 100])->autoPagingIterator() as $course) {
echo $course->id . "\n";
}
expand to inline related resources in
the same response, à la SQL JOIN. This avoids the N+1 problem.
const course = await hk.courses.retrieve("crs_123", {
expand: ["cohorts", "cohorts.lessons", "cohorts.lessons.activities"],
});
// course.cohorts[0].lessons[0].activities[0] is a fully-hydrated Activity
$course = $hk->courses->retrieve('crs_123', [
'expand' => ['cohorts', 'cohorts.lessons', 'cohorts.lessons.activities'],
]);
// $course->cohorts[0]->lessons[0]->activities[0] is a fully-hydrated Activity
400 invalid_request_error with
code: "expand_too_deep".
| Resource | Expandable paths |
|---|---|
Course | cohorts, cohorts.units, cohorts.lessons, cohorts.lessons.activities |
Cohort | course, units, lessons, students, teachers |
Unit | lessons, lessons.activities |
Lesson | unit, activities, content, assignment |
Activity | questions, lesson |
Assignment | lesson, submissions |
Submission | assignment, student |
User | cohorts, courses |
hk.cohorts.list({ course_id: "crs_123", status: "active" });
hk.lessons.list({ cohort_id: "coh_123", type: "video" });
hk.submissions.list({ assignment_id: "asg_123", student_id: "usr_123" });
$hk->cohorts->list(['course_id' => 'crs_123', 'status' => 'active']);
$hk->lessons->list(['cohort_id' => 'coh_123', 'type' => 'video']);
$hk->submissions->list(['assignment_id' => 'asg_123', 'student_id' => 'usr_123']);