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    

Java API client

Java API client for api.video service (beta version)

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


Building the API client library requires:

  1. Java 1.8+
  2. Maven/Gradle


Maven users

Add this dependency to your project's POM:


Gradle users

Add this dependency to your project's build file:

compile "video.api:java-api-client:1.0.6"


At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/java-api-client-1.0.6.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import video.api.client.ApiVideoClient;
import video.api.client.api.ApiException;
import video.api.client.api.models.*;

public class Example {
  public static void main(String[] args) {
    ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_TOKEN");
    // if you rather like to use the sandbox environment:
    // ApiVideoClient apiVideoClient = new ApiVideoClient("YOU_SANDBOX_API_TOKEN", ApiVideoClient.Environments.SANDBOX);

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

    try {
        Video video = apiVideoClient.videos().create(new VideoCreationPayload().title("my video"));
        video = apiVideoClient.videos().upload(video.getVideoId(), myVideoFile);
    } catch (ApiException e) {
        System.err.println("Exception when calling AccountApi#get");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getMessage());
        System.err.println("Response headers: " + e.getResponseHeaders());

Documentation for API Endpoints

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


Retrieve an instance of CaptionsApi:

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


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


Retrieve an instance of ChaptersApi:

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


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


Retrieve an instance of LiveStreamsApi:

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


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


Retrieve an instance of PlayerThemesApi:

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


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


Retrieve an instance of RawStatisticsApi:

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


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


Retrieve an instance of UploadTokensApi:

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


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


Retrieve an instance of VideosApi:

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


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


Retrieve an instance of WebhooksApi:

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


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


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

Updated 9 days ago

Java API client

Java 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.