Transistor MCP

🚀 Transistor API English Documentation

Transistor offers a suite of RESTful APIs for managing your podcast content. These APIs enable you to create, update, and delete episodes, obtain analytics data, manage subscribers, and upload audio files.

🚀 Quick Start

Prerequisites

• All API requests require a valid API key.
• Audio files must be authorized for upload via the authorize_UPLOAD API.

📚 Documentation

API Reference

Create an Episode

• Request URL: POST /v1/episodes

Request Parameters

• show_id: Required string. The ID of the podcast show.
• title: Required string. The title of the episode.
• description: Optional string. The description of the episode.
• episode_number: Optional integer. The episode number.
• season_number: Optional integer. The season number.
• audio_url: String. The URL of the audio file, which must be obtained through the authorize_UPLOAD API.

Response Example

{
  "data": {
    "id": "123456",
    "title": "My New Episode",
    "description": "This is a new episode about podcasts.",
    "episode_number": 1,
    "season_number": 1,
    "audio_url": "https://example.com/episode.mp3"
  }
}

Get an Episode

• Request URL: GET /v1/episodes/{episode_id}

Path Parameters

• episode_id: Required string. The ID of the episode.

Response Parameters

• id: String. The ID of the episode.
• title: String. The title of the episode.
• description: String. The description of the episode.
• episode_number: Integer. The episode number.
• season_number: Integer. The season number.
• audio_url: String. The URL of the audio file.

Update an Episode

• Request URL: PATCH /v1/episodes/{episode_id}

Path Parameters

• episode_id: Required string. The ID of the episode.

Request Parameters

• title: String. The new title of the episode.
• description: String. The new description of the episode.
• episode_number: Integer. The new episode number.
• season_number: Integer. The new season number.

Response Example

{
  "data": {
    "id": "123456",
    "title": "Updated Title",
    "description": "New description.",
    "episode_number": 1,
    "season_number": 1
  }
}

Delete an Episode

• Request URL: DELETE /v1/episodes/{episode_id}

Path Parameters

• episode_id: Required string. The ID of the episode.

Response Example

{
  "message": "Episode deleted successfully."
}

Get Analytics Data for an Episode

• Request URL: GET /v1/analytics/episodes/{episode_id}

Path Parameters

• episode_id: Required string. The ID of the episode.

Response Parameters

• plays: Integer. The number of plays.
• unique_plays: Integer. The number of unique plays.
• average_rating: Optional numeric. The average rating.
• total_ratings: Integer. The total number of ratings.

Get Analytics Data for All Episodes

• Request URL: GET /v1/analytics/episodes

Response Parameters

• data: Array. Contains analytics data for each episode. Each object includes the following fields:
  • episode_id: String. The ID of the episode.
  • title: String. The title of the episode.
  • plays: Integer. The number of plays.
  • unique_plays: Integer. The number of unique plays.

Manage Subscribers

⚠️ Important Note

This feature is not yet implemented. Stay tuned for updates.

Authorize Audio File Upload

• Request URL: POST /v1/uploads

Request Parameters

• episode_title: Required string. The title of the episode.
• episode_description: Optional string. The description of the episode.

Response Parameters

• upload_url: String. The URL for uploading the audio file.
• audio_url: String. The URL of the audio file after successful upload.

Example Code

import requests

# Get the pre-signed URL
response = requests.post('https://api.transistor.fm/v1/uploads', json={
    'episode_title': 'My New Episode',
    'episode_description': 'This is a new episode about podcasts.'
})
data = response.json()
upload_url = data['upload_url']

# Upload the audio file
with open('episode.mp3', 'rb') as file:
    response = requests.put(upload_url, data=file)

Get Authenticated User Information

• Request URL: GET /v1/users

Response Parameters

• user_id: String. The ID of the user.
• email: String. The email of the user.

Features Not Yet Implemented

• Get Subscriber List: GET /v1/subscribers
• Create a Subscriber: POST /v1/subscribers
• Update a Subscriber: PATCH /v1/subscribers/{subscriber_id}
• Delete a Subscriber: DELETE /v1/subscribers/{subscriber_id}

💻 Usage Examples

Create an Episode

import requests

response = requests.post('https://api.transistor.fm/v1/episodes', json={
    'show_id': '12345',
    'title': 'My New Episode',
    'description': 'This is a new episode about podcasts.',
    'episode_number': 1,
    'season_number': 1,
    'audio_url': 'https://example.com/episode.mp3'
})
print(response.json())

Get Analytics Data

import requests

response = requests.get('https://api.transistor.fm/v1/analytics/episodes/12345')
print(response.json())

⚠️ Important Note

All API requests require a valid API key. Audio files must be authorized for upload via the authorize_UPLOAD API.