HomeDocumentationAPI Reference
API Reference

Obtain a highlight reel download link

Returns the details of a highlight reel and a link to download it.

If the highlight reel is still being prepared, the response returns a status of GENERATING and no link. Call this endpoint again every few seconds until the status becomes GENERATED, then use the reelUrl to download the highlight reel. The link is valid for 15 minutes; after it expires, call the endpoint again to get a new one.

Compatibility:

  • Tests must be of the "STUDYV2" type and belong to one of the following product types:
    • "LIVE_CONVERSATION" (non-classic live conversation)
    • "NON_THINK_OUT_LOUD" (interaction test)
    • "THINK_OUT_LOUD" (think-out-loud test).
  • Go to How to Obtain a Test ID (UUID) for details.
Path Params
uuid
required

ID of the test the highlight reel belongs to.

uuid
required

ID of the highlight reel you want to download.

Responses

401

Missing or invalid access token.

404

Highlight reel not found.

429

Too many requests. Maximum of 10 requests per minute.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json