# @cloro-dev/cloro 中文文档

规范地址：https://npmcn.com/package/%40cloro-dev/cloro/

版本：0\.4\.0
npm 元数据更新时间：2026-11-07T20:19:47.035Z
中文译文更新时间：2026-11-10T02:12:50.723Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：115 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-07-13T16:16:57.021Z
- 最新版本发布：2026-11-07T20:19:46.717Z
- 近 30 天下载量：10133（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

Clano API的官方TypeScript/Node SDK:一个API用于Google搜索和每个AI答引擎(ChatGPT,双子座,AI Overview,AI Mode,Bing AI Mode).

## 安装

```sh
npm install @cloro-dev/cloro
```

也可以使用：`pnpm add @cloro-dev/cloro`、`yarn add @cloro-dev/cloro`、`bun add @cloro-dev/cloro`

## README

# 丁香类型SDK

官方JS SDK为: [**花环**](https://cloro.dev/),用于类型脚本和节点. cloro是一个SPER API,有一个API用于Google搜索和每个AI回答引擎 (ChatGPT,双子座,AI Overview,AI Mode,Bing AI Mode). 实时,结构化的JSON.

克洛还有正式的Python SDK, [`cloro` 关于 PyPI](https://pypi.org/project/cloro/),并有一个主机 [Claude、 Cursor 和 ChatGPT 的 MCP 服务器](https://cloro.dev/integrations/mcp/), (中文(简体) ), 因此AI代理可以调用与工具相同的端点.

使用 SDK,或 [刚刚 `curl` 这个](https://cloro.dev/docs):同样的干净反应 无论是哪种方式。 SDK增加了打字方法,明智的重试和投票辅助器 用于同步任务队列,所以不要手卷. 有类型脚本的船舶 建立无害环境管理和共同司法体系.

## 安装

```bash
npm install @cloro-dev/cloro
```

需要节点 18+( 使用内置) `fetch`) (中文(简体) ). 与类型脚本、无害环境管理和 常见JS.

## 快速启动

```ts
import { Cloro } from "@cloro-dev/cloro";

const client = new Cloro({ apiKey: "sk_live_..." }); // or set CLORO_API_KEY

const res = await client.monitor.chatgpt({
  prompt: "What do you know about Acme Corp?",
  country: "US",
  include: { markdown: true },
});

console.log(res.result.text);
for (const source of res.result.sources) {
  console.log(source.position, source.url, source.label);
}
```

API 密钥来自 `CLORO_API_KEY` 环境变量,当你不 通过 `apiKey`。在 [仪表板.cloro.dev](https://dashboard.cloro.dev/)。 。 。 .

常见JS

```js
const { Cloro } = require("@cloro-dev/cloro");

const client = new Cloro({ apiKey: "sk_live_..." });
client.monitor.chatgpt({ prompt: "...", country: "US" }).then((res) => {
  console.log(res.result.text);
});
```

## 发动机

每个引擎都是一种方法 `client.monitor`. AI引擎采取 `prompt`· ; 谷歌搜索和谷歌新闻 `query`。 。 。 .

```ts
await client.monitor.chatgpt({ prompt: "...", country: "US" });
await client.monitor.gemini({ prompt: "...", country: "US" });
await client.monitor.aimode({ prompt: "...", country: "US" }); // Google AI Mode
await client.monitor.bingAimode({ prompt: "...", country: "US" }); // Bing AI Mode

await client.monitor.google({ query: "best crm", country: "US", pages: 1 });
await client.monitor.googleNews({ query: "acme corp", country: "US" });
```

过 `include: { ... }` 请求额外格式 - `markdown`, (中文(简体) ), `html`, (中文(简体) ), `searchQueries`, (中文(简体) ), `shopping`更多取决于发动机.

Bing AI 模式只接受 `include: { markdown, html }`编辑 `html` 值是一个 Bing 显示的页面的 URL 。 您也可以设置 `state` 改为两个字母的美国国家代码 (仅与 `country: "US"`) (中文(简体) ). 结果 `text`, (中文(简体) ), `sources`,以及 `citationPills`。 。 。 .

```ts
const bing = await client.monitor.bingAimode({
  prompt: "best crm for startups",
  country: "US",
  state: "CA",
  include: { markdown: true },
});
for (const pill of bing.result.citationPills) {
  console.log(pill.position, pill.domain, pill.url);
}
```

## Async 任务队列

对于量大或长期进行的工作,要排好任务并进行考核以完成. `run()` 在一个电话中创建-当时-等待:

```ts
const result = await client.asyncTasks.run({
  taskType: "CHATGPT",
  payload: { prompt: "What is cloro?", country: "US" },
});
console.log(result.response); // present once COMPLETED
console.log(result.credits); // credits reserved / charged
```

更喜欢自己管理生命周期:

```ts
const task = await client.asyncTasks.create({
  taskType: "GOOGLE",
  payload: { query: "serp api", country: "US" },
  priority: 5,
});
const snapshot = await client.asyncTasks.retrieve(task); // non-blocking
const done = await client.asyncTasks.wait(task, { timeout: 120_000, pollInterval: 2000 });
```

在单个请求中批量最多500个任务( 结果保存输入顺序) :

```ts
const results = await client.asyncTasks.createBatch([
  { taskType: "CHATGPT", payload: { prompt: "q1", country: "US" } },
  { taskType: "GEMINI", payload: { prompt: "q2", country: "GB" } },
]);
for (const item of results) {
  if (item.success) await client.asyncTasks.wait(item.task.id);
  else console.log("failed:", item.error.message);
}
```

全队状态 :

```ts
await client.asyncTasks.status(); // queued / processing counts, concurrency usage
```

有效 `taskType` 值 : `CHATGPT`, (中文(简体) ), `GEMINI`, (中文(简体) ), `AIMODE`, (中文(简体) ), `BING_AIMODE`, (中文(简体) ), `GOOGLE`, (中文(简体) ), `GOOGLE_NEWS`。 。 。 .

## 配置

```ts
const client = new Cloro({
  apiKey: "sk_live_...",
  baseUrl: "https://api.cloro.dev", // override if needed
  timeout: 300_000, // per-request milliseconds (the default)
  maxRetries: 2, // timeouts, connection errors, 429/5xx
});
```

## 处理错误

所有错误子类 `CloroError`HTTP 失败映射到特定状态类型 :

```ts
import { Cloro, AuthenticationError, RateLimitError, CloroError } from "@cloro-dev/cloro";

try {
  await client.monitor.chatgpt({ prompt: "...", country: "US" });
} catch (err) {
  if (err instanceof AuthenticationError) {
    // 401 — bad or missing API key
  } else if (err instanceof RateLimitError) {
    // 429 — the client already retried; back off further if it persists
  } else if (err instanceof CloroError) {
    // everything else
  } else {
    throw err;
  }
}
```

`BadRequestError` (400个), `PermissionDeniedError` (403个), `NotFoundError` (404个), `ConflictError` (409个)和 `InternalServerError` (第5xx)条也提供 与 `TaskFailedError` 编号 : `TaskTimeoutError` 传票人和 `APITimeoutError` 编号 : `APIConnectionError` 从运输.

## 参考数据

```ts
await client.countries(); // supported countries
await client.countries("chatgpt");
await client.countries("bing_aimode"); // countries for Bing AI Mode
await client.states(); // US states for location targeting (Google, Bing AI Mode)
```

## 链接

-   [红外线](https://cloro.dev/) ——主办SERP+AI答-引擎API
-   [萨尔瓦多](https://cloro.dev/serp-api/) ——Google搜索这一SDK包装的终点
-   [节点和类型脚本指南](https://cloro.dev/integrations/javascript/) 快速启动、食谱和生产模式
-   [文档](https://cloro.dev/docs) 财务报告和审定财务报表 [API 参考文献 (OpenAPI)](https://cloro.dev/docs/api-reference/openapi.json)
-   [定价](https://cloro.dev/pricing/) • 妇女 [盘子](https://dashboard.cloro.dev/)
-   Python SDK: (英语) [花环](https://github.com/cloro-dev/cloro-python)

## 许可证

麻省理工学院

## 常见问题

### @cloro-dev/cloro 是什么？

Clano API的官方TypeScript/Node SDK:一个API用于Google搜索和每个AI答引擎\(ChatGPT,双子座,AI Overview,AI Mode,Bing AI Mode\)\.

### 如何安装 @cloro-dev/cloro？

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

### @cloro-dev/cloro 支持 TypeScript 吗？

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

### @cloro-dev/cloro 支持 ESM 还是 CommonJS？

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

### @cloro-dev/cloro 需要什么版本的 Node\.js？

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

### @cloro-dev/cloro 可以商用吗？

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

### @cloro-dev/cloro 的下载量有多少？

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

### @cloro-dev/cloro 还在维护吗？

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