Skip to main content
Example

Attributes

string
Unique identifier. Prefix crs_.
string
Always "course".
string
Human-readable course name.
string | null
Long-form description. Used as the brief for syllabus generation when no explicit brief is passed.
string
BCP-47 language code: "en", "es", "pt-BR", etc.
object
object
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.
object
object
string | null
Cover image URL. Generate with courses.generateImage() or upload via update.
object
Free-form key-value store, max 50 keys, 500 chars per value. Always returned, never indexed.
string[] | Cohort[]
IDs by default; expand "cohorts" to inline.
string
string