API 文档

BASE URLhttps://redfox.hk

暂无可用的 API 平台

获取视频字幕详情

免费调用即将上线需配置 API Key

YouTube视频信息查询

单价随接口累计调用量阶梯调整

POSThttps://redfox.hk/story/api/youtube/info

API 密钥获取与配置

获取密钥

调用 API 前，请先在控制台生成 API 密钥并完成配置。在 HTTP 请求头中添加API Key 字段，密钥用于身份校验与额度计费。

获取步骤

前往控制台页面，进入 API 密钥管理模块。
若无已生成的密钥，点击生成新密钥，复制并妥善保存密钥。
在请求头中添加 REDFOX_API_KEY或X-API-KEY字段并填入密钥后即可调用。

API说明

Method：POST

Host：https://redfox.hk

Path：/story/api/youtube/info

请求头

名称	类型	必填	说明	示例
REDFOX_API_KEY	string	否		ak_c4fc9018ffb14ce4ae35dafd92f466c3
Content-Type	string	是	请求体数据类型	application/json

请求参数

参数	类型	必填	说明	示例
videoUrl	string	是	YouTube视频URL或视频ID	https://www.youtube.com/watch?v=EnSONxLppjk

返回值与结构

统一包装一般为 `code`、`message`/`msg`、`data`（以实际服务为准）。

响应字段

字段	类型	说明	示例
code	integer	响应状态码，2000表示成功	2000
msg	string	响应消息	成功
data	object
available_languages	array	可用字幕语言列表
name	string	字幕语言名称	English
metadata	object	视频基础信息
author_name	string	视频作者/频道名称	小白Ethan
author_url	string	作者频道主页URL	https://www.youtube.com/channel/UCOwrfd5I1P90Sgf8CzeYJ3g
thumbnail_url	string	视频封面缩略图URL	https://i.ytimg.com/vi/EnSONxLppjk/sddefault.jpg
title	string	视频标题	緊鄰上海！【嘉兴】一日游，超出我预期太多了！江南水鄉、南湖、子城公園，悠閒舒服的南方城市！｜浙江嘉興｜粽子｜小白Ethan
video_id	string	视频唯一ID	EnSONxLppjk

请求示例

# 暂无示例

响应示例

{
  "code": 2000,
  "data": {
    "metadata": {
      "author_name": "小白Ethan",
      "author_url": "https://www.youtube.com/channel/UCOwrfd5I1P90Sgf8CzeYJ3g",
      "title": "緊鄰上海！【嘉兴】一日游，超出我预期太多了！江南水鄉、南湖、子城公園，悠閒舒服的南方城市！｜浙江嘉興｜粽子｜小白Ethan",
      "thumbnail_url": "https://i.ytimg.com/vi/EnSONxLppjk/sddefault.jpg"
    },
    "available_languages": [
      {
        "code": "en",
        "name": "English"
      },
      {
        "code": "ja",
        "name": "Japanese"
      },
      {
        "code": "ko",
        "name": "Korean"
      }
    ],
    "video_id": "EnSONxLppjk"
  },
  "msg": "成功"
}

常见状态码说明

调用接口时，响应体中的 code 字段对应以下状态码。完整列表请查看 API 状态码说明页。

状态码	说明	排查建议
`400`	请求参数错误	检查请求体、Query 参数是否与文档一致，必填项是否齐全。
`401`	鉴权失败	确认请求头已添加 REDFOX_API_KEY 或 X-API-KEY，且密钥有效、未禁用。
`403`	无权限访问	当前密钥或账号无权调用该接口，请检查密钥状态与接口权限。
`500`	系统内部错误	服务端异常，请稍后重试；持续出现请联系技术支持。
`503`	服务暂不可用	服务维护或短暂过载，请间隔一段时间后重试。
`1001`	缺少必要参数	对照「请求参数」表，补全必填字段。
`1002`	参数格式不正确	检查字段类型与格式（如 URL、日期、枚举值）是否符合说明。
`1003`	参数类型错误	确认 JSON 中数字、字符串、布尔等类型与文档定义一致。
`3103`	密钥不存在	密钥可能已删除或填写错误，请前往控制台核对并重新复制。
`3105`	API Key 已禁用	在控制台启用该密钥，或创建新密钥后替换请求头中的值。
`3201`	积分不足	账户余额不足以支付本次调用，请前往控制台充值后再试。
`3202`	积分账户不存在	账号积分账户异常，请登录控制台确认账户状态。
`4004`	操作过于频繁，请稍后再试	触发频率限制，降低请求频率或增加调用间隔后重试。

调用步骤

在请求头配置REDFOX_API_KEY或X-API-KEY
按 API 说明示例构造请求参数或请求体。
发起请求。
解析 JSON 响应中的 code、message 与 data 字段。

Request（示例代码，仅供参考）

bash

curl -X POST "https://redfox.hk/story/api/youtube/info" \
  -H "REDFOX_API_KEY: your_api_key" \
  -H "REDFOX_API_KEY: ak_c4fc9018ffb14ce4ae35dafd92f466c3" \
  -H "Content-Type: application/json" \
  -d '{
  "videoUrl": "https://www.youtube.com/watch?v=EnSONxLppjk"
}'

Response（示例代码，仅供参考）

json

{
  "code": 2000,
  "data": {
    "metadata": {
      "author_name": "小白Ethan",
      "author_url": "https://www.youtube.com/channel/UCOwrfd5I1P90Sgf8CzeYJ3g",
      "title": "緊鄰上海！【嘉兴】一日游，超出我预期太多了！江南水鄉、南湖、子城公園，悠閒舒服的南方城市！｜浙江嘉興｜粽子｜小白Ethan",
      "thumbnail_url": "https://i.ytimg.com/vi/EnSONxLppjk/sddefault.jpg"
    },
    "available_languages": [
      {
        "code": "en",
        "name": "English"
      },
      {
        "code": "ja",
        "name": "Japanese"
      },
      {
        "code": "ko",
        "name": "Korean"
      }
    ],
    "video_id": "EnSONxLppjk"
  },
  "msg": "成功"
}