Embed Learn Card Json

Public JSON sibling to /embed/learn/<module_id>.

Path: GET /api/v1/embed/learn/<module_id>?ref=<host> Same projection as the HTML card (title + hook + section_count + has_quiz + parent path + deep_link), same shared rate limit, module-id validation, and ref hostname-shape gate.

get/api/v1/embed/learn/{module_id}

Request

  • Base URL: https://www.oxfordledge.com (the document declares no server; this is the origin it was published from)
  • URL: https://www.oxfordledge.com/api/v1/embed/learn/{module_id}
  • Auth: none declared

Path parameters

module_idstring required

Query parameters

refstring nullable

Response

Successful Response

module_idstring required

Canonical LEARN module id (case-sensitive).

titlestring required

Module title.

hookstring nullable

One-line hook: the module's metaDescription, else the first text-section excerpt (~160 chars). Null when neither exists.

section_countinteger required

Number of sections (lessons) in the module.

has_quizboolean required

True when the module carries a quiz.

path_idstring required

Parent learning-path id.

path_titlestring nullable

Parent learning-path title.

deep_linkstring required

Canonical CTA URL — the per-module SSR page (/learn/<path>/<slug>/) with ?ref attribution when provided.

refstring nullable

Normalized embedding-host attribution (DNS-shape validated). Null when no ref param.

Changes

No recorded changes to this operation across all 1 revision of this API.