# @api\.video/nodejs-client 中文文档

规范地址：https://npmcn.com/package/%40api.video/nodejs-client/

版本：2\.6\.8
npm 元数据更新时间：2025-05-22T12:50:37.290Z
中文译文更新时间：2026-11-06T09:54:35.234Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40api.video/nodejs-client
原文对照：https://npmcn.com/package/%40api.video/nodejs-client/?lang=original
项目主页：https://github.com/apivideo/api.video-nodejs-client#readme
源码仓库：https://github.com/apivideo/api.video-nodejs-client

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.1 MB，308 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2021-05-25T11:49:13.674Z
- 最新版本发布：2024-11-08T12:49:08.958Z
- 近 30 天下载量：12074（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 0 个）

## 中文简介

api.video nodejs API 客户端

## 安装

```sh
npm install @api.video/nodejs-client
```

也可以使用：`pnpm add @api.video/nodejs-client`、`yarn add @api.video/nodejs-client`、`bun add @api.video/nodejs-client`

## README

[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-nodejs-client?style=social)](https://github.com/apivideo/api.video-nodejs-client)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video/) ![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png)

# api.video Node.js 客户端

[视频](https://api.video/) 是产品制造者的视频基础设施。 闪电快视频 API 用于在您的应用程序中集成,缩放,并管理点播后低空直播功能.

## 目录

-   [项目说明](https://npmcn.com/package/%40api.video/nodejs-client/#readme-project-description)
-   [开始](https://npmcn.com/package/%40api.video/nodejs-client/#readme-getting-started)
    -   [安装](https://npmcn.com/package/%40api.video/nodejs-client/#readme-installation)
    -   [移徙](https://npmcn.com/package/%40api.video/nodejs-client/#readme-migration)
    -   [发展](https://npmcn.com/package/%40api.video/nodejs-client/#readme-development)
    -   [代码样本](https://npmcn.com/package/%40api.video/nodejs-client/#readme-code-sample)
-   [文档](https://npmcn.com/package/%40api.video/nodejs-client/#readme-documentation)
    -   [API 终点](https://npmcn.com/package/%40api.video/nodejs-client/#readme-api-endpoints)
        -   [分析学](https://npmcn.com/package/%40api.video/nodejs-client/#readme-analyticsapi)
        -   [说明Api](https://npmcn.com/package/%40api.video/nodejs-client/#readme-captionsapi)
        -   [章节Api](https://npmcn.com/package/%40api.video/nodejs-client/#readme-chaptersapi)
        -   [LiveStreams 亚庇](https://npmcn.com/package/%40api.video/nodejs-client/#readme-livestreamsapi)
        -   [玩家主题Api](https://npmcn.com/package/%40api.video/nodejs-client/#readme-playerthemesapi)
        -   [摘要Api](https://npmcn.com/package/%40api.video/nodejs-client/#readme-summariesapi)
        -   [标签Api](https://npmcn.com/package/%40api.video/nodejs-client/#readme-tagsapi)
        -   [上传托肯斯Api](https://npmcn.com/package/%40api.video/nodejs-client/#readme-uploadtokensapi)
        -   [视频Api](https://npmcn.com/package/%40api.video/nodejs-client/#readme-videosapi)
        -   [水上标记Api](https://npmcn.com/package/%40api.video/nodejs-client/#readme-watermarksapi)
        -   [网络用户](https://npmcn.com/package/%40api.video/nodejs-client/#readme-webhooksapi)
    -   [模型](https://npmcn.com/package/%40api.video/nodejs-client/#readme-models)
    -   [限制费率](https://npmcn.com/package/%40api.video/nodejs-client/#readme-rate-limiting)
    -   [授权](https://npmcn.com/package/%40api.video/nodejs-client/#readme-authorization)
        -   [API 密钥](https://npmcn.com/package/%40api.video/nodejs-client/#readme-api-key)
        -   [获取访问符](https://npmcn.com/package/%40api.video/nodejs-client/#readme-get-the-access-token)
        -   [公共终点](https://npmcn.com/package/%40api.video/nodejs-client/#readme-public-endpoints)
-   [你从这个API客户端得到了使用吗?](https://npmcn.com/package/%40api.video/nodejs-client/#readme-have-you-gotten-use-from-this-api-client-)
-   [捐款](https://npmcn.com/package/%40api.video/nodejs-client/#readme-contribution)

## 项目说明

api.video的Java Node.js是一个轻量级客户端,构建于 `TypeScript` 简化了编码程序。 弹簧文件是为你处理的, 以及重新刷新您的符号.

## 开始

### 安装

与 `npm`数字 :

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

...或者说 `yarn`数字 :

```
yarn add @api.video/nodejs-client
```

### 移徙

如果你来自 [@api.video/nodejs-sdk (英语)](https://github.com/apivideo/nodejs-sdk) 确保阅读我们的 [移徙指南](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/MIGRATE.md) 先说.

### 发展

要构建和编译用于 Javascript 的打字源 :

```
npm install
npm run build
```

### 代码样本

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

## 文档

### API 终点

#### 分析学

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**获得分类计量( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getAggregatedMetrics) | 检索汇总指标 | **获取** `/data/metrics/{metric}/{aggregation}` |
| [**获得分解量( C)**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getMetricsBreakdown) | 在分解维度时检索度量衡 | **获取** `/data/buckets/{metric}/{breakdown}` |
| [**获取计量全时 ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getMetricsOverTime) | 随着时间的推移检索衡量标准 | **获取** `/data/timeseries/{metric}` |

#### 说明Api

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**上传( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#upload) | 上传标题 | **邮政** `/videos/{videoId}/captions/{language}` |
| [**获取()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#get) | 获取标题 | **获取** `/videos/{videoId}/captions/{language}` |
| [**更新()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#update) | 更新标题 | **帕齐** `/videos/{videoId}/captions/{language}` |
| [**删除( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#delete) | 删除标题 | **迪莱特** `/videos/{videoId}/captions/{language}` |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#list) | 列出视频标题 | **获取** `/videos/{videoId}/captions` |

#### 章节Api

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**上传( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#upload) | 上传一章 | **邮政** `/videos/{videoId}/chapters/{language}` |
| [**获取()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#get) | 获取一章 | **获取** `/videos/{videoId}/chapters/{language}` |
| [**删除( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#delete) | 删除一章 | **迪莱特** `/videos/{videoId}/chapters/{language}` |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#list) | 列出视频章节 | **获取** `/videos/{videoId}/chapters` |

#### LiveStreams 亚庇

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**创建()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#create) | 创建活流 | **邮政** `/live-streams` |
| [**获取()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#get) | 获取活流 | **获取** `/live-streams/{liveStreamId}` |
| [**更新()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#update) | 更新实时流 | **帕齐** `/live-streams/{liveStreamId}` |
| [**删除( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#delete) | 删除活流 | **迪莱特** `/live-streams/{liveStreamId}` |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#list) | 列出所有活流 | **获取** `/live-streams` |
| [**上传Thumbnail ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#uploadThumbnail) | 上传缩略图 | **邮政** `/live-streams/{liveStreamId}/thumbnail` |
| [**删除 Thumbnail ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#deleteThumbnail) | 删除缩略图 | **迪莱特** `/live-streams/{liveStreamId}/thumbnail` |
| [**完整( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#complete) | 完成一个直播流 | **点** `/live-streams/{liveStreamId}/complete` |

#### 玩家主题Api

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**创建()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#create) | 创建玩家 | **邮政** `/players` |
| [**获取()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#get) | 获取玩家 | **获取** `/players/{playerId}` |
| [**更新()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#update) | 更新玩家 | **帕齐** `/players/{playerId}` |
| [**删除( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#delete) | 删除玩家 | **迪莱特** `/players/{playerId}` |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#list) | 列出所有玩家主题 | **获取** `/players` |
| [**上传Logo ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#uploadLogo) | 上传标志 | **邮政** `/players/{playerId}/logo` |
| [**删除Logo ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#deleteLogo) | 删除标志 | **迪莱特** `/players/{playerId}/logo` |

#### 摘要Api

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**创建()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#create) | 生成视频摘要 | **邮政** `/summaries` |
| [**更新()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#update) | 更新概要细节 | **帕齐** `/summaries/{summaryId}/source` |
| [**删除( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#delete) | 删除视频摘要 | **迪莱特** `/summaries/{summaryId}` |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#list) | 清单摘要 | **获取** `/summaries` |
| [**获取简要来源( C)**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/SummariesApi.md#getSummarySource) | 获取摘要细节 | **获取** `/summaries/{summaryId}/source` |

#### 标签Api

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/TagsApi.md#list) | 列出所有视频标签 | **获取** `/tags` |

#### 上传托肯斯Api

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**创建Token ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#createToken) | 生成上传符号 | **邮政** `/upload-tokens` |
| [**获取Token ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#getToken) | 获取上传令牌 | **获取** `/upload-tokens/{uploadToken}` |
| [**删除 Token ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#deleteToken) | 删除上传符号 | **迪莱特** `/upload-tokens/{uploadToken}` |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#list) | 列出所有活动上传符号 | **获取** `/upload-tokens` |

#### 视频Api

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**创建()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#create) | 创建视频对象 | **邮政** `/videos` |
| [**上传( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#upload) | 上传视频 | **邮政** `/videos/{videoId}/source` |
| [**用 Upload Token () 上传**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#uploadWithUploadToken) | 使用授权的上传令牌上传 | **邮政** `/upload` |
| [**获取()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#get) | 获取视频对象 | **获取** `/videos/{videoId}` |
| [**更新()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#update) | 更新视频对象 | **帕齐** `/videos/{videoId}` |
| [**删除( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#delete) | 删除视频对象 | **迪莱特** `/videos/{videoId}` |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#list) | 列出所有视频对象 | **获取** `/videos` |
| [**上传Thumbnail ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#uploadThumbnail) | 上传缩略图 | **邮政** `/videos/{videoId}/thumbnail` |
| [**选择Thumbnail( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#pickThumbnail) | 设置缩略图 | **帕齐** `/videos/{videoId}/thumbnail` |
| [**被丢弃 ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#getDiscarded) | 获取已丢弃的视频对象 | **获取** `/discarded/videos/{videoId}` |
| [**获取状态( C)**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#getStatus) | 获取视频状态和细节 | **获取** `/videos/{videoId}/status` |
| [**列表已丢弃 ()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#listDiscarded) | 列出所有已丢弃的视频对象 | **获取** `/discarded/videos` |
| [**更新已丢弃( C)**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#updateDiscarded) | 更新已丢弃的视频对象 | **帕齐** `/discarded/videos/{videoId}` |

#### 水上标记Api

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**上传( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WatermarksApi.md#upload) | 上传水印 | **邮政** `/watermarks` |
| [**删除( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WatermarksApi.md#delete) | 删除一个水印 | **迪莱特** `/watermarks/{watermarkId}` |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WatermarksApi.md#list) | 列出所有水印 | **获取** `/watermarks` |

#### 网络用户

| 方法 | 说明 | HTTP 请求 |
| --- | --- | --- |
| [**创建()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#create) | 创建 Webhook | **邮政** `/webhooks` |
| [**获取()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#get) | 获取 Webhook 细节 | **获取** `/webhooks/{webhookId}` |
| [**删除( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#delete) | 删除一个 Webhook | **迪莱特** `/webhooks/{webhookId}` |
| [**列表( )**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#list) | 列出所有网点 | **获取** `/webhooks` |

### 模型

-   [访问脚本](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AccessToken.md)
-   [附加失败请求错误](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AdditionalBadRequestErrors.md)
-   [分析](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponse.md)
-   [分析](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponseContext.md)
-   [分析](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponseContextTimeframe.md)
-   [分析数据](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsData.md)
-   [分析计量分解反应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponse.md)
-   [分析计量分解响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponseContext.md)
-   [分析计量分类响应数据](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponseData.md)
-   [分析计量 超时响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponse.md)
-   [分析计量 超时响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponseContext.md)
-   [分析计量 超时响应数据](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponseData.md)
-   [分析 Plays400 错误](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlays400Error.md)
-   [分析程序响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlaysResponse.md)
-   [认证文件](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AuthenticatePayload.md)
-   [错误请求](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/BadRequest.md)
-   [字节行距](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/BytesRange.md)
-   [说明](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Caption.md)
-   [说明列表回复](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/CaptionsListResponse.md)
-   [说明 更新日期](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/CaptionsUpdatePayload.md)
-   [章 次 页 次](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Chapter.md)
-   [章节列表回复](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/ChaptersListResponse.md)
-   [冲突错误](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/ConflictError.md)
-   [已丢弃的视频更新文件](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/DiscardedVideoUpdatePayload.md)
-   [过滤By](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/FilterBy.md)
-   [过滤By1](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/FilterBy1.md)
-   [过滤By2](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/FilterBy2.md)
-   [链接](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Link.md)
-   [列表标签响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/ListTagsResponse.md)
-   [列表响应数据](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/ListTagsResponseData.md)
-   [活体结构](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStream.md)
-   [生活结构](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamAssets.md)
-   [LiveStream 创造费](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamCreationPayload.md)
-   [LiveStream List 反应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamListResponse.md)
-   [LiveStream Update Payload 下载](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamUpdatePayload.md)
-   [元数据](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Metadata.md)
-   [模型403 错误计划](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Model403ErrorSchema.md)
-   [无果](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/NotFound.md)
-   [倾斜](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Pagination.md)
-   [连接](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PaginationLink.md)
-   [玩家会话事件](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerSessionEvent.md)
-   [玩家主题](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerTheme.md)
-   [玩家主题集](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemeAssets.md)
-   [玩家主题 创建Payload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemeCreationPayload.md)
-   [玩家主题 更新 Payload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemeUpdatePayload.md)
-   [玩家主题列表响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemesListResponse.md)
-   [质量](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Quality.md)
-   [刷新托肯页](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RefreshTokenPayload.md)
-   [复流请求对象](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RestreamsRequestObject.md)
-   [复流响应对象](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RestreamsResponseObject.md)
-   [摘要](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/SummariesListResponse.md)
-   [内容提要](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Summary.md)
-   [简编](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/SummaryCreationPayload.md)
-   [来源摘要](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/SummarySource.md)
-   [简况](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/SummaryUpdatePayload.md)
-   [托肯创建](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenCreationPayload.md)
-   [TokenList 响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenListResponse.md)
-   [太多请求](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TooManyRequests.md)
-   [未识别请求Url](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UnrecognizedRequestUrl.md)
-   [上传文件夹](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UploadToken.md)
-   [视频](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Video.md)
-   [视频集](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoAssets.md)
-   [视频剪辑](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoClip.md)
-   [视频创建](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoCreationPayload.md)
-   [视频来源](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSource.md)
-   [视频源代码Stream](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStream.md)
-   [视频源代码StreamLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStreamLink.md)
-   [视频状态](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatus.md)
-   [视频状态编码](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusEncoding.md)
-   [视频状态编码元数据](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusEncodingMetadata.md)
-   [视频状态](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusIngest.md)
-   [视频状态接收组件](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusIngestReceivedParts.md)
-   [视频ThumbnailPickPayload 下载](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoThumbnailPickPayload.md)
-   [视频更新Payload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoUpdatePayload.md)
-   [视频水印](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoWatermark.md)
-   [视频列表响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideosListResponse.md)
-   [水印](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Watermark.md)
-   [水印列表响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/WatermarksListResponse.md)
-   [网页](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Webhook.md)
-   [Webhooks 创建](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/WebhooksCreationPayload.md)
-   [网络用户列表响应](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/WebhooksListResponse.md)

### 限制费率

api.video执行限制费率,以确保服务的公平使用和稳定性。 API为您提出的任何 API 请求提供响应头中的速率限制值. /auth终点是唯一没有费率限制的路线.

在这个Node.js客户端中,您可以通过使用 `*WithResponseHeaders()` 方法的版本。 这些方法既返回反应体,又返回信头,允许您检查 `X-RateLimit-Limit`, (中文(简体) ), `X-RateLimit-Remaining`,以及 `X-RateLimit-Retry-After` 要了解您当前利率限制状态的页眉 .

更多信息,请访问 [API 参考](https://docs.api.video/reference#limitation)。 。 。 .

以下是如何使用这些方法的例子:

```js
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const { body: videos, headers } = await client.videos.listWithResponseHeaders();
console.log('Rate Limit:', headers['x-ratelimit-limit']);
console.log('Rate Limit Remaining:', headers['x-ratelimit-remaining']);
console.log('Rate Limit Retry after:', headers['x-ratelimit-retry-after']);
```

### 授权

#### API 密钥

多数终点需要使用我们描述的API关键机制进行认证 [文档](https://docs.api.video/reference#authentication)。 。 。 . 访问符生成机制由客户端自动处理.

您只需要提供一个 API 键, 当即时 ApiVideoClient :

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

#### 获取访问符

如果您需要访问使用 API 密钥获得的存取键值, 您可以使用客户端的获取 AccessToken () 方法 :

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

#### 公共终点

一些端点不需要认证. 这些可以使用没有 API 键的 ApiVideoClient 即时调用:

```js
const client = new ApiVideoClient();
```

## 你从这个API客户端得到了使用吗?

请花点时间给客户留下一颗星星

这有助于其他用户找到客户,也帮助我们了解哪些客户最受欢迎. 谢谢!

## 捐款

由于这个API客户端是由OpenAPI描述生成的,我们不能接受直接向寄存器提出的拉取请求. 如果你想贡献,你可以打开拉 请求我们的仓库 [客户端生成器](https://github.com/apivideo/api-client-generator)。否则,您也可以简单地打开一个问题,详述您在这个寄存器库中的需要.

## 常见问题

### @api\.video/nodejs-client 是什么？

api\.video nodejs API 客户端

### 如何安装 @api\.video/nodejs-client？

在项目目录运行 npm install @api\.video/nodejs-client，或使用 pnpm add / yarn add / bun add。

### @api\.video/nodejs-client 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @api\.video/nodejs-client 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @api\.video/nodejs-client 可以商用吗？

@api\.video/nodejs-client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @api\.video/nodejs-client 的下载量有多少？

根据 npm 官方下载统计，@api\.video/nodejs-client 在 2026/10/06 – 2026/11/04 这 30 天内被下载 12,074 次，日均约 402 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @api\.video/nodejs-client 还在维护吗？

最新版本 2\.6\.8 发布于 2024/11/08（2 年前）；至今共发布 46 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/05/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。