api.video C# client

api.video 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.

Table of contents

• Project description
• Getting started
  • Requirements
    • Frameworks supported
    • Dependencies
  • Installation
    • Using Nuget
    • Generating the DLL yourself
  • Code sample
• Documentation
  • API Endpoints
    • AnalyticsApi
    • CaptionsApi
    • ChaptersApi
    • LiveStreamsApi
    • PlayerThemesApi
    • SummariesApi
    • TagsApi
    • UploadTokensApi
    • VideosApi
    • WatermarksApi
    • WebhooksApi
  • Models
  • Authorization
    • API key
    • Public endpoints
  • Recommendation
• Have you gotten use from this API client?
• Contribution

Project description

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

Getting started

Requirements

Frameworks supported

• .NET 5.0 or later

Dependencies

• RestSharp - 111.2.0
• Json.NET - 13.0.3
• JsonSubTypes - 1.8.0

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;

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>()
                {
                    "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

API Endpoints

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

AnalyticsApi

Retrieve an instance of AnalyticsApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
AnalyticsApi analytics = client.Analytics()

Endpoints

Method	HTTP request	Description
getAggregatedMetrics	GET /data/metrics/{metric}/{aggregation}	Retrieve aggregated metrics
getMetricsBreakdown	GET /data/buckets/{metric}/{breakdown}	Retrieve metrics in a breakdown of dimensions
getMetricsOverTime	GET /data/timeseries/{metric}	Retrieve metrics over time

CaptionsApi

Retrieve an instance of CaptionsApi:

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

Endpoints

Method	HTTP request	Description
upload	POST /videos/{videoId}/captions/{language}	Upload a caption
get	GET /videos/{videoId}/captions/{language}	Retrieve a caption
update	PATCH /videos/{videoId}/captions/{language}	Update a caption
delete	DELETE /videos/{videoId}/captions/{language}	Delete a caption
list	GET /videos/{videoId}/captions	List video captions

ChaptersApi

Retrieve an instance of ChaptersApi:

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

Endpoints

Method	HTTP request	Description
upload	POST /videos/{videoId}/chapters/{language}	Upload a chapter
get	GET /videos/{videoId}/chapters/{language}	Retrieve a chapter
delete	DELETE /videos/{videoId}/chapters/{language}	Delete a chapter
list	GET /videos/{videoId}/chapters	List video chapters

LiveStreamsApi

Retrieve an instance of LiveStreamsApi:

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

Endpoints

Method	HTTP request	Description
create	POST /live-streams	Create live stream
get	GET /live-streams/{liveStreamId}	Retrieve live stream
update	PATCH /live-streams/{liveStreamId}	Update a live stream
delete	DELETE /live-streams/{liveStreamId}	Delete a live stream
list	GET /live-streams	List all live streams
uploadThumbnail	POST /live-streams/{liveStreamId}/thumbnail	Upload a thumbnail
deleteThumbnail	DELETE /live-streams/{liveStreamId}/thumbnail	Delete a thumbnail
complete	PUT /live-streams/{liveStreamId}/complete	Complete a live stream

PlayerThemesApi

Retrieve an instance of PlayerThemesApi:

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

Endpoints

Method	HTTP request	Description
create	POST /players	Create a player
get	GET /players/{playerId}	Retrieve a player
update	PATCH /players/{playerId}	Update a player
delete	DELETE /players/{playerId}	Delete a player
list	GET /players	List all player themes
uploadLogo	POST /players/{playerId}/logo	Upload a logo
deleteLogo	DELETE /players/{playerId}/logo	Delete logo

SummariesApi

Retrieve an instance of SummariesApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
SummariesApi summaries = client.Summaries()

Endpoints

Method	HTTP request	Description
create	POST /summaries	Generate video summary
update	PATCH /summaries/{summaryId}/source	Update summary details
delete	DELETE /summaries/{summaryId}	Delete video summary
list	GET /summaries	List summaries
getSummarySource	GET /summaries/{summaryId}/source	Get summary details

TagsApi

Retrieve an instance of TagsApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
TagsApi tags = client.Tags()

Endpoints

Method	HTTP request	Description
list	GET /tags	List all video tags

UploadTokensApi

Retrieve an instance of UploadTokensApi:

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

Endpoints

Method	HTTP request	Description
createToken	POST /upload-tokens	Generate an upload token
getToken	GET /upload-tokens/{uploadToken}	Retrieve upload token
deleteToken	DELETE /upload-tokens/{uploadToken}	Delete an upload token
list	GET /upload-tokens	List all active upload tokens

VideosApi

Retrieve an instance of VideosApi:

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

Endpoints

Method	HTTP request	Description
create	POST /videos	Create a video object
upload	POST /videos/{videoId}/source	Upload a video
uploadWithUploadToken	POST /upload	Upload with an delegated upload token
get	GET /videos/{videoId}	Retrieve a video object
update	PATCH /videos/{videoId}	Update a video object
delete	DELETE /videos/{videoId}	Delete a video object
list	GET /videos	List all video objects
uploadThumbnail	POST /videos/{videoId}/thumbnail	Upload a thumbnail
pickThumbnail	PATCH /videos/{videoId}/thumbnail	Set a thumbnail
getDiscarded	GET /discarded/videos/{videoId}	Retrieve a discarded video object
getStatus	GET /videos/{videoId}/status	Retrieve video status and details
listDiscarded	GET /discarded/videos	List all discarded video objects
updateDiscarded	PATCH /discarded/videos/{videoId}	Update a discarded video object

WatermarksApi

Retrieve an instance of WatermarksApi:

ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
WatermarksApi watermarks = client.Watermarks()

Endpoints

Method	HTTP request	Description
upload	POST /watermarks	Upload a watermark
delete	DELETE /watermarks/{watermarkId}	Delete a watermark
list	GET /watermarks	List all watermarks

WebhooksApi

Retrieve an instance of WebhooksApi:

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

Endpoints

Method	HTTP request	Description
create	POST /webhooks	Create Webhook
get	GET /webhooks/{webhookId}	Retrieve Webhook details
delete	DELETE /webhooks/{webhookId}	Delete a Webhook
list	GET /webhooks	List all webhooks

Models

• AccessToken
• AdditionalBadRequestErrors
• AnalyticsAggregatedMetricsResponse
• AnalyticsAggregatedMetricsResponseContext
• AnalyticsAggregatedMetricsResponseContextTimeframe
• AnalyticsData
• AnalyticsMetricsBreakdownResponse
• AnalyticsMetricsBreakdownResponseContext
• AnalyticsMetricsBreakdownResponseData
• AnalyticsMetricsOverTimeResponse
• AnalyticsMetricsOverTimeResponseContext
• AnalyticsMetricsOverTimeResponseData
• AnalyticsPlays400Error
• AnalyticsPlaysResponse
• AuthenticatePayload
• BadRequest
• BytesRange
• Caption
• CaptionsListResponse
• CaptionsUpdatePayload
• Chapter
• ChaptersListResponse
• ConflictError
• DiscardedVideoUpdatePayload
• FilterBy
• FilterBy1
• FilterBy2
• Link
• ListTagsResponse
• ListTagsResponseData
• LiveStream
• LiveStreamAssets
• LiveStreamCreationPayload
• LiveStreamListResponse
• LiveStreamUpdatePayload
• Metadata
• Model403ErrorSchema
• NotFound
• Pagination
• PaginationLink
• PlayerSessionEvent
• PlayerTheme
• PlayerThemeAssets
• PlayerThemeCreationPayload
• PlayerThemeUpdatePayload
• PlayerThemesListResponse
• Quality
• RefreshTokenPayload
• RestreamsRequestObject
• RestreamsResponseObject
• SummariesListResponse
• Summary
• SummaryCreationPayload
• SummarySource
• SummaryUpdatePayload
• TokenCreationPayload
• TokenListResponse
• TooManyRequests
• UnrecognizedRequestUrl
• UploadToken
• Video
• VideoAssets
• VideoClip
• VideoCreationPayload
• VideoSource
• VideoSourceLiveStream
• VideoSourceLiveStreamLink
• VideoStatus
• VideoStatusEncoding
• VideoStatusEncodingMetadata
• VideoStatusIngest
• VideoStatusIngestReceivedParts
• VideoThumbnailPickPayload
• VideoUpdatePayload
• VideoWatermark
• VideosListResponse
• Watermark
• WatermarksListResponse
• Webhook
• WebhooksCreationPayload
• WebhooksListResponse

Authorization

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();

Recommendation

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!

Contribution

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.