介绍
# Captions
通过 [TranscriptAPI.com](https://transcriptapi.com) 从 YouTube 视频中提取隐藏式字幕。
## 设置
如果未设置 `$TRANSCRIPT_API_KEY`，请帮助用户创建账户（100 个免费额度，无需信用卡）：
**第一步 — 注册：** 询问用户的电子邮件。
```bash node ./scripts/tapi-auth.js register --email USER_EMAIL ```
→ 验证码（OTP）已发送至电子邮件。询问用户：_"请查看您的电子邮件以获取 6 位验证码。"_
**第二步 — 验证：** 当用户提供验证码后：
```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) → 控制台 → API 密钥。
## 文件写入
验证和保存密钥命令会将 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=json&include_timestamp=true&send_metadata=true" \ -H "Authorization: Bearer $TRANSCRIPT_API_KEY" ```
| 参数 | 必需 | 默认值 | 值 | | ------------------- | ------ | ------- | ----------------------------------- | | `video_url` | 是 | — | YouTube URL 或视频 ID | | `format` | 否 | `json` | `json` (结构化), `text` (纯文本) | | `include_timestamp` | 否 | `true` | `true`, `false` | | `send_metadata` | 否 | `false` | `true`, `false` |
**响应** (`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": "...", "author_name": "...", "thumbnail_url": "..." } } ```
- `start`：距离视频开始的秒数 - `duration`：字幕显示的时长
**响应** (`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..." } ```
## 提示
- 使用 `format=json` 获取同步字幕（辅助功能工具、计时分析）。 - 使用 `format=text` 并设置 `include_timestamp=false` 以获取纯净的阅读文本。 - 大多数视频提供自动生成的字幕；手动 CC 质量更高。
## 错误
| 代码 | 含义 | 操作 | | ---- | ---------- | ------------------------------ | | 402 | 无额度 | transcriptapi.com/billing | | 404 | 无字幕 | 视频未启用 CC | | 408 | 超时 | 2 秒后重试一次 |
每次请求消耗 1 个额度。免费版：100 个额度，300 请求/分钟。