# @ai-matrx/api 中文文档

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

版本：0\.1\.105
npm 元数据更新时间：2026-10-30T11:51:40.968Z
中文译文更新时间：2026-11-05T18:59:54.955Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40ai-matrx/api
原文对照：https://npmcn.com/package/%40ai-matrx/api/?lang=original
项目主页：https://github.com/AI-Matrix-Engine/aidream/tree/main/apps/shared/api#readme
源码仓库：https://github.com/AI-Matrix-Engine/aidream

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

- 包体积（解压后）：17.7 MB，167 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：3 个
- 首次发布：2026-10-09T05:17:58.048Z
- 最新版本发布：2026-10-30T11:51:40.764Z
- 近 30 天下载量：49197（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：107（近 12 个月 107 个）

## 中文简介

每个应用程序与每个AI Matrx 服务器交谈的方法之一: 由服务器合同生成,按域分割,所以一个应用程序只加载它所呼叫的请求. 运输,五种证书类型,组织捆绑,流出,工作随行. 没有屏幕、应用程序状态或 dat

## 安装

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

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

## README

# @ ai- matrx/ api

每个应用程序对每个 AI Matrx 服务器说话的方法。 从服务器合同中生成并按区域分割,因此一个应用程序只加载它所呼叫的请求. 它从不持有屏幕,应用程序状态或数据库代码.

```ts
import { createApi } from "@ai-matrx/api";
import { listAssets } from "@ai-matrx/api/files";

const api = createApi({ credentials: { kind: "api_key", apiKey: process.env.MATRX_API_KEY! }, organizationId });
const page = await listAssets(api, { query: { limit: 50 } });
```

-   **全权证书** - 一种设定:证书、获得者或 `CredentialsPort` (单位:千美元)`user`, (中文(简体) ), `guest`, (中文(简体) ), `api_key`, (中文(简体) ), `service`, (中文(简体) ), `scoped`) (中文(简体) ).
-   **组织** ——捆绑一次;按每个业务的合同规则发送(要求/可选/免责).
-   **路线** ——每个行动知道哪些部署答案;使用 `baseUrls` 或者说 `resolveBaseUrl`。 。 。 .
-   **流线** NDJSON/SSE操作返回可同步操作; `*_or_json` 业务返回 `{ kind: "json" } | { kind: "stream" }`。 。 。 .
-   **节** —— 说 `@ai-matrx/api/<domain>` 每个域, `/schemas`, (中文(简体) ), `/types` (仅类型) `components`编号 :`paths` 视图), `/stream`, (中文(简体) ), `/net`, (中文(简体) ), `/credentials`。导入一个域不会加载其他域的代码.

服务器合同变更后再生 : `node scripts/generate.mjs` (输入:助药) `api-contract/`) (中文(简体) ). `--check` 在漂移时失败.

## 盖茨

`pnpm check:package` 运行生成器 `--check`、建设、出口协议、publint和部门探测器(`scripts/section-probe.mjs`:没有域段加载了另一个域的代码;一个导入的操作捆绑了完全一个操作描述符.

## 常见问题

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

每个应用程序与每个AI Matrx 服务器交谈的方法之一: 由服务器合同生成,按域分割,所以一个应用程序只加载它所呼叫的请求\. 运输,五种证书类型,组织捆绑,流出,工作随行\. 没有屏幕、应用程序状态或 dat

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

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

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

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

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

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

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

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

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

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

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

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

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

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