介绍
# Transcript
通过 [TranscriptAPI.com](https://transcriptapi.com) 获取视频文字记录。
## 设置
如果未设置 `$TRANSCRIPT_API_KEY`，请帮助用户创建账户（100 个免费积分，无需信用卡）：
**步骤 1 — 注册：** 询问用户的电子邮件。
```bash node ./scripts/tapi-auth.js register --email USER_EMAIL ```
→ 验证码已发送至电子邮件。询问用户：_“请检查您的电子邮件以获取 6 位验证码。”_
**步骤 2 — 验证：** 当用户提供验证码后：
```bash node ./scripts/tapi-auth.js verify --token TOKEN_FROM_STEP_1 --otp CODE ```
> API 密钥已保存至 `~/.openclaw/openclaw.json`。详情请参阅下方的 **文件写入**。修改前会备份现有文件。
手动选项：[transcriptapi.com/signup](https://transcriptapi.com/signup) → 仪表板（Dashboard） → API Keys。
## 文件写入
验证和保存密钥命令会将 API 密钥保存到 `~/.openclaw/openclaw.json`（设置 `skills.entries.transcriptapi.apiKey` 和 `enabled: true`）。**修改前，现有文件会备份到 `~/.openclaw/openclaw.json.bak`。**
要在代理之外的终端/CLI 中使用 API 密钥，请手动将其添加到您的 shell 配置文件中： `export TRANSCRIPT_API_KEY=<your-key>`
## GET /api/v2/youtube/transcript
```bash curl -s "https://transcriptapi.com/api/v2/youtube/transcript\ ?video_url=VIDEO_URL&format=text&include_timestamp=true&send_metadata=true" \ -H "Authorization: Bearer $TRANSCRIPT_API_KEY" ```
| 参数 | 必填 | 默认值 | 可选值 | | ------------------- | -------- | ------- | ------------------------------- | | `video_url` | 是 | — | YouTube URL 或 11 位视频 ID | | `format` | 否 | `json` | `json`, `text` | | `include_timestamp` | 否 | `true` | `true`, `false` | | `send_metadata` | 否 | `false` | `true`, `false` |
接受：完整 URL（`youtube.com/watch?v=ID`）、短 URL（`youtu.be/ID`）、Shorts（`youtube.com/shorts/ID`）或纯视频 ID。
**默认值：** 除非用户另有说明，否则始终使用 `format=text&include_timestamp=true&send_metadata=true`。
**响应**（`format=json`）：
```json { "video_id": "dQw4w9WgXcQ", "language": "en", "transcript": [ { "text": "We're no strangers to love", "start": 18.0, "duration": 3.5 }, { "text": "You know the rules and so do I", "start": 21.5, "duration": 2.8 } ], "metadata": { "title": "Rick Astley - Never Gonna Give You Up", "author_name": "Rick Astley", "author_url": "https://www.youtube.com/@RickAstley", "thumbnail_url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg" } } ```
**响应**（`format=text`）：
```json { "video_id": "dQw4w9WgXcQ", "language": "en", "transcript": "[00:00:18] We're no strangers to love\n[00:00:21] You know the rules...", "metadata": {...} } ```
## 错误
| 代码 | 含义 | 处理方式 | | ---- | ------------- | ----------------------------------- | | 401 | API 密钥无效 | 检查密钥或重新设置 | | 402 | 积分不足 | 前往 transcriptapi.com/billing 充值 | | 404 | 无文字记录 | 视频可能未开启字幕 | | 408 | 超时 | 2 秒后重试一次 | | 429 | 速率受限 | 等待后重试 |
## 提示
- 对于长视频，先总结要点，根据需要提供完整文字记录。 - 当您需要精确的时间戳以引用特定时刻时，请使用 `format=json`。 - 使用 `include_timestamp=false` 获取适合翻译或分析的纯净文本。 - 每次成功的请求消耗 1 个积分。错误不消耗积分。 - 免费套餐：100 个积分，300 次/分钟请求限制。