Skip to content
WorkRoad home
REST API

Get a recording with its transcript

GET
/recordings/{recordingId}

The recording's transcript, one line per entry, and its summary, key terms and chapters when it has them. Write notes, flashcards or a practice test from the transcript with your own model, then save them with POST /notes, POST /sets or POST /tests/from-questions.

Required scopes: notes:view

Authorization

headerAuthorizationBearer <token>

Path Parameters

recordingId*string

Recording id from GET /notes/{noteId}/recordings.

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

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://workroad.app/api/v1/recordings/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'
Example Response
{  "data": {    "id": "5e4d3c2b-1a09-4f8e-9d7c-6b5a49382716",    "noteId": "2f1e0d9c-8b7a-4c6d-9e5f-4a3b2c1d0e9f",    "title": "Lecture 7: CPU scheduling",    "status": "finished",    "summaryStatus": "done",    "createdAt": "2026-01-15T09:30:00.000Z",    "transcript": [      "Today we look at how the scheduler picks the next process.",      "Round robin gives each process a fixed time slice, in turn."    ],    "summary": "How a CPU scheduler chooses the next process, with round robin as the main example.",    "keyTerms": [      {        "term": "Round robin",        "definition": "Each process runs for a fixed time slice, in turn."      }    ],    "chapters": [      {        "startMs": 0,        "title": "Scheduling",        "summary": "Why the CPU needs a scheduler."      }    ]  }}

Submit a practice test attempt POST

Ends the attempt and grades it. Multiple choice, true/false and fill-in answers are graded at once.

List a note's recordings GET

The lecture recordings on a note, newest first, without their transcripts.