小火炉播客

Appearance

Return to top
On this page

开放 API

请求说明

开放 API 服务地址：https://api.xhlfm.com

Authorization

所有接口请求均需要携带 Authorization 请求头，格式为 Bearer <API Key>，示例如下：

bash
curl -X POST https://api.xhlfm.com/api/transcript \
-H "Authorization: Bearer <API Key>" \
-H "Content-Type: application/json" \
-d '{"url": "https://www.xiaoyuzhoufm.com/episode/686dd81f60f8f77d4091453a"}'

API Key 获取方式

参见 注册并获取 API Key。

请求方法和返回结果

  • 所有接口请求方式均使用 POST 请求方法（不接受反驳）
  • 所有接口返回结果均为 JSON 格式
  • 返回结果数据结构

成功响应

字段类型说明
successboolean请求状态，true 成功
messagestring响应消息
dataobject响应数据，具体见各接口说明

错误响应

字段类型说明
successboolean请求状态，false 失败
messagestring错误消息
errorobject错误详情（可选）

数据结构

Transcript 字幕

  • Transcript 字幕列表
类型说明
array<TranscriptItem>(见数据结构说明)字幕列表
  • TranscriptItem 字幕
字段类型说明
startTimenumber开始时间
endTimenumber结束时间
textstring字幕文本

示例

json
[
  {
    "startTime":4790,
    "endTime":5390,
    "text":"大家好，"
  },
  {
    "startTime":5390,
    "endTime":6690,
    "text":"欢迎收听硬地骇客"
  },
]

开放接口

识别字幕

接口地址

POST /api/transcript

请求参数

参数类型默认值必填说明
urlstring无是单集 URL

⚠️ 注意：url 参数为单集 URL，当前仅支持小宇宙 URL，如 https://www.xiaoyuzhoufm.com/episode/686dd81f60f8f77d4091453a

返回结果

成功响应 data 字段

字段类型说明
statusstring处理状态：processing 处理中、completed 已完成、failed 失败
transcriptTranscript(见数据结构说明)字幕详情

成功响应示例

json
{
  "success": true,
  "message": "识别字幕成功，已扣除 1 积分",
  "data": {
    "status": "completed",
    "transcript": [
      {
        "startTime": 5110,
        "endTime": 6010,
        "text": "嗨各位好，"
      }
    ]
  }
}

处理中状态响应示例

json
{
  "success": true,
  "message": "字幕正在处理中，请稍后再试",
  "data": {
    "status": "processing",
    "transcript": []
  }
}

错误响应示例

  • 单集不存在（404）
json
{
  "success": false,
  "message": "id 对应的单集不存在"
}
  • URL 格式错误（400）
json
{
  "success": false,
  "message": "单集 URL 格式不正确"
}
  • 字幕处理失败（500）
json
{
  "success": false,
  "message": "字幕处理失败,请联系管理员"
}

⚠️ 注意：

  • 当字幕正在处理或不存在时，返回结果 transcript 为空数组
  • 仅支持媒体源为公开的单集，私有媒体源将返回"单集媒体源为私有，无法识别字幕"错误