Skip to main content

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.

Example
{
  "id": "crs_01HX9N5AB3M0R6P02RT9QZSF8K",
  "object": "course",
  "name": "Intro to Special Relativity",
  "description": "An undergraduate intro course covering frames, the postulates, time dilation, length contraction, and mass-energy equivalence.",
  "language": "en",
  "duration": { "hours": 12, "hours_generated": 11.5 },
  "length": { "words_per_hour": 2400, "words_generated": 27600 },
  "status": "ready",
  "ai": {
    "instructions": "Use SI units. Prefer derivations over hand-waving.",
    "evaluator": { "model": "claude-sonnet-4-6" }
  },
  "tutor": {
    "enabled": true,
    "name": "Dr. Hawking",
    "voice": "encouraging-academic"
  },
  "image": "https://cdn.hawkings.education/i/crs_01HX9.../cover.webp",
  "metadata": { "internal_code": "PHYS-201" },
  "cohorts": ["coh_01HX9N5AB3..."],
  "created_at": "2026-05-10T12:00:00Z",
  "updated_at": "2026-05-10T12:34:56Z"
}

​
Attributes

​
id
string
Unique identifier. Prefix crs_.
​
object
string
Always "course".
​
name
string
Human-readable course name.
​
description
string | null
Long-form description. Used as the brief for syllabus generation when no explicit brief is passed.
​
language
string
BCP-47 language code: "en", "es", "pt-BR", etc.
​
duration
object
​
length
object
​
status
enum
One of draft, pending, ready, error. The lifecycle:
  • draft — created, no syllabus yet.
  • pending — syllabus generation is running.
  • ready — syllabus and content generated.
  • error — generation failed; check error.
​
ai
object
​
tutor
object
​
image
string | null
Cover image URL. Generate with courses.generateImage() or upload via update.
​
metadata
object
Free-form key-value store, max 50 keys, 500 chars per value. Always returned, never indexed.
​
cohorts
string[] | Cohort[]
IDs by default; expand "cohorts" to inline.
​
created_at
string
​
updated_at
string