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
Requirements
Building the API client library requires:
- Java 1.8+
- Maven/Gradle
Installation
Maven users
Add this dependency to your project's POM:
<dependency>
<groupId>video.api</groupId>
<artifactId>java-api-client</artifactId>
<version>1.4.3</version>
<scope>compile</scope>
</dependency>
Gradle users
Add this dependency to your project's build file:
implementation "video.api:java-api-client:1.4.3"
Others
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/java-api-client-1.4.3.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);
System.out.println(video);
} 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());
e.printStackTrace();
}
}
}
Documentation
API Endpoints
All URIs are relative to https://ws.api.video
AnalyticsApi
Retrieve an instance of AnalyticsApi:
ApiVideoClient client = 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 client = 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 client = 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 client = 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 client = 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 |
TagsApi
Retrieve an instance of TagsApi:
ApiVideoClient client = 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 client = 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 client = 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 client = 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 client = 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 |
Documentation for Models
Rate Limiting
api.video implements rate limiting to ensure fair usage and stability of the service. The API provides the rate limit values in the response headers for any API requests you make. The /auth endpoint is the only route without rate limitation.
In this client, you can access these headers by using the *WithHttpInfo()
or *Async
versions of the methods. These methods return the ApiResponse
that contains the response body and the headers, allowing you to check the X-RateLimit-Limit
, X-RateLimit-Remaining
, and X-RateLimit-Retry-After
headers to understand your current rate limit status.
Read more about these response headers in the API reference.
Here is an example of how to use these methods:
ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
ApiResponse<Video> response = client.videos().uploadWithUploadTokenWithHttpInfo("YOUR_UPLOAD_TOKEN", File("my-video.mp4"));
Map<String, List<String>> headers = response.getHeaders();
System.out.println("X-RateLimit-Limit: " + headers.get("X-RateLimit-Limit").get(0));
System.out.println("X-RateLimit-Remaining: " + headers.get("X-RateLimit-Remaining").get(0));
System.out.println("X-RateLimit-Retry-After: " + headers.get("X-RateLimit-Retry-After").get(0));
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();
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.