API 文档

DY Caption 提供了 RESTful API 和 CLI 工具两种方式来使用我们的转写服务。

认证方式

所有 API 请求都需要在请求头中携带 API Key 进行认证。你可以在控制台中获取你的 API Key。

http

GET /api/v1/credits HTTP/1.1
Host: dycaption.cn
X-API-Key: your-api-key-here

请妥善保管你的 API Key，不要将其暴露在客户端代码或公开仓库中。

CLI 使用

安装 dy-caption CLI 工具后，你可以通过命令行直接进行视频转写。

安装

bash

npm install -g @dy-caption/cli

配置 API Key

bash

dy-caption config set apiKey your-api-key-here

基本使用

bash

# 使用分享链接
dy-caption "7.11 pda:/ 复制打开抖音..."

# 指定语言
dy-caption "分享链接" --lang zh-CN

# 输出到文件
dy-caption "分享链接" -o output.txt

REST API

POST/api/v1/transcribe

提交转写任务，返回转写结果。

请求体

json

{
  "shareText": "7.11 pda:/ 复制打开抖音...",
  "language": "zh-CN"
}

响应示例

json

{
  "success": true,
  "data": {
    "taskId": "task_abc123",
    "result": "大家好，欢迎来到我的频道...",
    "language": "zh-CN",
    "duration": 8.5
  }
}

GET/api/v1/transcribe/:taskId

查询转写任务状态和结果。

响应示例

json

{
  "success": true,
  "data": {
    "taskId": "task_abc123",
    "status": "completed",
    "result": "大家好，欢迎来到我的频道...",
    "language": "zh-CN",
    "duration": 8.5,
    "creditCost": 1.0,
    "createdAt": "2024-01-15T10:30:00Z",
    "completedAt": "2024-01-15T10:30:08Z"
  }
}

GET/api/v1/credits

查询当前账户余额。

响应示例

json

{
  "success": true,
  "data": {
    "balance": 42.5,
    "apiKey": "dk_abc123..."
  }
}

支持语言

目前支持以下语言的语音识别：

语言代码	语言名称
`zh-CN`	中文（简体）
`zh-TW`	中文（繁体）
`en`	English
`ja`	日本語
`ko`	한국어

错误码

API 返回的错误码及对应说明：

状态码	错误名称	说明
401	`UNAUTHORIZED`	API Key 无效或未提供
402	`INSUFFICIENT_CREDITS`	余额不足，请充值后重试
400	`INVALID_INPUT`	输入参数无效，缺少必填字段
404	`VIDEO_NOT_FOUND`	无法从分享文本中提取视频链接
422	`EXTRACTION_FAILED`	音频提取失败
429	`RATE_LIMITED`	请求过于频繁，请稍后重试
500	`INTERNAL_ERROR`	服务器内部错误