Video2txt
集成文档

Skill / CLI / API / Agent 接入文档

Skill、CLI、API 或 Agent 工作流，任选一种方式提取短视频文案/字幕

认证方式

Authentication

所有方式都需要 API Key。最快方式：npx video2txt-cli setup 自动注册或登录获取。

export DY_CAPTION_API_KEY="dy_your_api_key"
在控制台中获取您的 API Key：video2txt.app/dashboard

Skill（推荐）

接入 OpenClaw、Hermes、Codex、Claude 等 Agent 工作流

通过自然语言指令直接调用，无需手动打开后台处理链接。OpenClaw 可用 clawhub 安装；Hermes、Codex、Claude 等环境可以通过 CLI 或 API 接入同一能力。

安装命令示例

clawhub install video2txt

手动安装（备选）

cd ~/.openclaw/workspace
git clone https://github.com/xwchris/video2txt.git skills/video2txt
GitHub: xwchris/video2txt

使用示例

-提取这个短视频链接的文案：https://www.tiktok.com/@creator/video/123456
-把这段短视频分享内容转成文字，语言用 zh-CN
-查看我的 video2txt 余额

使用流程

  1. 1安装 Skill：clawhub install video2txt
  2. 2对 Agent 说「帮我提取短视频文案」- 首次使用自动引导注册，注册即获免费时长
  3. 3后续直接发送短视频链接或分享文案即可，无需再次配置

CLI 工具

跨平台 CLI，npx 一键使用

独立的命令行工具，适用于本地脚本、自定义 Agent 和非 Skill 环境。支持 macOS、Linux、Windows，需 Node.js >= 18。

首次使用

# 注册账号或登录，并自动保存 API Key
npx video2txt-cli setup

使用

# 提取文案（支持短视频分享链接或包含链接的整段文案）
npx video2txt-cli transcribe "https://www.tiktok.com/@creator/video/123456"

# 指定语言
npx video2txt-cli transcribe "6.44 复制打开视频，看看【xxx】 https://www.tiktok.com/@creator/video/123456" zh-CN

# 查询任务状态
npx video2txt-cli status <taskId>

# 查询余额
npx video2txt-cli balance

# 查看历史
npx video2txt-cli history
GitHub: xwchris/video2txt · npm: video2txt-cli

REST API 接口

如果您需要直接调用 REST API，以下是可用的端点

提交转写任务

Create Transcription Task

POST
https://api.video2txt.app/api/v1/transcribe

请求参数

{
  "input": "https://www.tiktok.com/@creator/video/123456",
  "language": "zh-CN"  // 可选，默认 zh-CN
}

响应示例

{
  "success": true,
  "taskId": "uuid",
  "status": "processing",
  "estimatedCost": 1.2
}

cURL 示例

curl -X POST https://api.video2txt.app/api/v1/transcribe \
  -H "X-API-Key: dy_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"input": "https://www.tiktok.com/@creator/video/123456", "language": "zh-CN"}'

查询任务状态

Get Transcription Result

GET
https://api.video2txt.app/api/v1/transcribe/:taskId

响应示例

{
  "taskId": "uuid",
  "status": "completed",
  "resultText": "大家好，欢迎来到我的频道...",
  "author": "作者昵称",
  "videoDesc": "视频原始文案",
  "duration": 1.2,
  "creditCost": 1.2,
  "errorMessage": null
}

查询余额与历史

Credits And History

GEThttps://api.video2txt.app/api/v1/credits
GEThttps://api.video2txt.app/api/v1/history

余额响应示例

{
  "balance": 10,
  "reservedBalance": 0,
  "availableBalance": 10,
  "totalPurchased": 0,
  "totalUsed": 0
}

支持语言

Supported Languages

zh-CN
en-US
ja-JP
ko-KR

错误码

Error Codes

状态码说明
401API Key 无效或未提供
402余额不足
400请求参数错误
404任务或视频不存在
429请求过于频繁
500服务器错误
免费注册返回首页
Video2txt Skill / CLI / API / Agent 接入文档 | Video2txt