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

Project description

api.video's Java API 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.3.1"


At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/java-api-client-1.3.1.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_KEY");
    // if you rather like to use the sandbox environment:
    // ApiVideoClient apiVideoClient = new ApiVideoClient("YOU_SANDBOX_API_KEY", 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 https://ws.api.video


Retrieve an instance of AnalyticsApi:

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


Method HTTP request Description
getLiveStreamsPlays GET /analytics/live-streams/plays Get play events for live stream
getVideosPlays GET /analytics/videos/plays Get play events for video


Retrieve an instance of CaptionsApi:

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


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


Retrieve an instance of ChaptersApi:

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


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


Retrieve an instance of LiveStreamsApi:

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


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


Retrieve an instance of PlayerThemesApi:

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


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


Retrieve an instance of UploadTokensApi:

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


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


Retrieve an instance of VideosApi:

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


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
getStatus GET /videos/{videoId}/status Retrieve video status and details


Retrieve an instance of WatermarksApi:

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


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


Retrieve an instance of WebhooksApi:

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


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

Documentation for Models

Documentation for 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 client = new ApiVideoClient("YOUR_API_KEY");

Public endpoints

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

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.

Was this page helpful?