跳转到正文
中文
获取 API 密钥
浏览文档

开始使用

TypeScript 与 JavaScript SDK

安装 SDK,在 Node.js 中执行搜索。支持 TypeScript 与 JavaScript;API Key 保存在服务端。

  1. 安装 SDK

    示例使用 Node.js 22.18+ 直接运行 TypeScript。在空目录开始;已有 package.json 时选择已有项目。

    安装
    npm init -y
    npm install --save-exact @flashdata-dev/[email protected]
  2. 认证

    创建具有 Google 搜索权限的密钥或复用授权密钥。通过下方隐藏提示在当前终端设置 FLASHDATA_API_KEY;环境已提供时可跳过。

    示例显式传入密钥。这些脚本不会加载 .env 文件。集成到网页应用时,将密钥保存在服务端配置。

    隐藏密钥输入 · Bash
    # Bash: paste the key into a hidden prompt, not into this command.
    read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
    printf '\n'
    export FLASHDATA_API_KEY
  3. 执行搜索

    保存所选文件,在项目中执行对应命令。每次运行提交一次搜索,最多获取五条结果。两种文件均直接通过 Node.js 运行,此示例无需构建。

    quickstart.mts
    import { FlashData, type GoogleSearchParams } from '@flashdata-dev/sdk';
    
    const apiKey = process.env.FLASHDATA_API_KEY;
    if (!apiKey) throw new Error('Set FLASHDATA_API_KEY in the server environment.');
    const client = new FlashData({ apiKey });
    const params: GoogleSearchParams = { num: 5 };
    const response = await client.google.search({ query: 'battery recycling research', ...params });
    if (response.status !== 'done') throw new Error(JSON.stringify(response));
    
    for (const page of response.results) {
      for (const hit of page.organic ?? []) console.log(hit.title, hit.link);
    }
    console.log('Credits used:', response.usage.credits);
    运行 · Node.js 22.18+
    node quickstart.mts
  4. 检查结果

    脚本检查 status 为 done,并输出来源标题、URL 和消耗的 Credits。organic 为空属于有效结果。下方输出仅说明结构,实际来源会变化。

    输出示例
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google 搜索标题、链接和摘要。其他来源有各自的类型化结果。
    usage.credits
    此请求扣除的 Credits;返回五条结果属于一次搜索请求。

尝试其他数据源

每个标签页均支持 TypeScript 和 JavaScript。替换第 3 步的文件,保留 .mts 或 .mjs 扩展名,并执行相同命令。每次运行发起新请求,需要所示来源权限。

需要 google_news 权限。文章位于 results[].news[]。

quickstart.mts / quickstart.mjs
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new FlashData({ apiKey });
const response = await client.google.news({
  query: 'battery recycling', num: 5,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);

检查 TypeScript 项目的类型

Node 通过移除类型运行此示例。若要检查类型而不发送请求,可安装 TypeScript 并以 --noEmit 运行编译器:

可选类型检查
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit

SDK 支持的功能

google / youtube
使用类型化来源方法搜索并获取结构化数据。在服务内复用同一客户端。
youtube.download
通过后台任务将音频或视频交付到云存储。需要 youtube_download 权限及存储配置。
jobs / bulk
保存已提交任务 ID,并获取完成结果。await 在 JavaScript 中等待;mode: 'async' 则提交服务端后台任务。
account
定时任务前读取权限、余额、价格、限额和用量。
respondWith / accept
将 { respondWith: 'markdown' } 作为方法第二个参数,从 response.content 获取 Markdown;或传入 { accept: 'text/plain' } 获取字符串。默认返回 JSON 对象。

下一步

步骤失败时

缺少包或运行环境
检查 node --version,在当前项目安装 @flashdata-dev/sdk。保留上方 .mts 或 .mjs 扩展名。
401 / FLASHDATA_API_KEY
在运行示例的终端设置有效密钥。
403
为此 API Key 授予 Google 搜索权限。
402
在 Billing 检查可用 Credits,或认领已耗尽的智能体试用。
429
按 Retry-After 等待,再降低请求频率。
超时或服务器错误
重发前检查 History,首次请求可能已执行。