# @air/api-sdk 中文文档

规范地址：https://npmcn.com/package/%40air/api-sdk/

版本：0\.12\.0
npm 元数据更新时间：2026-11-05T20:24:39.829Z
中文译文更新时间：2026-11-05T22:46:44.116Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：5.3 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：2 个
- 首次发布：2026-03-27T16:31:30.200Z
- 最新版本发布：2026-11-05T20:24:39.613Z
- 近 30 天下载量：10915（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

Air API SDK - 为Air.inc API提供完整的SDK

## 安装

```sh
npm install @air/api-sdk
```

也可以使用：`pnpm add @air/api-sdk`、`yarn add @air/api-sdk`、`bun add @air/api-sdk`

## README

# @ air/ api- sdk

已键入 JavaScript/ TypeScript SDK [空运](https://air.inc/) API (英语).

这是您应该安装的主要软件包 。 它再出口所有的东西 `@air/api-core` 财务报告和审定财务报表 `@air/api-rest`。 。 。 .

## 安装

```bash
npm install @air/api-sdk
```

## 快开始

```ts
import { AirApi } from "@air/api-sdk";

const air = new AirApi({
  apiKey: "your-api-key",
  workspaceId: "your-workspace-id",
});

// List boards
const page = await air.boards.list();
console.log(page.data);
```

### 环境变量

您可以设置环境变量,而不是直接传递选项:

```bash
export AIR_API_KEY=your-api-key
export AIR_WORKSPACE_ID=your-workspace-id
```

```ts
const air = new AirApi(); // reads from env
```

## 配置

```ts
const air = new AirApi({
  apiKey: "your-api-key", // or AIR_API_KEY env var
  workspaceId: "your-workspace-id", // or AIR_WORKSPACE_ID env var
  baseURL: "https://api.air.inc/v1", // default
  maxRetries: 3, // default, with exponential backoff
  timeout: 60_000, // default, in milliseconds
  defaultHeaders: {
    // optional, sent with every request
    "user-agent": "my-app/1.0",
    "x-custom-header": "value",
  },
});
```

## 资源

-   董事会: `air.boards.*` (列表、获取、创建、更新、删除、来宾、自定义字段、共享链接)
-   显示大小写 : `air.showcases.*` (列表、 获取、 创建、 更新、 更新ShareLink、 添加Assets、 删除Asset、 添加Boards、 删除Board)
-   资产: `air.assets.*` (列表、获取、删除、版本、自定义字段、标签、CDN链接、共享链接)
-   标记 : `air.tags.*` (列表,获取,创建,更新,删除)
-   自定义字段 : `air.customFields.*` (列表、创建、更新、删除、数值)
-   讨论: `air.discussions.*` (列表、 获取、 列表Comments、 创建、 创建、 Comment、 更新、 更新Comment、 删除Comment)
-   成员: `air.members.list`
-   角色 : `air.roles.*` (名单)
-   上传 : `air.uploads.*` (上载有进度跟踪的文件,大型文件的多部分)
-   导入 : `air.imports.*` (创建,获取状态)

## 倾斜

列表方法返回a `PagePromise` 支持自动涂鸦的:

```ts
for await (const asset of air.assets.list({ limit: 50 })) {
  console.log(asset.id);
}
```

或手动标注 :

```ts
const page = await air.assets.list({ limit: 50 });
console.log(page.data);
if (page.hasNextPage()) {
  const next = await page.getNextPage();
}
```

## 处理错误

所有 API 错误扩展 `APIError`根据 HTTP 状态抛出特定错误类别( 400) `BadRequestError`, 401 (中文(简体) ) `AuthenticationError`,第403页 `PermissionError`页:1 `NotFoundError`429个 `RateLimitError`, 500+ (单位:千美元) `InternalServerError`) (中文(简体) ). 可重试错误会自动以指数回放重试.

## 文档

-   [空气开发者 Docs](https://developer.air.inc/) API 参考和指南
-   [GitHub 仓库](https://github.com/AirLabsTeam/air-api-sdk) 源代码和示例

## 许可证

麻省理工学院

## 常见问题

### @air/api-sdk 是什么？

Air API SDK - 为Air\.inc API提供完整的SDK

### 如何安装 @air/api-sdk？

在项目目录运行 npm install @air/api-sdk，或使用 pnpm add / yarn add / bun add。

### @air/api-sdk 支持 TypeScript 吗？

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

### @air/api-sdk 支持 ESM 还是 CommonJS？

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

### @air/api-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @air/api-sdk 可以商用吗？

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

### @air/api-sdk 的下载量有多少？

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

### @air/api-sdk 还在维护吗？

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