Node.js API client

The official NodeJs client for api.video

badgebadge   badgebadge   badgebadge

api.video Node.js 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.

Table of contents

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

Installation

With npm:

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

...or with yarn:

yarn add @api.video/nodejs-client

Migration

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

Development

To build and compile the typescript sources to javascript use:

npm install
npm run build

Code sample

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

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

        // 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) {
        console.error(e);
    }
})();

Documentation

API Endpoints

All URIs are relative to https://ws.api.video

CaptionsApi

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

const apiVideoClient = new ApiVideoClient({ apiKey: "YOUR_API_TOKEN" });
const captions = apiVideoClient.captions;

Endpoints

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

ChaptersApi

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

const apiVideoClient = new ApiVideoClient({ apiKey: "YOUR_API_TOKEN" });
const chapters = apiVideoClient.chapters;

Endpoints

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

LiveStreamsApi

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

const apiVideoClient = new ApiVideoClient({ apiKey: "YOUR_API_TOKEN" });
const liveStreams = apiVideoClient.liveStreams;

Endpoints

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

PlayerThemesApi

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

const apiVideoClient = new ApiVideoClient({ apiKey: "YOUR_API_TOKEN" });
const playerThemes = apiVideoClient.playerThemes;

Endpoints

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

RawStatisticsApi

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

const apiVideoClient = new ApiVideoClient({ apiKey: "YOUR_API_TOKEN" });
const rawStatistics = apiVideoClient.rawStatistics;

Endpoints

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

UploadTokensApi

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

const apiVideoClient = new ApiVideoClient({ apiKey: "YOUR_API_TOKEN" });
const uploadTokens = apiVideoClient.uploadTokens;

Endpoints

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

VideosApi

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

const apiVideoClient = new ApiVideoClient({ apiKey: "YOUR_API_TOKEN" });
const videos = apiVideoClient.videos;

Endpoints

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

WebhooksApi

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

const apiVideoClient = new ApiVideoClient({ apiKey: "YOUR_API_TOKEN" });
const webhooks = apiVideoClient.webhooks;

Endpoints

MethodHTTP requestDescription
deleteDELETE /webhooks/{webhookId}Delete a Webhook
getGET /webhooks/{webhookId}Show Webhook details
listGET /webhooksList all webhooks
createPOST /webhooksCreate Webhook

Models

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:

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

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_TOKEN" });
const accessToken = await client.getAccessToken();

Public endpoints

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

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!

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.


Did this page help you?