api.video Docs - API Reference, SDK

Welcome to the api.video developer hub. You'll find comprehensive guides and documentation to help you start working with api.video as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

C# API client

C# API client for api.video service (beta version).

api.video C# API client

api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes.

Warning

This API client is still in beta. Please feel free to report any issue you may encounter.

Frameworks supported

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

Dependencies

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

Installation

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;

Getting Started

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>()
                {
                    "first","video","test","c#","client"
                }
            };

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

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

Documentation for API Endpoints

All URIs are relative to https://ws.api.video

CaptionsApi

Retrieve an instance of CaptionsApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");
CaptionsApi captions = client.Captions()

Endpoints

MethodHTTP requestDescription
deleteDELETE /videos/{videoId}/captions/{language}Delete a caption
listGET /videos/{videoId}/captionsList video captions
getGET /videos/{videoId}/captions/{language}Show a caption
updatePATCH /videos/{videoId}/captions/{language}Update caption
uploadPOST /videos/{videoId}/captions/{language}Upload a caption

ChaptersApi

Retrieve an instance of ChaptersApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");
ChaptersApi chapters = client.Chapters()

Endpoints

MethodHTTP requestDescription
deleteDELETE /videos/{videoId}/chapters/{language}Delete a chapter
listGET /videos/{videoId}/chaptersList video chapters
getGET /videos/{videoId}/chapters/{language}Show a chapter
uploadPOST /videos/{videoId}/chapters/{language}Upload a chapter

LiveStreamsApi

Retrieve an instance of LiveStreamsApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");
LiveStreamsApi liveStreams = client.LiveStreams()

Endpoints

MethodHTTP requestDescription
deleteDELETE /live-streams/{liveStreamId}Delete a live stream
deleteThumbnailDELETE /live-streams/{liveStreamId}/thumbnailDelete a thumbnail
listGET /live-streamsList all live streams
getGET /live-streams/{liveStreamId}Show live stream
updatePATCH /live-streams/{liveStreamId}Update a live stream
createPOST /live-streamsCreate live stream
uploadThumbnailPOST /live-streams/{liveStreamId}/thumbnailUpload a thumbnail

PlayerThemesApi

Retrieve an instance of PlayerThemesApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");
PlayerThemesApi playerThemes = client.PlayerThemes()

Endpoints

MethodHTTP requestDescription
deleteDELETE /players/{playerId}Delete a player
deleteLogoDELETE /players/{playerId}/logoDelete logo
listGET /playersList all players
getGET /players/{playerId}Show a player
updatePATCH /players/{playerId}Update a player
createPOST /playersCreate a player
uploadLogoPOST /players/{playerId}/logoUpload a logo

RawStatisticsApi

Retrieve an instance of RawStatisticsApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");
RawStatisticsApi rawStatistics = client.RawStatistics()

Endpoints

MethodHTTP requestDescription
listLiveStreamSessionsGET /analytics/live-streams/{liveStreamId}List live stream player sessions
listSessionEventsGET /analytics/sessions/{sessionId}/eventsList player session events
listVideoSessionsGET /analytics/videos/{videoId}List video player sessions

UploadTokensApi

Retrieve an instance of UploadTokensApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");
UploadTokensApi uploadTokens = client.UploadTokens()

Endpoints

MethodHTTP requestDescription
deleteTokenDELETE /upload-tokens/{uploadToken}Delete an upload token
listGET /upload-tokensList all active upload tokens.
getTokenGET /upload-tokens/{uploadToken}Show upload token
createTokenPOST /upload-tokensGenerate an upload token

VideosApi

Retrieve an instance of VideosApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");
VideosApi videos = client.Videos()

Endpoints

MethodHTTP requestDescription
deleteDELETE /videos/{videoId}Delete a video
getGET /videos/{videoId}Show a video
getStatusGET /videos/{videoId}/statusShow video status
listGET /videosList all videos
updatePATCH /videos/{videoId}Update a video
pickThumbnailPATCH /videos/{videoId}/thumbnailPick a thumbnail
uploadWithUploadTokenPOST /uploadUpload with an upload token
createPOST /videosCreate a video
uploadPOST /videos/{videoId}/sourceUpload a video
uploadThumbnailPOST /videos/{videoId}/thumbnailUpload a thumbnail

WebhooksApi

Retrieve an instance of WebhooksApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");
WebhooksApi webhooks = client.Webhooks()

Endpoints

MethodHTTP requestDescription
deleteDELETE /webhooks/{webhookId}Delete a Webhook
getGET /webhooks/{webhookId}Show Webhook details
listGET /webhooksList all webhooks
createPOST /webhooksCreate Webhook

Documentation for Models

Documentation for Authorization

API token

Most endpoints required to be authenticated using the API token 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 token when instantiating the ApiVideoClient:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");

Public endpoints

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

ApiVideoClient apiVideoClient = new ApiVideoClient();

Recommendation

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

Updated about a month ago


C# API client


C# API client for api.video service (beta version).

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.