Get a lesson transcript

GET/v1/learn/lessons/{lessonId}/transcript

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Path Parameters

lessonId*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

Query Parameters

format?string

Default text (text/plain body, not JSON).

Value in"text" | "json" | "srt" | "vtt"

Response Body

`application/json`

cURL

curl -X GET "https://example.com/learn/lessons/497f6eca-6276-4993-bfeb-53cbbbba6f08/transcript"

{
  "success": true,
  "data": {
    "lessonId": "c3fd050f-2b0e-4915-9bd6-609374616009",
    "lessonTitle": "string",
    "courseId": "a6aaec24-4fe5-49f2-8b74-509d2f931acc",
    "courseTitle": "string",
    "language": "string",
    "source": "string",
    "text": "string",
    "cues": [
      {
        "startSec": 0,
        "endSec": 0,
        "text": "string"
      }
    ]
  }
}

{
  "error": "unauthorized"
}

{
  "success": false,
  "error": "API key lacks write permission"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

Authorization

Path Parameters

Query Parameters

Response Body

200text/plain

401application/json

403application/json

404application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`