Android API client

The official Android client for

badge   badge   badge Android 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 Android 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:android-api-client:1.0.5"


At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/android-api-client-1.0.5.jar
  • target/lib/*.jar

Code sample

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

import android.os.Bundle
import android.util.Log
import video.api.client.ApiVideoClient
import video.api.client.api.ApiException
import video.api.client.api.models.*
import java.util.concurrent.ExecutorService
import java.util.concurrent.Executors

class MainActivity : AppCompatActivity() {
    private val executor: ExecutorService = Executors.newSingleThreadExecutor()

    override fun onCreate(savedInstanceState: Bundle?) {

    override fun onResume() {

        val apiVideoClient = ApiVideoClient("YOUR_API_KEY")
        // if you rather like to use the sandbox environment:
        // val apiVideoClient = ApiVideoClient("YOU_SANDBOX_API_KEY", Environment.SANDBOX)

        val myVideoFile = File("my-video.mp4")

         * Notice: you must not call API from the UI/main thread. Dispatch with Thread, Executors or Kotlin coroutines.
        executor.execute {
            try {
                var video = apiVideoClient.videos().create(VideoCreationPayload().title("my video"))
                video = apiVideoClient.videos().upload(video.videoId, myVideoFile)
                Log.i("Example", "$video")
            } catch (e: ApiException) {
                Log.e("Example", "Exception when calling VideoApi")
                e.message?.let {
                    Log.e("Example", "Reason: ${it}")


An example that demonstrates how to use the API is provided in folder example/.


You have to add the following permissions in your AndroidManifest.xml:

    <uses-permission android:name="android.permission.INTERNET" />
<!-- Application requires android.permission.READ_EXTERNAL_STORAGE to upload videos` -->
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

Your application also has to dynamically request the android.permission.READ_EXTERNAL_STORAGE permission to upload videos.


API Endpoints

All URIs are relative to


Retrieve an instance of CaptionsApi:

val client = ApiVideoClient("YOUR_API_KEY")
val captions = client.captions()


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


Retrieve an instance of ChaptersApi:

val client = ApiVideoClient("YOUR_API_KEY")
val chapters = client.chapters()


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


Retrieve an instance of LiveStreamsApi:

val client = ApiVideoClient("YOUR_API_KEY")
val liveStreams = client.liveStreams()


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


Retrieve an instance of PlayerThemesApi:

val client = ApiVideoClient("YOUR_API_KEY")
val playerThemes = client.playerThemes()


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


Retrieve an instance of RawStatisticsApi:

val client = ApiVideoClient("YOUR_API_KEY")
val 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:

val client = ApiVideoClient("YOUR_API_KEY")
val uploadTokens = client.uploadTokens()


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


Retrieve an instance of VideosApi:

val client = ApiVideoClient("YOUR_API_KEY")
val videos = client.videos()


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


Retrieve an instance of WatermarksApi:

val client = ApiVideoClient("YOUR_API_KEY")
val watermarks = client.watermarks()


MethodHTTP requestDescription
uploadPOST /watermarksUpload a watermark
deleteDELETE /watermarks/{watermarkId}Delete a watermark
listGET /watermarksList all watermarks


Retrieve an instance of WebhooksApi:

val client = ApiVideoClient("YOUR_API_KEY")
val webhooks = client.webhooks()


MethodHTTP requestDescription
createPOST /webhooksCreate Webhook
getGET /webhooks/{webhookId}Retrieve Webhook details
deleteDELETE /webhooks/{webhookId}Delete a Webhook
listGET /webhooksList 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:

val client = ApiVideoClient("YOUR_API_KEY")

Public endpoints

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

val client = ApiVideoClient()


It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.
Do not call API from the main thread, otherwise you will get a android.os.NetworkOnMainThreadException. Dispatch API calls with Thread, Executors or Kotlin coroutine to avoid this.

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.