# @cargo-ai/api 中文文档

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

版本：1\.0\.108
npm 元数据更新时间：2026-11-09T07:05:11.981Z
中文译文更新时间：2026-11-09T03:06:51.682Z
软件包许可：UNLICENSED

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

原始 npm 页面：https://www.npmjs.com/package/%40cargo-ai/api
原文对照：https://npmcn.com/package/%40cargo-ai/api/?lang=original
项目主页：https://www.getcargo.ai/
源码仓库：https://github.com/getcargohq/cargo

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

- 包体积（解压后）：1 MB，141 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：2 个
- peer 依赖：zod ^4\.4\.3
- 首次发布：2026-02-17T18:03:07.122Z
- 最新版本发布：2026-11-09T07:05:11.814Z
- 近 30 天下载量：94582（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：105（近 12 个月 105 个）

## 中文简介

货运API所打入的TypeScript客户端——模型和记录,管弦运行和分批,连接器和集成,代理,分块,以及计费. 货代CLI背后的方案面.

## 安装

```sh
npm install @cargo-ai/api
```

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

## README

# 货物 API

类型脚本客户端 [货物 API](https://docs.getcargo.ai/api-reference/introduction). 使用它来管理数据模型,协调工作流程,构建AI代理,并和来自Node.js或浏览器的Cargo平台相融合.

**API 参考 :** [文件.getcargo.ai/参考/介绍](https://docs.getcargo.ai/api-reference/introduction)

## 安装

```bash
npm install @cargo-ai/api
```

## 同伴依赖关系

`@cargo-ai/api` 取决于 **@ cargo-ai/ 类型** 财务报告和审定财务报表 **@ cargo-ai/ 用户**并同时出版。 如果您的环境尚未提供, 请安装 :

```bash
npm install @cargo-ai/types @cargo-ai/utils
```

## 使用量

### 构建 API 客户端

通过调用创建 API 客户端 `buildApi` 使用您的 API 令牌( 守护符 ) :

```ts
import { buildApi } from "@cargo-ai/api";

const api = buildApi({
  accessToken: "YOUR_API_TOKEN",
});

// Use domain APIs
const datasets = await api.storage.dataset.all();
const workflows = await api.orchestration.workflow.all();
```

`baseUrl` 默认为 `https://api.getcargo.io`。如果需要针对不同的环境:

```ts
const api = buildApi({
  baseUrl: "https://custom-api.example.com",
  accessToken: "YOUR_API_TOKEN",
});
```

**客户行为 :** HTTP请求使用6分钟超时. 长期运行的操作(如同步,运行)可能需要通过其他方式进行民意调查或观察;参见API参考.

### 域客户端和类型

软件包导出类型 **域名** 命名空间和 API 模块用于:

-   **爱** - AI资源、代理、MCP服务器、文件
-   **计费** - 订阅和账单
-   **连接** - 连接器、集成器、过滤器
-   **内容** - 知识档案和图书馆
-   **A. 背景情况** - 上下文存储器、运行时沙盒、知识图
-   **表达式** - 表达式和公式助手
-   **托管** - 货物托管应用程序、工人、部署、inv vars、定制域
-   **管弦** - 工作流程、剧作、工具、模板
-   **收入组织** - 成员、能力、领土
-   **分块** - 部分,变化
-   **存储** - 数据集、模型、关系、列
-   **记录系统集成** - 记录系统,客户
-   **用户管理** - 用户和权限
-   **工作空间管理** - 工作空间、文件夹、角色、符号

每个域都暴露 **子区域** 在API的例子。 实例:

| 域名 | 分地区(如:. `api.<domain>.<sub>`(中文(简体) ) |
| --- | --- |
| **爱** | 模板、代理、发布、聊天、消息、投票、文档、mcpServer、mcpClient、 即时、内存、文件、建议的行动 |
| **计费** | 使用、订阅 |
| **连接** | 连接器、 集成、 本地集成 |
| **内容** | 文件, 库 |
| **A. 背景情况** | 仓库、运行时间、图表 |
| **表达式** | 最喜欢的食谱、食谱、表达式 |
| **托管** | 应用、工人、部署、掩体、自定义域 |
| **管弦** | 批量、工作流程、播放、工具、发布、草稿、释放、运行、记录、节点、模板 |
| **收入组织** | 分配、能力、成员、领土 |
| **分块** | 段、 更改、 记录 |
| **存储** | 列、数据集、模型、关系、运行、记录 |
| **记录系统集成** | 系统记录、客户端、日志 |
| **用户管理** | 用户 |
| **工作空间管理** | 工作空间、文件、用户、符号、角色、文件夹 |

使用域类型(来自 `@cargo-ai/api` 或者说 `@cargo-ai/types`请求/答复打字和API实例`api.storage`, (中文(简体) ), `api.connection`等),用于HTTP呼叫.

### 更多使用实例

```ts
// Create a connector – a dataset is automatically created for each connector.
const { connector, dataset } = await api.connection.connector.create({
  name: "My HubSpot",
  slug: "my-hubspot",
  integrationSlug: "hubspot",
  config: {
    /* integration-specific credentials / settings */
  },
});

// List storage runs for a model
const runs = await api.storage.run.list({ modelUuid: "...", limit: 20 });

// List orchestration runs with filters
const orchestrationRuns = await api.orchestration.run.list({
  workflowUuid: "...",
  statuses: ["success"],
});
```

### 处理错误

```ts
import { determineIfIsFetcherError, type FetcherError } from "@cargo-ai/api";

try {
  await api.storage.dataset.get("...");
} catch (err) {
  if (determineIfIsFetcherError(err)) {
    const fetcherError = err as FetcherError;
    console.error(fetcherError.status, fetcherError.body);
  }
}
```

## 所需资源

-   节点.js 22.x
-   类型脚本( 类型)

## 资源

-   **[货物 API 参考文献](https://docs.getcargo.ai/api-reference/introduction)** - 终点、认证和平台概念(Datasets、模型、连接器、工具、游戏、代理等)
-   API 令牌: 在您的工作空间中创建 **设置 – API**

## 许可证

许可证信息请参见寄存器的根.

## 常见问题

### @cargo-ai/api 是什么？

货运API所打入的TypeScript客户端——模型和记录,管弦运行和分批,连接器和集成,代理,分块,以及计费\. 货代CLI背后的方案面\.

### 如何安装 @cargo-ai/api？

在项目目录运行 npm install @cargo-ai/api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.4\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cargo-ai/api 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cargo-ai\_\_api 是否存在。

### @cargo-ai/api 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

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

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

### @cargo-ai/api 可以商用吗？

@cargo-ai/api 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @cargo-ai/api 的下载量有多少？

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

### @cargo-ai/api 还在维护吗？

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