# @eigenpal/sdk 中文文档

规范地址：https://npmcn.com/package/%40eigenpal/sdk/

版本：0\.23\.15
npm 元数据更新时间：2026-11-13T12:20:54.536Z
中文译文更新时间：2026-11-13T09:39:00.292Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：568 kB，41 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-05-08T10:33:11.342Z
- 最新版本发布：2026-11-13T12:20:54.290Z
- 近 30 天下载量：13050（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：263（近 12 个月 263 个）

## 中文简介

EigenPal API 的官方类型脚本 SDK

## 安装

```sh
npm install @eigenpal/sdk
```

也可以使用：`pnpm add @eigenpal/sdk`、`yarn add @eigenpal/sdk`、`bun add @eigenpal/sdk`

## README

# @ eigenpal/ sdk

从TypeScript中触发并检查Eigenpal自动化.

[![npm](https://img.shields.io/npm/v/@eigenpal/sdk?color=3B5BDB&labelColor=555&label=npm)](https://www.npmjs.com/package/@eigenpal/sdk) [![downloads](https://img.shields.io/npm/dm/@eigenpal/sdk?color=3B5BDB&labelColor=555&label=downloads)](https://www.npmjs.com/package/@eigenpal/sdk) [![license](https://img.shields.io/badge/license-Apache--2.0-3B5BDB?labelColor=555)](https://github.com/eigenpal/sdk-typescript/blob/main/LICENSE)

## 安装

```bash
npm i @eigenpal/sdk
```

需要 TypeScript-aware 运行时间: Bun, Deno, Node 22+(本地 TS), `tsx`下个J,Vite,或者任何现代的组合。 平面 `node script.js` 将无法工作;见 [配置](https://npmcn.com/package/%40eigenpal/sdk/docs/configuration.md#typescript-runtime)。 。 。 .

获取 API 密钥 **sudio.eigenpal.com - > (中文(简体) ). 设置 - > API 密钥**。 。 。 .

## 快速启动

```ts
import { EigenpalClient } from '@eigenpal/sdk';

const client = new EigenpalClient({ apiKey: process.env.EIGENPAL_API_KEY });

const result = await client.run(
  'workflows.extract-invoice',
  { contract_document: file },
  { waitForCompletion: 60 }
);

if (result.finished) {
  console.log(result.output);
}
```

`target` 接受空工作流程ID, 如 `wf_abc`,或键入目标,例如 `workflows.<id-or-slug>` 或者说 `agents.<slug>`. Slugs需要前缀,因为工作流程和代理流可以重叠.

## 自动化

工作流程和代理被曝光为自动化.

```ts
const { data } = await client.automations.list({ search: 'invoice', folderId: 'fldr_…' });
const automation = await client.automations.get('workflows.extract-invoice');
await client.automations.move('workflows.extract-invoice', { folderPath: 'billing/invoices' });
await client.automations.delete('workflows.extract-invoice');
```

`list({ folderId: 'null' })` 返回租户根上未存档的 YAML 工作流程。 代理自动化器没有文件夹模型.

Workflow 删除自动化父文档并保存执行历史. 代理删除删除代理执行和历史,匹配仪表板,并有最佳的剩余存储清理.

## 文件夹

工作流程和模板树是一等资源. Git 中的 Nested代理目录仅是源组织.

```ts
const tree = await client.folders.list({ type: 'workflow', tree: 'true' });
const folder = await client.folders.create({ name: 'invoices', type: 'workflow' });
await client.folders.update(folder.id, { name: 'billing' });
await client.folders.delete(folder.id); // unfiles workflows; does not delete them
```

## 运行

```ts
const { id } = await client.run('agents.invoice-agent', { invoice: file });

const run = await client.runs.get(id, { expand: ['usage', 'execution'] });
const usage = await client.runs.usage(id);
const steps = await client.runs.steps(id);
const events = await client.runs.events(id);
const trace = await client.runs.trace.get(id);

await client.runs.cancel(id);
await client.rerun(id, { waitForCompletion: 60 });
```

列表呼叫在工作流程,代理,手动运行和eval运行中使用相同的运行 API:

```ts
const recentFailures = await client.runs.list({
  type: 'workflow',
  status: 'failed,cancelled',
  limit: 50,
});
```

## 文件与艺术

使用 `client.files` 用于重用上传的第一个blobs。 当通过运行输入引用时,Eigenpal将文件快照到运行范围文物.

```ts
const uploaded = await client.files.upload(file);

const started = await client.run('workflows.extract-invoice', {
  contract_document: { $fileId: uploaded.id },
});

const artifacts = await client.runs.artifacts.list(started.id);
const pdf = await client.runs.artifacts.download(started.id, artifacts.artifacts[0].path);
```

也可以通过一个 `File`, (中文(简体) ), `Blob`,或 `{ content, filename, mimeType }` 直接转到 `client.run`; SDK 自动发送多段形式数据. 持久运行输入和数据集实例存储范围d `{ "$file": "input/..." }` 文物在摄入后会反射.

## 错误

每个非-2xx响应都投出一个打入的子类: `EigenpalError`数字 :

| HTTP 密码 | 类 |
| --- | --- |
| 400个 | `EigenpalValidationError` |
| 401 (中文(简体) ) | `EigenpalAuthError` |
| 403 (韩语) | `EigenpalForbiddenError` |
| 404 (韩语) | `EigenpalNotFoundError` |
| 429个 | `EigenpalRateLimitError` |
| 5 (简体中文) | `EigenpalServerError` |
| 超时/ 中止 | `EigenpalTimeoutError` |

## 参考文献

| 专题 | 里面有什么东西 |
| --- | --- |
| [自动化](https://npmcn.com/package/%40eigenpal/sdk/docs/workflows.md) | 列表,检查,移动,删除,版本,触发器,文件夹. |
| [运行](https://npmcn.com/package/%40eigenpal/sdk/docs/executions.md) | 开始,民意调查,取消,再运行,使用,步骤,事件,痕迹,审查. |
| [文件输入](https://npmcn.com/package/%40eigenpal/sdk/docs/files.md) | 从文件, Blob, 缓冲, 或路径上传多段 . |
| [错误](https://npmcn.com/package/%40eigenpal/sdk/docs/errors.md) | 已打出例外,复试,请求代号. |
| [配置](https://npmcn.com/package/%40eigenpal/sdk/docs/configuration.md) | API 密钥, BaseUrl , 超时, 标题 . |
| [完整 API 参考](https://npmcn.com/package/%40eigenpal/sdk/docs/reference.md) | 每一种方法,均由OpenAPI生成. |

## 许可证

阿帕奇2.0 (英语).

## 常见问题

### @eigenpal/sdk 是什么？

EigenPal API 的官方类型脚本 SDK

### 如何安装 @eigenpal/sdk？

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

### @eigenpal/sdk 支持 TypeScript 吗？

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

### @eigenpal/sdk 支持 ESM 还是 CommonJS？

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

### @eigenpal/sdk 可以商用吗？

@eigenpal/sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @eigenpal/sdk 的下载量有多少？

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

### @eigenpal/sdk 还在维护吗？

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