YouTube to MP3 converter API

A simple, easy to use youtube-to-mp3 converter. Utilises YouTubeExplode library and ffmpeg. Additionally configured for nginx proxy.

Table of Contents

• Features
• Setup
• Webhooking
• API Reference
  • Queue video for conversion
  • Get item status
  • Get mp3

Features

• Creates a .mp3 file from your YouTube link
• Queueing requests to be processed in order
• Supports parallel conversion of multiple links
• Can act as a WebHook
• Automatic cleanup of finished files

Setup

• Requires FFMpeg binaries path in appsettings.json.
• Requires PSQL Database connection string in appsettings.json
• Requires temporary directory specified in appsettings.json (it will store generated MP3 files)
• (Optional) Configure MP3 file local lifetime (minutes) in appsettings.json (default value - 10 minutes)

Webhooking

If you provide a URL upon initial conversion request, API will send a POST request with multipart/form-data containing your mp3 to set url upon successful conversion

API Reference

Queue video for conversion

  POST /Converter/videos

Parameter	Type	Description
url	string	Required. YouTube video url.
with_callback	bool	Indicates weather you want API to act as a webhook.
callback_url	string	Required if with_callback set to true. Callback url.

Returns:

Parameter	Type	Description
id	string	Auto-generated ID of your request & file.

Get item status

  GET /Converter/videos/${id}/status

Parameter	Type	Description
id	string	Required. ID of item to fetch.

Returns:

Parameter	Type	Description
id	string	ID of your request & file.
is_failed	bool	Indicates wether conversion has failed.
is_finished	bool	Indicates wether conversion has been finished.

Get mp3

  GET /Converter/videos/${id}

Parameter	Type	Description
id	string	Required. ID of item to fetch.

Returns: .mp3 file