Transistor.fm

🚀 电晶体 API 文档

本 API 文档提供了电晶体相关功能的接口信息，涵盖剧集的创建、更新、删除，用户信息获取，音频上传授权等操作，方便开发者进行集成和使用。

🚀 快速开始

本 API 文档提供了一系列与电晶体相关的接口，用于管理剧集、用户信息、音频上传等操作。通过调用这些 API，开发者可以实现剧集的创建、更新、删除，获取用户信息，授权音频上传等功能。

📚 详细文档

创建新剧集

• API 调用：POST /v1/episodes
• 参数：
  • 必填参数：
    • show_id：剧集所属的节目 ID
    • title：剧集标题
    • audio_url：音频文件的 URL
  • 可选参数：
    • description：剧集描述（最多 4000 字符）
    • episode_number：剧集编号
    • season_number：季度编号
    • public：是否公开剧集 (默认为 true)
    • cover_image_url：封面图片 URL
    • language：音频语言（如: "zh-CN"）
    • duration：剧集时长（秒）
• 返回：新创建的剧集信息

更新现有剧集

• API 调用：PATCH /v1/episodes/:episode_id
• 参数：
  • 必填参数：
    • episode_id：需要更新的剧集 ID
  • 可选参数：
    • title：新标题
    • description：新描述（最多 4000 字符）
    • episode_number：新剧集编号
    • season_number：新季度编号
    • cover_image_url：新封面图片 URL
    • language：新音频语言
• 返回：更新后的剧集信息

删除剧集

• API 调用：DELETE /v1/episodes/:episode_id
• 参数：
  • episode_id：需要删除的剧集 ID
• 返回：状态码 204 (无内容)

获取认证用户信息

• API 调用：GET /v1/users
• 返回：当前认证用户的详细信息，包括：
  • 用户 ID
  • 用户名
  • 邮箱地址
  • 加入时间
  • 帐户状态

授权音频上传

• API 调用：POST /v1/audio-uploads
• 参数：
  • filename：将要上传的音频文件名称
• 返回：
  • upload_url：音频文件的上传 URL（需使用此链接进行 PUT 请求上传）
  • audio_url：上传成功后，可供 API 使用的音频 URL
  • expires_at：上传链接的有效期截止时间

获取所有剧集分析数据

• API 调用：GET /v1/analytics/episodes
• 参数：
  • show_id：过滤指定节目的剧集分析数据（可选）
  • start_date：分析开始日期（格式: "YYYY-MM-DD"，可选）
  • end_date：分析结束日期（格式: "YYYY-MM-DD"，可选）
• 返回：包含多个剧集的分析数据列表，每个剧集包括：
  • 剧集 ID
  • 标题
  • 播放次数
  • 独特播放器数量
  • 完整播放次数
  • 平均播放时间

获取所有节目

• API 调用：GET /v1/shows
• 返回：所有用户创建的节目列表，包括：
  • 节目 ID
  • 标题
  • 描述
  • 创建时间
  • 更新时间

管理 Webhook 事件

添加新的 Webhook 事件

const result = await useMCPTool({
  serverName: "transistor",
  toolName: "createWebhook",
  arguments: {
    callback_url: "https://your-callback-url.com/webhook" // 必填的回调 URL
  }
});

获取所有 Webhook 事件

const result = await useMCPTool({
  serverName: "transistor",
  toolName: "getWebhooks"
});

删除指定 Webhook 事件

const result = await useMCPTool({
  serverName: "transistor",
  toolName: "deleteWebhook",
  arguments: {
    webhookId: "webhook-12345" // 需要删除的 Webhook ID
  }
});

💻 使用示例

创建新剧集示例

const result = await useMCPTool({
  serverName: "transistor",
  toolName: "createEpisode",
  arguments: {
    showId: "123456", // 需要关联的节目 ID
    title: "我的新剧集", // 剧集标题
    audioUrl: "https://your-audio-url.com/episode.mp3" // 音频文件 URL
  }
});

🔧 技术细节

目前，以下功能尚未实现：

• 私人剧集功能：包括创建和管理私人剧集
• 高级分析功能：更详细的播放数据统计和筛选
• 自定义域名功能：为音频内容设置自定义域名