Transistor.fm

🚀 Transistor API Documentation

This API documentation provides detailed information on how to interact with the Transistor API, including creating, updating, and deleting episodes, retrieving user information, authorizing audio uploads, and more.

🚀 Quick Start

This section provides a quick overview of how to use the Transistor API. For detailed information, please refer to the following sections.

✨ Features

• Episode Management: Create, update, and delete episodes with ease.
• User Information: Retrieve detailed information about the authenticated user.
• Audio Upload: Authorize and upload audio files securely.
• Analytics: Get comprehensive analytics data for all episodes.
• Show Management: Retrieve a list of all shows created by the user.
• Webhook Management: Add, retrieve, and delete webhook events.

📚 Documentation

Create a New Episode

• API Call: POST /v1/episodes
• Parameters:
  • Required:
    • show_id: The ID of the show to which the episode belongs.
    • title: The title of the episode.
    • audio_url: The URL of the audio file.
  • Optional:
    • description: A description of the episode (max 4000 characters).
    • episode_number: The episode number.
    • season_number: The season number.
    • public: Whether the episode is public (default is true).
    • cover_image_url: The URL of the cover image.
    • language: The language of the audio (e.g., "zh-CN").
    • duration: The duration of the episode in seconds.
• Response: Information about the newly created episode.

Update an Existing Episode

• API Call: PATCH /v1/episodes/:episode_id
• Parameters:
  • Required:
    • episode_id: The ID of the episode to be updated.
  • Optional:
    • title: The new title.
    • description: The new description (max 4000 characters).
    • episode_number: The new episode number.
    • season_number: The new season number.
    • cover_image_url: The new URL of the cover image.
    • language: The new language of the audio.
• Response: Information about the updated episode.

Delete an Episode

• API Call: DELETE /v1/episodes/:episode_id
• Parameters:
  • episode_id: The ID of the episode to be deleted.
• Response: Status code 204 (No Content).

Get Authenticated User Information

• API Call: GET /v1/users
• Response: Detailed information about the currently authenticated user, including:
  • User ID
  • Username
  • Email address
  • Join date
  • Account status

Authorize Audio Upload

• API Call: POST /v1/audio-uploads
• Parameters:
  • filename: The name of the audio file to be uploaded.
• Response:
  • upload_url: The URL for uploading the audio file (use this URL for a PUT request).
  • audio_url: The URL of the audio file that can be used by the API after successful upload.
  • expires_at: The expiration time of the upload URL.

Example of Creating a New Episode

const result = await useMCPTool({
  serverName: "transistor",
  toolName: "createEpisode",
  arguments: {
    showId: "123456", // The ID of the show to which the episode belongs
    title: "My New Episode", // The title of the episode
    audioUrl: "https://your-audio-url.com/episode.mp3" // The URL of the audio file
  }
});

Get Analytics Data for All Episodes

• API Call: GET /v1/analytics/episodes
• Parameters:
  • show_id: Filter the analytics data for episodes of a specific show (optional).
  • start_date: The start date of the analysis (format: "YYYY-MM-DD", optional).
  • end_date: The end date of the analysis (format: "YYYY-MM-DD", optional).
• Response: A list of analytics data for multiple episodes, each including:
  • Episode ID
  • Title
  • Play count
  • Number of unique players
  • Number of full plays
  • Average play time

Get All Shows

• API Call: GET /v1/shows
• Response: A list of all shows created by the user, including:
  • Show ID
  • Title
  • Description
  • Creation time
  • Update time

Manage Webhook Events

Add a New Webhook Event

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

Get All Webhook Events

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

Delete a Specific Webhook Event

const result = await useMCPTool({
  serverName: "transistor",
  toolName: "deleteWebhook",
  arguments: {
    webhookId: "webhook-12345" // The ID of the webhook to be deleted
  }
});

Unimplemented Features

Currently, the following features are not implemented:

• Private Episode Feature: Including creating and managing private episodes.
• Advanced Analytics Feature: More detailed play data statistics and filtering.
• Custom Domain Feature: Setting a custom domain for audio content.