GET /v2/courses/{course_id}/study-guide

Get the study guide

Every completed course gets a study guide generated automatically as part of course creation — a condensed, exam-ready set of definitions, key takeaways, and worked examples. This endpoint returns that artifact.

Request

Headers

Header	Required	Notes
`X-API-Key`	yes
`X-External-User-Id`	yes (or `X-User-Id`)	Must own the course

Path parameters

course_id string (UUID) required

The course to fetch the guide for.

Returns

{
  "study_guide": {
    "title": "Photosynthesis: From Light to Life — Study Guide",
    "sections": [
      {
        "heading": "Core definitions",
        "items": [
          { "term": "Photon", "definition": "A discrete quantum of light energy…" },
          { "term": "Chlorophyll-a", "definition": "The primary pigment absorbing 430/662 nm light…" }
        ]
      },
      {
        "heading": "Key takeaways",
        "bullets": [
          "Light reactions occur in the thylakoid membrane…",
          "Calvin cycle reduces CO₂ to G3P…"
        ]
      },
      {
        "heading": "Worked example",
        "body": "Given a leaf absorbing 600 µmol photons / m² / s…"
      }
    ]
  }
}

If a study guide hasn’t been generated yet (e.g. the course is still generating):

{
  "study_guide": null,
  "message": "Study guide not yet available; course is still generating."
}

Study guides are immutable — they’re built once at course-completion time. There’s no way to regenerate. If you need a fresh perspective on the same material, use Generate exam or Flashcards instead.

Errors

404 — Course not found for this user.

{ "study_guide": { "title": "Photosynthesis — Study Guide", "sections": [ { "heading": "Core definitions", "items": [ { "term": "Photon", "definition": "A discrete quantum of light energy…" }, { "term": "Chlorophyll-a", "definition": "The primary pigment absorbing 430/662 nm light…" } ] } ] } }