文档

Videosays API 和 CLI 文档

面向接入和自动化的技术文档:API Key、CLI 命令、异步转写任务、响应结构和错误处理。

想让 AI 助手使用? 先看 AI 助手入口页。

概览

Videosays 可以把支持平台的公开视频链接或分享文本转成纯文本、带时间轴文本、SRT 字幕或 VTT 字幕。手动使用可以进入控制台,本地自动化和 Agent Runtime 可用 CLI,产品集成可用 REST API。

认证

CLI 和 API 请求都使用 Videosays API Key。CLI 可以通过浏览器授权自动创建并保存 API Key。

export VIDEOSAYS_API_KEY="vs_xxxxx"

CLI

命令说明
npx videosays login浏览器授权并保存 API Key
npx videosays whoami检查当前 CLI 是否已登录
npx videosays transcribe "<video-link>"提交链接并返回默认纯文本结果
npx videosays transcribe "<video-link>" --format srt返回 SRT 字幕内容
npx videosays status "<task-id>" --format vtt查询长任务并保留输出格式
npx videosays balance查询账号可用分钟数
npx videosays history查看最近任务历史

REST API

创建转写任务

POST https://api.videosays.com/api/v1/transcribe

{
  "input": "https://www.tiktok.com/@creator/video/123456"
}

查询任务状态和结果

GET https://api.videosays.com/api/v1/transcribe/:taskId

查询余额

GET https://api.videosays.com/api/v1/credits

查询历史任务

GET https://api.videosays.com/api/v1/history

响应格式

创建任务会立即返回 pending。请轮询状态接口,直到任务变成 completed、failed 或 cancelled。

  • text:纯文本,默认格式
  • timeline:带时间轴分段
  • srt:SRT 字幕内容
  • vtt:VTT 字幕内容
{
  "taskId": "uuid",
  "status": "completed",
  "video": {
    "platform": "tiktok",
    "durationSeconds": 72
  },
  "billing": {
    "creditMinutes": 1.2
  },
  "result": {
    "text": "Transcript text...",
    "segments": null
  },
  "error": null
}

错误处理

401API Key 缺失或无效。
402余额不足,需要先购买分钟数。
400请求参数错误或输入不支持。
404任务不存在,或不属于当前账号。
429请求过于频繁,请稍后重试。
500服务或供应商错误。如果源链接仍有效,可以稍后重试。
Videosays API 和 CLI 文档 | Videosays