api.video Node.js 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 Node.js is a lightweight client built in TypeScript that streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

Getting started


With npm:

npm install @api.video/nodejs-client --save

...or with yarn:

yarn add @api.video/nodejs-client


If you're coming from @api.video/nodejs-sdk make sure to read our Migration guide first.


To build and compile the typescript sources to javascript use:

npm install
npm run build

Code sample

const ApiVideoClient = require('@api.video/nodejs-client');
// or: import ApiVideoClient from '@api.video/nodejs-client';

(async () => {
    try {
        const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });

        // create a video
        const videoCreationPayload = {
            title: "Maths video", // The title of your new video.
            description: "A video about string theory.", // A brief description of your video.
        const video = await client.videos.create(videoCreationPayload);

        // upload a video file into the video container
        await client.videos.upload(video.videoId, "my-video-file.mp4");
    } catch (e) {


API Endpoints


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


Method Description HTTP request
upload() Upload a caption POST /videos/{videoId}/captions/{language}
get() Retrieve a caption GET /videos/{videoId}/captions/{language}
update() Update a caption PATCH /videos/{videoId}/captions/{language}
delete() Delete a caption DELETE /videos/{videoId}/captions/{language}
list() List video captions GET /videos/{videoId}/captions


Method Description HTTP request
upload() Upload a chapter POST /videos/{videoId}/chapters/{language}
get() Retrieve a chapter GET /videos/{videoId}/chapters/{language}
delete() Delete a chapter DELETE /videos/{videoId}/chapters/{language}
list() List video chapters GET /videos/{videoId}/chapters


Method Description HTTP request
create() Create live stream POST /live-streams
get() Retrieve live stream GET /live-streams/{liveStreamId}
update() Update a live stream PATCH /live-streams/{liveStreamId}
delete() Delete a live stream DELETE /live-streams/{liveStreamId}
list() List all live streams GET /live-streams
uploadThumbnail() Upload a thumbnail POST /live-streams/{liveStreamId}/thumbnail
deleteThumbnail() Delete a thumbnail DELETE /live-streams/{liveStreamId}/thumbnail


Method Description HTTP request
create() Create a player POST /players
get() Retrieve a player GET /players/{playerId}
update() Update a player PATCH /players/{playerId}
delete() Delete a player DELETE /players/{playerId}
list() List all player themes GET /players
uploadLogo() Upload a logo POST /players/{playerId}/logo
deleteLogo() Delete logo DELETE /players/{playerId}/logo


Method Description HTTP request
createToken() Generate an upload token POST /upload-tokens
getToken() Retrieve upload token GET /upload-tokens/{uploadToken}
deleteToken() Delete an upload token DELETE /upload-tokens/{uploadToken}
list() List all active upload tokens GET /upload-tokens


Method Description HTTP request
create() Create a video object POST /videos
upload() Upload a video POST /videos/{videoId}/source
uploadWithUploadToken() Upload with an delegated upload token POST /upload
get() Retrieve a video object GET /videos/{videoId}
update() Update a video object PATCH /videos/{videoId}
delete() Delete a video object DELETE /videos/{videoId}
list() List all video objects GET /videos
uploadThumbnail() Upload a thumbnail POST /videos/{videoId}/thumbnail
pickThumbnail() Set a thumbnail PATCH /videos/{videoId}/thumbnail
getStatus() Retrieve video status and details GET /videos/{videoId}/status


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


Method Description HTTP request
create() Create Webhook POST /webhooks
get() Retrieve Webhook details GET /webhooks/{webhookId}
delete() Delete a Webhook DELETE /webhooks/{webhookId}
list() List all webhooks GET /webhooks



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:

const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });

Get the access token

If you need to access the access-token value obtained using the API key, you can use the getAccessToken() method of the client:

const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const accessToken = await client.getAccessToken();

Public endpoints

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

const client = new ApiVideoClient();

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?