{"id":13612698,"url":"https://github.com/apivideo/api.video-nodejs-client","last_synced_at":"2025-05-08T23:45:43.801Z","repository":{"id":40263565,"uuid":"340105920","full_name":"apivideo/api.video-nodejs-client","owner":"apivideo","description":"The official Node.js client library for api.video ","archived":false,"fork":false,"pushed_at":"2025-01-27T13:57:35.000Z","size":22266,"stargazers_count":65,"open_issues_count":7,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-08T23:45:31.522Z","etag":null,"topics":["client","nodejs","openapi","video"],"latest_commit_sha":null,"homepage":"https://api.video","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apivideo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-18T16:15:12.000Z","updated_at":"2025-01-14T17:53:32.000Z","dependencies_parsed_at":"2023-09-29T16:30:06.481Z","dependency_job_id":"3751560a-4349-4bdc-aaaa-84cd709c4180","html_url":"https://github.com/apivideo/api.video-nodejs-client","commit_stats":{"total_commits":115,"total_committers":11,"mean_commits":"10.454545454545455","dds":0.4347826086956522,"last_synced_commit":"eba61fdd64955103b4179001765ecb58b2c9c333"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apivideo%2Fapi.video-nodejs-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apivideo%2Fapi.video-nodejs-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apivideo%2Fapi.video-nodejs-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apivideo%2Fapi.video-nodejs-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apivideo","download_url":"https://codeload.github.com/apivideo/api.video-nodejs-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253166474,"owners_count":21864467,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client","nodejs","openapi","video"],"created_at":"2024-08-01T20:00:33.286Z","updated_at":"2025-05-08T23:45:43.785Z","avatar_url":"https://github.com/apivideo.png","language":"TypeScript","funding_links":[],"categories":["HarmonyOS"],"sub_categories":["Windows Manager"],"readme":"\u003c!--\u003cdocumentation_excluded\u003e--\u003e\n[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video) \u0026nbsp; [![badge](https://img.shields.io/github/stars/apivideo/api.video-nodejs-client?style=social)](https://github.com/apivideo/api.video-nodejs-client) \u0026nbsp; [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video)\n![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png)\n\u003ch1 align=\"center\"\u003eapi.video Node.js client\u003c/h1\u003e\n\n[api.video](https://api.video) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand \u0026 low latency live streaming features in your app.\n\n## Table of contents\n\n- [Project description](#project-description)\n- [Getting started](#getting-started)\n  - [Installation](#installation)\n  - [Migration](#migration)\n  - [Development](#development)\n  - [Code sample](#code-sample)\n- [Documentation](#documentation)\n  - [API Endpoints](#api-endpoints)\n    - [AnalyticsApi](#analyticsapi)\n    - [CaptionsApi](#captionsapi)\n    - [ChaptersApi](#chaptersapi)\n    - [LiveStreamsApi](#livestreamsapi)\n    - [PlayerThemesApi](#playerthemesapi)\n    - [SummariesApi](#summariesapi)\n    - [TagsApi](#tagsapi)\n    - [UploadTokensApi](#uploadtokensapi)\n    - [VideosApi](#videosapi)\n    - [WatermarksApi](#watermarksapi)\n    - [WebhooksApi](#webhooksapi)\n  - [Models](#models)\n  - [Rate Limiting](#rate-limiting)\n  - [Authorization](#authorization)\n    - [API key](#api-key)\n    - [Get the access token](#get-the-access-token)\n    - [Public endpoints](#public-endpoints)\n- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client-)\n- [Contribution](#contribution)\n\u003c!--\u003c/documentation_excluded\u003e--\u003e\n\u003c!--\u003cdocumentation_only\u003e\n---\ntitle: Node.js API client\nmeta: \n  description: The official Node.js API client for api.video. [api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand \u0026 low latency live streaming features in your app.\n---\n\n# api.video Node.js API client\n\n[api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand \u0026 low latency live streaming features in your app.\n\u003c/documentation_only\u003e--\u003e\n\n## Project description\n\napi.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.\n\n## Getting started\n\n### Installation\nWith `npm`:\n```\nnpm install @api.video/nodejs-client --save\n```\n\n...or with `yarn`:\n```\nyarn add @api.video/nodejs-client\n```\n\n### Migration\n\nIf you're coming from [@api.video/nodejs-sdk](https://github.com/apivideo/nodejs-sdk) make sure to read our [Migration guide](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/MIGRATE.md) first.\n\n### Development\n\nTo build and compile the typescript sources to javascript use:\n```\nnpm install\nnpm run build\n```\n\n### Code sample\n\n```typescript\nconst ApiVideoClient = require('@api.video/nodejs-client');\n// or: import ApiVideoClient from '@api.video/nodejs-client';\n\n(async () =\u003e {\n    try {\n        const client = new ApiVideoClient({ apiKey: \"YOUR_API_KEY\" });\n\n        // create a video\n        const videoCreationPayload = {\n            title: \"Maths video\", // The title of your new video.\n            description: \"A video about string theory.\", // A brief description of your video.\n        };\n        const video = await client.videos.create(videoCreationPayload);\n\n        // upload a video file into the video container\n        await client.videos.upload(video.videoId, \"my-video-file.mp4\");\n    } catch (e) {\n        console.error(e);\n    }\n})();\n```\n\n## Documentation\n\n### API Endpoints\n\n\n#### AnalyticsApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**getAggregatedMetrics()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getAggregatedMetrics) | Retrieve aggregated metrics | **GET** `/data/metrics/{metric}/{aggregation}`\n[**getMetricsBreakdown()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getMetricsBreakdown) | Retrieve metrics in a breakdown of dimensions | **GET** `/data/buckets/{metric}/{breakdown}`\n[**getMetricsOverTime()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getMetricsOverTime) | Retrieve metrics over time | **GET** `/data/timeseries/{metric}`\n\n\n#### CaptionsApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#upload) | Upload a caption | **POST** `/videos/{videoId}/captions/{language}`\n[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#get) | Retrieve a caption | **GET** `/videos/{videoId}/captions/{language}`\n[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#update) | Update a caption | **PATCH** `/videos/{videoId}/captions/{language}`\n[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#delete) | Delete a caption | **DELETE** `/videos/{videoId}/captions/{language}`\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#list) | List video captions | **GET** `/videos/{videoId}/captions`\n\n\n#### ChaptersApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#upload) | Upload a chapter | **POST** `/videos/{videoId}/chapters/{language}`\n[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#get) | Retrieve a chapter | **GET** `/videos/{videoId}/chapters/{language}`\n[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#delete) | Delete a chapter | **DELETE** `/videos/{videoId}/chapters/{language}`\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#list) | List video chapters | **GET** `/videos/{videoId}/chapters`\n\n\n#### LiveStreamsApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#create) | Create live stream | **POST** `/live-streams`\n[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#get) | Retrieve live stream | **GET** `/live-streams/{liveStreamId}`\n[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#update) | Update a live stream | **PATCH** `/live-streams/{liveStreamId}`\n[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** `/live-streams/{liveStreamId}`\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#list) | List all live streams | **GET** `/live-streams`\n[**uploadThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/live-streams/{liveStreamId}/thumbnail`\n[**deleteThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** `/live-streams/{liveStreamId}/thumbnail`\n[**complete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#complete) | Complete a live stream | **PUT** `/live-streams/{liveStreamId}/complete`\n\n\n#### PlayerThemesApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#create) | Create a player | **POST** `/players`\n[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#get) | Retrieve a player | **GET** `/players/{playerId}`\n[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#update) | Update a player | **PATCH** `/players/{playerId}`\n[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#delete) | Delete a player | **DELETE** `/players/{playerId}`\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#list) | List all player themes | **GET** `/players`\n[**uploadLogo()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** `/players/{playerId}/logo`\n[**deleteLogo()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** `/players/{playerId}/logo`\n\n\n#### SummariesApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#create) | Generate video summary | **POST** `/summaries`\n[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#update) | Update summary details | **PATCH** `/summaries/{summaryId}/source`\n[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#delete) | Delete video summary | **DELETE** `/summaries/{summaryId}`\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#list) | List summaries | **GET** `/summaries`\n[**getSummarySource()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#getSummarySource) | Get summary details | **GET** `/summaries/{summaryId}/source`\n\n\n#### TagsApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/TagsApi.md#list) | List all video tags | **GET** `/tags`\n\n\n#### UploadTokensApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**createToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#createToken) | Generate an upload token | **POST** `/upload-tokens`\n[**getToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#getToken) | Retrieve upload token | **GET** `/upload-tokens/{uploadToken}`\n[**deleteToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** `/upload-tokens/{uploadToken}`\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#list) | List all active upload tokens | **GET** `/upload-tokens`\n\n\n#### VideosApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#create) | Create a video object | **POST** `/videos`\n[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#upload) | Upload a video | **POST** `/videos/{videoId}/source`\n[**uploadWithUploadToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** `/upload`\n[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#get) | Retrieve a video object | **GET** `/videos/{videoId}`\n[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#update) | Update a video object | **PATCH** `/videos/{videoId}`\n[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#delete) | Delete a video object | **DELETE** `/videos/{videoId}`\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#list) | List all video objects | **GET** `/videos`\n[**uploadThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/videos/{videoId}/thumbnail`\n[**pickThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** `/videos/{videoId}/thumbnail`\n[**getDiscarded()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#getDiscarded) | Retrieve a discarded video object | **GET** `/discarded/videos/{videoId}`\n[**getStatus()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#getStatus) | Retrieve video status and details | **GET** `/videos/{videoId}/status`\n[**listDiscarded()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#listDiscarded) | List all discarded video objects | **GET** `/discarded/videos`\n[**updateDiscarded()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#updateDiscarded) | Update a discarded video object | **PATCH** `/discarded/videos/{videoId}`\n\n\n#### WatermarksApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WatermarksApi.md#upload) | Upload a watermark | **POST** `/watermarks`\n[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WatermarksApi.md#delete) | Delete a watermark | **DELETE** `/watermarks/{watermarkId}`\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WatermarksApi.md#list) | List all watermarks | **GET** `/watermarks`\n\n\n#### WebhooksApi\n\nMethod | Description | HTTP request\n------------- | ------------- | -------------\n[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#create) | Create Webhook | **POST** `/webhooks`\n[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#get) | Retrieve Webhook details | **GET** `/webhooks/{webhookId}`\n[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#delete) | Delete a Webhook | **DELETE** `/webhooks/{webhookId}`\n[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#list) | List all webhooks | **GET** `/webhooks`\n\n\n\n### Models\n\n - [AccessToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AccessToken.md)\n - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AdditionalBadRequestErrors.md)\n - [AnalyticsAggregatedMetricsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponse.md)\n - [AnalyticsAggregatedMetricsResponseContext](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponseContext.md)\n - [AnalyticsAggregatedMetricsResponseContextTimeframe](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponseContextTimeframe.md)\n - [AnalyticsData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsData.md)\n - [AnalyticsMetricsBreakdownResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponse.md)\n - [AnalyticsMetricsBreakdownResponseContext](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponseContext.md)\n - [AnalyticsMetricsBreakdownResponseData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponseData.md)\n - [AnalyticsMetricsOverTimeResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponse.md)\n - [AnalyticsMetricsOverTimeResponseContext](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponseContext.md)\n - [AnalyticsMetricsOverTimeResponseData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponseData.md)\n - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlays400Error.md)\n - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlaysResponse.md)\n - [AuthenticatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AuthenticatePayload.md)\n - [BadRequest](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/BadRequest.md)\n - [BytesRange](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/BytesRange.md)\n - [Caption](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Caption.md)\n - [CaptionsListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/CaptionsListResponse.md)\n - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/CaptionsUpdatePayload.md)\n - [Chapter](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Chapter.md)\n - [ChaptersListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/ChaptersListResponse.md)\n - [ConflictError](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/ConflictError.md)\n - [DiscardedVideoUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/DiscardedVideoUpdatePayload.md)\n - [FilterBy](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/FilterBy.md)\n - [FilterBy1](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/FilterBy1.md)\n - [FilterBy2](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/FilterBy2.md)\n - [Link](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Link.md)\n - [ListTagsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/ListTagsResponse.md)\n - [ListTagsResponseData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/ListTagsResponseData.md)\n - [LiveStream](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStream.md)\n - [LiveStreamAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamAssets.md)\n - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamCreationPayload.md)\n - [LiveStreamListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamListResponse.md)\n - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamUpdatePayload.md)\n - [Metadata](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Metadata.md)\n - [Model403ErrorSchema](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Model403ErrorSchema.md)\n - [NotFound](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/NotFound.md)\n - [Pagination](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Pagination.md)\n - [PaginationLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PaginationLink.md)\n - [PlayerSessionEvent](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerSessionEvent.md)\n - [PlayerTheme](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerTheme.md)\n - [PlayerThemeAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemeAssets.md)\n - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemeCreationPayload.md)\n - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemeUpdatePayload.md)\n - [PlayerThemesListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemesListResponse.md)\n - [Quality](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Quality.md)\n - [RefreshTokenPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RefreshTokenPayload.md)\n - [RestreamsRequestObject](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RestreamsRequestObject.md)\n - [RestreamsResponseObject](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RestreamsResponseObject.md)\n - [SummariesListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/SummariesListResponse.md)\n - [Summary](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Summary.md)\n - [SummaryCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/SummaryCreationPayload.md)\n - [SummarySource](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/SummarySource.md)\n - [SummaryUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/SummaryUpdatePayload.md)\n - [TokenCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenCreationPayload.md)\n - [TokenListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenListResponse.md)\n - [TooManyRequests](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TooManyRequests.md)\n - [UnrecognizedRequestUrl](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UnrecognizedRequestUrl.md)\n - [UploadToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UploadToken.md)\n - [Video](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Video.md)\n - [VideoAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoAssets.md)\n - [VideoClip](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoClip.md)\n - [VideoCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoCreationPayload.md)\n - [VideoSource](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSource.md)\n - [VideoSourceLiveStream](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStream.md)\n - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStreamLink.md)\n - [VideoStatus](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatus.md)\n - [VideoStatusEncoding](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusEncoding.md)\n - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusEncodingMetadata.md)\n - [VideoStatusIngest](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusIngest.md)\n - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusIngestReceivedParts.md)\n - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoThumbnailPickPayload.md)\n - [VideoUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoUpdatePayload.md)\n - [VideoWatermark](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoWatermark.md)\n - [VideosListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideosListResponse.md)\n - [Watermark](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Watermark.md)\n - [WatermarksListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/WatermarksListResponse.md)\n - [Webhook](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Webhook.md)\n - [WebhooksCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/WebhooksCreationPayload.md)\n - [WebhooksListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/WebhooksListResponse.md)\n\n\n### Rate Limiting\n\napi.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.\n\nIn this Node.js client, you can access these headers by using the `*WithResponseHeaders()` versions of the methods. These methods return both 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.\n\nRead more about these response headers in the [API reference](https://docs.api.video/reference#limitation).\n\nHere is an example of how to use these methods:\n\n```js\nconst client = new ApiVideoClient({ apiKey: \"YOUR_API_KEY\" });\nconst { body: videos, headers } = await client.videos.listWithResponseHeaders();\nconsole.log('Rate Limit:', headers['x-ratelimit-limit']);\nconsole.log('Rate Limit Remaining:', headers['x-ratelimit-remaining']);\nconsole.log('Rate Limit Retry after:', headers['x-ratelimit-retry-after']);\n```\n\n### Authorization\n\n#### API key\n\nMost endpoints required to be authenticated using the API key mechanism described in our [documentation](https://docs.api.video/reference#authentication).\nThe access token generation mechanism is automatically handled by the client.\n\nAll you have to do is provide an API key when instantiating the ApiVideoClient:\n```js\nconst client = new ApiVideoClient({ apiKey: \"YOUR_API_KEY\" });\n```\n\n#### Get the access token\n\nIf you need to access the access-token value obtained using the API key, you can use the getAccessToken() method of the client:\n```js\nconst client = new ApiVideoClient({ apiKey: \"YOUR_API_KEY\" });\nconst accessToken = await client.getAccessToken();\n```\n\n#### Public endpoints\n\nSome endpoints don't require authentication. These one can be called with an ApiVideoClient instantiated without API key:\n```js\nconst client = new ApiVideoClient();\n```\n\n## Have you gotten use from this API client?\n\nPlease take a moment to leave a star on the client ⭐\n\nThis helps other users to find the clients and also helps us understand which clients are most popular. Thank you!\n\n\n## Contribution\n\nSince 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](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapivideo%2Fapi.video-nodejs-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapivideo%2Fapi.video-nodejs-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapivideo%2Fapi.video-nodejs-client/lists"}