Skip to main content
POST
/
v1
/
scorm
Create a SCORM package
curl --request POST \
  --url https://api.example.com/v1/scorm \
  --header 'Content-Type: application/json' \
  --data '
{
  "cohort_id": "<string>",
  "version": {},
  "runtime_base_url": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.hawkings.education/llms.txt

Use this file to discover all available pages before exploring further.

Body

cohort_id
string
required
version
enum
default:"2004"
1.2 | 2004.
runtime_base_url
string
Override the runtime’s API target. Defaults to https://api.hawkings.education.

Examples

const pkg = await hk.scorm.create({ cohort_id: "coh_123", version: "2004" });

const ready = await hk.poll(
  () => hk.scorm.retrieve(pkg.id),
  { until: p => p.status === "ready" },
);

Returns

A ScormPackage in status: "pending".