Sign up for free C# API client is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Project description's C# API client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

Getting started


Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)


We recommend using NuGet to obtain the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742


Using Nuget

Install-Package ApiVideo

Generating the DLL yourself

Generate the DLL using your preferred tool

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using ApiVideo.Api;
using ApiVideo.Client;
using ApiVideo.Model;

Code sample

using System.Collections.Generic;
using System.Diagnostics;
using System;
using System.IO;
using ApiVideo.Api;
using ApiVideo.Client;
using ApiVideo.Model;

namespace Example
    public class Example
        public static void Main()
            var apiKey = "YOUR_API_KEY";

            var apiVideoClient = new ApiVideoClient(apiKey);
            // if you rather like to use the sandbox environment:
            // var apiVideoClient = new ApiVideoClient(apiKey, ApiVideo.Client.Environment.SANDBOX);

            var videoPayload = new VideoCreationPayload()
                title = "Example video title",
                description = "Example video description",
                mp4support = true,
                tags = new List<string>()

            var myVideoFile = File.OpenRead("my-video.mp4");

            try {
                var newVideo = apiVideoClient.Videos().create(videoPayload);
                var video = apiVideoClient.Videos().upload(newVideo.videoid,myVideoFile);
            } catch (ApiException e) {


API Endpoints

All URIs are relative to


Retrieve an instance of AnalyticsApi:
ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
AnalyticsApi analytics = client.Analytics()
MethodHTTP requestDescription
getLiveStreamsPlaysGET /analytics/live-streams/playsGet play events for live stream
getVideosPlaysGET /analytics/videos/playsGet play events for video


Retrieve an instance of CaptionsApi:
ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
CaptionsApi captions = client.Captions()
MethodHTTP requestDescription
uploadPOST /videos/{videoId}/captions/{language}Upload a caption
getGET /videos/{videoId}/captions/{language}Retrieve a caption
updatePATCH /videos/{videoId}/captions/{language}Update a caption
deleteDELETE /videos/{videoId}/captions/{language}Delete a caption
listGET /videos/{videoId}/captionsList video captions


Retrieve an instance of ChaptersApi:
ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
ChaptersApi chapters = client.Chapters()
MethodHTTP requestDescription
uploadPOST /videos/{videoId}/chapters/{language}Upload a chapter
getGET /videos/{videoId}/chapters/{language}Retrieve a chapter
deleteDELETE /videos/{videoId}/chapters/{language}Delete a chapter
listGET /videos/{videoId}/chaptersList video chapters


Retrieve an instance of LiveStreamsApi:
ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
LiveStreamsApi liveStreams = client.LiveStreams()
MethodHTTP requestDescription
createPOST /live-streamsCreate live stream
getGET /live-streams/{liveStreamId}Retrieve live stream
updatePATCH /live-streams/{liveStreamId}Update a live stream
deleteDELETE /live-streams/{liveStreamId}Delete a live stream
listGET /live-streamsList all live streams
uploadThumbnailPOST /live-streams/{liveStreamId}/thumbnailUpload a thumbnail
deleteThumbnailDELETE /live-streams/{liveStreamId}/thumbnailDelete a thumbnail


Retrieve an instance of PlayerThemesApi:
ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
PlayerThemesApi playerThemes = client.PlayerThemes()
MethodHTTP requestDescription
createPOST /playersCreate a player
getGET /players/{playerId}Retrieve a player
updatePATCH /players/{playerId}Update a player
deleteDELETE /players/{playerId}Delete a player
listGET /playersList all player themes
uploadLogoPOST /players/{playerId}/logoUpload a logo
deleteLogoDELETE /players/{playerId}/logoDelete logo


Retrieve an instance of UploadTokensApi:
ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
UploadTokensApi uploadTokens = client.UploadTokens()
MethodHTTP requestDescription
createTokenPOST /upload-tokensGenerate an upload token
getTokenGET /upload-tokens/{uploadToken}Retrieve upload token
deleteTokenDELETE /upload-tokens/{uploadToken}Delete an upload token
listGET /upload-tokensList all active upload tokens


Retrieve an instance of VideosApi:
ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
VideosApi videos = client.Videos()
MethodHTTP requestDescription
createPOST /videosCreate a video object
uploadPOST /videos/{videoId}/sourceUpload a video
uploadWithUploadTokenPOST /uploadUpload with an delegated upload token
getGET /videos/{videoId}Retrieve a video object
updatePATCH /videos/{videoId}Update a video object
deleteDELETE /videos/{videoId}Delete a video object
listGET /videosList all video objects
uploadThumbnailPOST /videos/{videoId}/thumbnailUpload a thumbnail
pickThumbnailPATCH /videos/{videoId}/thumbnailSet a thumbnail
getStatusGET /videos/{videoId}/statusRetrieve video status and details


Retrieve an instance of WatermarksApi:
ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
WatermarksApi watermarks = client.Watermarks()
MethodHTTP requestDescription
uploadPOST /watermarksUpload a watermark
deleteDELETE /watermarks/{watermarkId}Delete a watermark
listGET /watermarksList all watermarks


Retrieve an instance of WebhooksApi:
ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
WebhooksApi webhooks = client.Webhooks()
MethodHTTP requestDescription
createPOST /webhooksCreate Webhook
getGET /webhooks/{webhookId}Retrieve Webhook details
deleteDELETE /webhooks/{webhookId}Delete a Webhook
listGET /webhooksList all webhooks



API key

Most endpoints required to be authenticated using the API key mechanism described in our documentation. The access token generation mechanism is automatically handled by the client. All you have to do is provide an API key when instantiating the ApiVideoClient:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");

Public endpoints

Some endpoints don't require authentication. These one can be called with an ApiVideoClient instantiated without API key:

ApiVideoClient apiVideoClient = new ApiVideoClient();


It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Have you gotten use from this API client?

Please take a moment to leave a star on the client ⭐

This helps other users to find the clients and also helps us understand which clients are most popular. Thank you!


Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our client generator. Otherwise, you can also simply open an issue detailing your need on this repository.

Was this page helpful?