api.video provides different ways to upload your videos. There are two ways to upload with tokens, and then there are two ways to upload depending on whether your video is over 200MB or under. This guide walks through how to do progressive video upload. Options covered in this guide include:
Megabyte (MB) and Mebibyte (MiB) are both used to measure units of information on computer storage. 1 MB is 1000Kb (kilobytes), and 1 MiB is 1048.576Kb. api.video uses MiB.
Before you can start uploading your first video, you need to create an api.video account .
Once you are logged in to the Dashboard, select the environment of your choice (sandbox or production) and copy your API key.
The clients offered by api.video include:
To install your selected client, do the following:
When the video file you want to upload is too large to send in one request, you need to do a progressive upload. To upload the entire video, you must broken into chunks, and send each chunk in separate requests. The smallest chunk size allowed is 5 MiB .
When you do a progressive upload using one of the api.video clients, you must indicate when you send the last part.
If you implement this functionality without an api.video client, you do not need to indicate the last part of the progressive upload. api.video can track the chunk numbers based on your header which indicates Content-Range, for example : part 3/3, according to the number of chunks you sent.
cURL
curl --request POST \ --url https://ws.api.video/videos \ --header 'Accept: application/json' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NDI1NDk1NjAuMDE5ODA0LCJuYmYiOjE2NDI1NDk1NjAuMDE5ODA0LCJleHAiOjE2NDI1NTMxNjAuMDE5ODA0LCJwcm9qZWN0SWQiOiJwclJ6SUpKQTdCTHNxSGpTNDVLVnBCMSJ9.jjr4YADGbe62RmBBxJXLy1D61Mtfry_dq9nbriBXgkPrdlBJ8ZRP50CyW3AsGD7wSuKp2mXxEYSzj64zelT1IGOwg6KG4Gz9BZ9YWs0GAHKUIdgqn1gzITX5aQljIXx1fquXbawd-axBTi4icmaUjgXjfnyIcWOgHd2D8A3kpKiqiMmluh58JdnwPnH0OyVk0Rk824P0PI6SxfiTHfkCglPL6ixf9OgokMLPoVrsxH5C0xt3Z7lf5TJ0F78-JY-yTKvyaTTIfI6CFOMNaZUlMtgQwq8X93_2FA65Ntw3hdDML8gFKkLUxnBAtZMo9WAjUd30G4OcYasmlkc4Q_JSNw' \ --header 'Content-Type: application/json' \ --data ' { "public": true, "panoramic": false, "mp4Support": true, "title": "HelloWorld" } ' # Retrieve the access_token from the response, then include in your next request. curl --request POST \ --url https://ws.api.video/videos//source \ --header 'Accept: application/json' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NDI4MjQzMTkuMDk2NjY1LCJuYmYiOjE2NDI4MjQzMTkuMDk2NjY1LCJleHAiOjE2NDI4Mjc5MTkuMDk2NjY1LCJwcm9qZWN0SWQiOiJwclJ6SUpKQTdCTHNxSGpTNDVLVnBCMSJ9.rfchf3btbMTzSukcwhUS0u4fNY4Q3g1JpoMeIz_Dls1ADmqDdKw7yBOE893C7cagb0lpuvUJvhuhgusLStsJ4nqzTveDeM2oPBQBNJjzwaJZNrImTPD4mif7Tzgxvn1_jQJA5L4gQhjd7frCIJW1yAwywrtiDPbxiWNp8fVl7r_QILjZZfslxy-kblPrHJ20Zix9VURqkGIORY5G_457nHSV9Atks1sUlt49E8b_g3jORja3MnznXBS0-0dksz2K62-QMe1_dk78V9JwbLeydqcr15M1jDLA3H6qFGI7GTsTDdZ5jKLhg5OR6yeSHFysqr3kOteTqAGdp3JuTrpZIA' \ --header 'Content-Range: part%201%2F3' \ --header 'Content-Type: multipart/form-data' # You would send each part until the last part is sent. In order to do this with a cURL request, you must break your video into chunks ahead of time. Go
package main import ( " context " " fmt " " os " apivideosdk " github.com/apivideo/api.video-go-client " ) func main () { client := apivideosdk. ClientBuilder ( "YOUR_API_TOKEN" ). Build () // if you rather like to use the sandbox environment: // client := apivideosdk.SandboxClientBuilder("YOU_SANDBOX_API_TOKEN").Build() videoId := "vi4k0jvEUuaTdRAEjQ4Jfrgz" // string | Enter the videoId you want to use to upload your video. part1, err := os. Open ( "10m.mp4.part.a" ) part2, err := os. Open ( "10m.mp4.part.b" ) part3, err := os. Open ( "10m.mp4.part.c" ) stream = client.Videos. CreateUploadStream (videoId) _, err = stream. UploadPartFile (part1) _, err = stream. UploadPartFile (part2) res, err := stream. UploadLastPartFile (part3) err = part1. Close () err = part2. Close () err = part3. Close () PHP
<? php use ApiVideo\Client\Model\VideoCreationPayload ; require __DIR__ . '/vendor/autoload.php' ; $httpClient = new \Symfony\Component\HttpClient\Psr18Client (); $client = new \ApiVideo\Client ( 'https://sandbox.api.video' , 'YOUR_API_TOKEN' , $httpClient ); // create a new video & upload a video file $myVideo = $client -> videos () -> create (( new VideoCreationPayload ()) -> setTitle ( 'Uploaded video' )); $client -> videos () -> upload ($myVideo -> getVideoId (), new SplFileObject ( __DIR__ . '/../../../tests/resources/558k.mp4' )); // create a new video & upload a video file using progressive upload (the file is uploaded by parts) $myVideo2 = $client -> videos () -> create (( new VideoCreationPayload ()) -> setTitle ( 'Uploaded video (progressive upload)' )); $progressiveSession = $client -> videos () -> createUploadProgressiveSession ($myVideo2 -> getVideoId ()); $progressiveSession -> uploadPart ( new SplFileObject ( __DIR__ . '/../../../tests/resources/10m.mp4.part.a' )); $progressiveSession -> uploadPart ( new SplFileObject ( __DIR__ . '/../../../tests/resources/10m.mp4.part.b' )); $progressiveSession -> uploadLastPart ( new SplFileObject ( __DIR__ . '/../../../tests/resources/10m.mp4.part.c' )); Javascript
const ApiVideoClient = require ( '@api.video/nodejs-client' ); ( async () => { try { const client = new ApiVideoClient ({ apiKey: "YOUR_API_TOKEN" }); const videoId = 'vi4k0jvEUuaTdRAEjQ4Jfrgz' ; // Enter the videoId you want to use to upload your video. const uploadSession = client. createUploadProgressiveSession (videoId); await uploadSession. uploadPart ( 'test/data/10m.mp4.part.a' ); await uploadSession. uploadPart ( 'test/data/10m.mp4.part.b' ); const res = await uploadSession. uploadLastPart ( 'test/data/10m.mp4.part.c' ); // Video console. log (result); } catch (e) { console. error (e); } })(); Python
import os import apivideo from apivideo.apis import VideosApi from apivideo.exceptions import ApiAuthException api_key = "your API key here" ## Set up the authenticated client client = apivideo.AuthenticatedApiClient(api_key) ## if you rather like to use the sandbox environment: ## client = apivideo.AuthenticatedApiClient(api_key, production=False) client.connect() videos_api = VideosApi(client) video_create_payload = { "title" : "Progressive Test" , "description" : "test" , "public" : False , "tags" : [ "nature" ] } ## Create the container for your video and print the response response = videos_api.create(video_create_payload) print ( "Video Container" , response) ## Retrieve the video ID, you can upload once to a video ID video_id = response[ "video_id" ] session = videos_api.create_upload_progressive_session(video_id) CHUNK_SIZE = 6000000 ## This is our chunk reader. This is what gets the next chunk of data ready to send. def read_in_chunks (file_object, CHUNK_SIZE): while True : data = file_object.read( CHUNK_SIZE ) if not data: break yield data ## Upload your file by breaking it into chunks and sending each piece def upload (file): content_name = str ( file ) content_path = os.path.abspath( file ) f = open (content_path, "rb" ) index = 0 offset = 0 part_num = 1 headers = {} for chunk in read_in_chunks(f, CHUNK_SIZE ): offset = index + len (chunk) index = offset with open ( 'chunk.part.' + str (part_num), 'wb' ) as chunk_file: chunk_file.write(chunk) chunk_file.close() with open ( 'chunk.part.' + str (part_num), 'rb' ) as chunk_file: try : if len (chunk) == CHUNK_SIZE : session.uploadPart(chunk_file) elif len (chunk) < CHUNK_SIZE : print (session.uploadLastPart(chunk_file)) chunk_file.close() except Exception as e: print (e) os.remove( 'chunk.part.' + str (part_num)) part_num += 1 upload( 'VIDEO_FILE.mp4' ) Progressive upload with byte range in the content-range header A slightly more complicated way to upload a video that's 200 MiB or larger is to use bytes in the content-range header. This method requires that you define the exact byte ranges correctly, otherwise the entire upload to fail. When done correctly, your header will look like this:
Content-Range: bytes 0-5242879 And then continue from there. By default, the api.video clients handle uploads for you using this method. If you want to try it yourself without the client, the sample will look like this in cURL:
All api.video clients automatically use the Content-Range: bytes method to upload big videos for you. You don't have to set it up yourself if you use a client!
Check out api.video's blog content and tutorials about video uploads , private videos , and delegated uploads !
