Java API client

The official Java client for

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

Table of contents

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

Getting started


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:

implementation "video.api:java-api-client:1.1.0"


At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

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

Code sample

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", Environment.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());


API Endpoints

All URIs are relative to


Retrieve an instance of CaptionsApi:

ApiVideoClient client = 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 client = 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 client = 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 client = 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 player themes
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 client = 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 client = 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 client = 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 client = 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 client = new ApiVideoClient("YOUR_API_TOKEN");

Public endpoints

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

ApiVideoClient client = 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.

Did this page help you?