Transistor.fm

🚀 トランジスタ API ドキュメント

この 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
  }
});