The first call starts a background job that transcribes the recording and then scores it. How long it takes depends on the length of the recording. The
wait_for helper below polls until the result arrives.Set up
You need an access token. If you don’t have one, follow the Quickstart. You also need a rubric with criteria on it, because its criteria become the categories ClassTrack scores. See Create a rubric.Step 1: Start the analysis
Upload the recording to storage of your own first, then send its link with the class details. The link must start withhttps://, and its path must end with .mp3.
What you get back
What you get back
200, not 201, and the field is message, not msg. Save id: it is the only way to read the result.Step 2: Get the analysis
Poll the analysis ID until the result arrives.What you get back
What you get back
Trimmed to one rubric criterion and one insight. A real response has one
rubric_evaluation entry per criterion in your rubric.extracted_transcript is the recognized speech as one string, in lexical form, so it has no punctuation or capitalization.Good to know
Limits
Limits
Use webhooks instead of polling
Use webhooks instead of polling
Register a webhook for
class_track_analysis, then fetch the analysis when the event arrives. See Async jobs and webhooks.Payload
id is the analysis ID, and status is Completed or Failed. The event only goes to the API user who started the analysis, so register the webhook with the same user.Keep polling as a fallback. If the recording can’t be transcribed, the analysis is marked Failed without the event being sent.Troubleshooting
Troubleshooting
Related
ClassTrack API reference
Every field, response, and error.
Classroom Observation
What teachers and coaches see, without the code.