Docs home

Complete Normal Video Upload

Finishes a video upload started with "Create Normal Video Teaching Material". Call it after the file has been fully uploaded to the `upload_link`; the video then starts processing and becomes playable when that is done. You can also attach subtitle and audio-language tracks here.

POST/vimeo/upload/complete
Complete Normal Video Upload
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/vimeo/upload/complete' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"material_id":17491,"temp_vimeo_id":549}'
{
  "code": 200,
  "message": "Success"
}

Access: Institute admins and tutors, plus custom roles that can create or manage curriculum or manage the asset library. Only the user who started the upload can complete it.

Request body: form-data with one field, JSONString, containing this JSON:

BodyJSONString
temp_vimeo_idintegerrequired
temp_vimeo_id from the create response.
material_idintegerOne of material_id or asset_id
Material the video belongs to (material.material_id from the create response).
asset_idintegerOne of material_id or asset_id
Use instead of material_id when the upload replaces the video of an asset-library item. Send one, not both.
typestring
MIME type of the video. Worked out from the file name when left out.
subtitle_language_idsarray of integers
Languages whose subtitles should stay. Existing subtitles in other languages are removed.
audio_language_idsarray of integers
Languages whose extra audio tracks should stay. Existing tracks in other languages are removed.
Subtitle file (SRT) for that language ID, for example subtitle_3. Up to 5 MB.
audio_file
Audio track (MP3 or WAV) for that language ID. Up to 5 MB.
Response200application/json
codeinteger
Example: 200
messagestring
"Success"
Example: Success

Notes: Errors: "temp_vimeo_id is required", "asset_id or material_id is required", "Provide either asset_id or material_id, not both", "Invalid Teaching Material Id" (the upload is not yours, was already completed, or the ID is wrong) and "temp_vimeo_id does not match material_id". When audio tracks are sent the call waits about 10 seconds before adding them. Rate limit: 100 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI