Docs home

Get Video Download Teaching Material

Returns download links for a video teaching material, one per available resolution. Use it to let a user save a video for offline viewing.

GET/video/download
Get Video Download Teaching Material
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/video/download?material_id=2531266' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "material": {
    "material_id": "2531266",
    "duration_seconds": 64,
    "video_array": [
      {
        "resolution": 1,
        "type": "video/mp4",
        "url": "https://player.vimeo.com/progressive_redirect/download/1069589882/container/ffd4be34-c5f5-41b3-a626-0a9d7932a3a2/e773255a-e07382ad/test_zoom_class_%2822-may-2023-6_50_pm-8_10_pm%29_%28240p%29.mp4%20%28240p%29.mp4?expires=1792048284&loc=external&oauth2_token_id=1220953663&signature=226872d26af48153daa8339bf00652cc51905647fe71b4ca90e6f401545a8edf&user_id=98356267",
        "file_size": 1716999,
        "file_name": "test_zoom_class_(22-may-2023-6_50_pm-8_10_pm) (240p).mp4"
      }
    ]
  }
}

Access: Any signed-in user of your organization. For a material_id, the caller must be an admin of the video's organization, or a learner or tutor of the course that contains it.

Query parameters
material_idintegerOne of material_id or asset_id
Video teaching material ID.
asset_idintegerOne of material_id or asset_id
Asset-library video ID. Used when material_id is not sent.
class_idinteger
Batch ID. Used to check that prerequisite materials have been completed.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
materialobject
Show child attributesHide child attributes
String
Example: 2531266
Example: 64
Show child attributesHide child attributes
video/mp4
Example: video/mp4
Time-limited download link
Bytes
Example: 1716999
Example: test_zoom_class_(22-may-2023-6_50_pm-8_10_pm) (240p).mp4

Notes: Learners on the web cannot download Vimeo DRM videos ("Not allowed to download the video."); mobile apps can. Downloads of DRM videos are logged. Errors: "Invalid Material ID" (not a video, or you have no access), "material_id or asset_id is required.", "No downloadable video found for this asset.". Rate limit: 100 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI