### GET /api/app/demo Source: https://mvsep.com/en/full_api/index Retrieves information about demo separations. Allows filtering by start offset and limit. ```APIDOC ## GET /api/app/demo ### Description To get information about demo separations, you need to make a GET call to the following url. ### Method GET ### Endpoint https://mvsep.com/api/app/demo ### Parameters #### Query Parameters - **start** (integer) - Optional - Starting point offset, defaults to 0 - **limit** (integer) - Optional - Maximum amount of results returned, defaults to 10, maximum is 20. ### Request Example ```bash curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2' ``` ### Response #### Success Response (200) Returns data as an array of demo separations. Each item includes: - **hash** (string): Separation Hash - **date** (string): Date of the separation - **input_audio** (string): Input audio URL - **size** (integer): Input audio size - **algorithm** (object): Basic information about the used separation type. #### Response Example ```json [ { "hash": "a1b2c3d4e5f6", "date": "2023-10-26T15:30:00Z", "input_audio": "https://mvsep.com/audio/demo.mp3", "size": 1024000, "algorithm": { "render_id": "voice", "name": "Voice separation" } } ] ``` ``` -------------------------------- ### Get Demo Separations API Request Source: https://mvsep.com/en/full_api/index Retrieves information about demo audio separations. This GET request to the /api/app/demo endpoint supports optional 'start' and 'limit' query parameters to paginate results. The response includes details like hash, date, input audio URL, size, and the algorithm used. ```curl curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2' ``` -------------------------------- ### Get Quality Checker Queue (Curl) Source: https://mvsep.com/en/full_api/index Retrieves information about Quality Checker queue entries using a GET call. Optional query parameters 'start' and 'limit' can be provided for pagination. Returns an array of queue entries with details. ```curl curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2' ``` -------------------------------- ### Create Audio Separation Job with cURL Source: https://mvsep.com/en/full_api/index This example demonstrates how to create an audio separation job using the MVSep API via a cURL command. It includes parameters for audio file upload, API token, separation type, model options, output format, and a demo flag. The response indicates success or failure and provides a link to the results or an error message. ```shell curl --location --request POST 'https://mvsep.com/api/separation/create' \ --form 'audiofile=@"/path/to/file.mp3"' \ --form 'api_token=""' \ --form 'sep_type="9"' \ --form 'add_opt1="0"' \ --form 'add_opt2="1"' \ --form 'output_format="1"' \ --form 'is_demo="1"' ``` -------------------------------- ### GET /api/app/queue Source: https://mvsep.com/en/full_api/index Retrieves site queue information. Provides details on current processing queues for different user plans. ```APIDOC ## GET /api/app/queue ### Description To get site queue information, you need to make a GET call to the following url. ### Method GET ### Endpoint https://mvsep.com/api/app/queue ### Parameters #### Query Parameters - **api_token** (string) - Optional - API key of the user ### Request Example ```bash curl --location --request GET 'https://mvsep.com/api/app/queue' ``` ### Response #### Success Response (200) Returns queue information: - **queue** (object): Contains an array of current queues for different plans (`in_process`, `premium`, `registered`, `unregistered`). - **plan** (object): Contains current queue for the user's plan (requires `api_token` for registered/premium plans). Includes `plan` and `queue` count. #### Response Example ```json { "queue": { "in_process": 5, "premium": 10, "registered": 25, "unregistered": 50 }, "plan": { "plan": "free", "queue": 50 } } ``` ``` -------------------------------- ### Get Queue Information API Request Source: https://mvsep.com/en/full_api/index Fetches site queue information for audio processing jobs. This GET request to the /api/app/queue endpoint can optionally include an API token to retrieve queue details for registered or premium users. ```curl curl --location --request GET 'https://mvsep.com/api/app/queue' ``` -------------------------------- ### GET ENTRY Source: https://mvsep.com/en/full_api/index Retrieves information about a specific Quality Checker queue entry by its ID. ```APIDOC ## GET ENTRY ### Description To get information about a Quality Checker queue entry by its ID, you need to make a GET call to the following url. ### Method GET ### Endpoint `/api/quality_checker/entry` ### Parameters #### Query Parameters - **id** (Integer) - Required - ID of the entry. ### Request Example ```bash curl --location --request GET 'https://mvsep.com/api/quality_checker/entry?id=7675' ``` ### Response #### Success Response (200) - The response is the same as the GET QUEUE response, returning only one entry. #### Response Example ```json { "id": 7675, "algo_name": "Example Algo", "main_text": "This is an example algorithm.", "dataset_type": "0", "date": "2023-10-27T10:00:00Z", "sdr": { "VOC": 5.0, "VOC": 4.5 } } ``` ``` -------------------------------- ### GET /api/app/news Source: https://mvsep.com/en/full_api/index Retrieves information about the latest news related to MVSEP. Allows filtering by language, start offset, and limit. ```APIDOC ## GET /api/app/news ### Description To get information about latest news about MVSEP, you need to make a GET call to the following url. ### Method GET ### Endpoint https://mvsep.com/api/app/news ### Parameters #### Query Parameters - **lang** (string) - Optional - 2-letter language code (en, ru) - **start** (integer) - Optional - Starting point offset, defaults to 0 - **limit** (integer) - Optional - Maximum amount of results returned, defaults to 10, maximum is 20. ### Request Example ```bash curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1' ``` ### Response #### Success Response (200) Returns data as an array of news items. Each item includes: - **title** (string): Title of the news - **lang** (string): Language of the news title - **text** (string): Full description of the news - **created_at** (string): Date of the news #### Response Example ```json [ { "title": "New Feature Release", "lang": "en", "text": "MVSEP has released a new feature for advanced audio separation.", "created_at": "2023-10-27T10:00:00Z" } ] ``` ``` -------------------------------- ### Get News API Request Source: https://mvsep.com/en/full_api/index Retrieves the latest news about MVSEP. This is a GET request to the /api/app/news endpoint and supports optional query parameters for language, starting offset, and limit. ```curl curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1' ``` -------------------------------- ### GET LEADERBOARD Source: https://mvsep.com/en/full_api/index Retrieves information about Quality Checker leaderboards. You can filter, sort, and paginate the results. ```APIDOC ## GET LEADERBOARD ### Description To get information about Quality Checker leaderboards, you need to make a GET call to the following url. ### Method GET ### Endpoint `/api/quality_checker/leaderboard` ### Parameters #### Query Parameters - **dataset_type** (String) - Optional - Dataset Type, defaults to `0` (Synth). * `0` - Synth * `1` - Multi * `2` - Piano * `3` - Lead/Back Vocals * `4` - Guitar * `5` - Medley Vox * `6` - Strings * `7` - Wind * `8` - DNR v3 Test * `9` - Super Resolution Checker for Music * `10` - Drums Separation (5 stems) * `11` - Male/Female vocals separation - **start** (Integer) - Optional - Starting point offset, defaults to 0 (i.e. start from latest). - **limit** (Integer) - Optional - Maximum amount of results returned, defaults to 10, maximum is 20. - **algo_name_filter** (String) - Optional - Filters Separation Type/Algorithm names by given text. - **sort** (String) - Optional - Sort by given SDR of the stem. You can get list of sortable values for given dataset type from `sortables` key in response. ### Request Example ```bash curl --location --request GET 'https://mvsep.com/api/quality_checker/leaderboard?&start=1&limit=2&algo_name_filter=MVSep' ``` ### Response #### Success Response (200) - **data** (Array) - Contains array of Quality Checker entries. - **dataset_type** (String) - Used dataset type key. - **sortables** (Object) - Keys that can be used to sort used dataset type by given stem in sequential order. - **sort** (String) - Used sorting key from sortable. #### Response Example ```json { "data": [ { "id": 123, "algo_name": "Example Algo", "main_text": "This is an example algorithm.", "dataset_type": "0", "date": "2023-10-27T10:00:00Z", "sdr": { "VOC": 5.0, "VOC": 4.5 } } ], "dataset_type": "0", "sortables": { "VOC": "VOC SDR", "BASS": "BASS SDR" }, "sort": "VOC" } ``` ``` -------------------------------- ### Get Quality Checker Queue Source: https://mvsep.com/en/full_api/index Retrieves information about Quality Checker queue entries. ```APIDOC ## GET /api/quality_checker/queue ### Description Retrieves information about Quality Checker queue entries. ### Method GET ### Endpoint https://mvsep.com/api/quality_checker/queue ### Parameters #### Query Parameters - **start** (Integer) - Optional - Starting point offset, defaults to 0 (i.e. start from latest). - **limit** (Integer) - Optional - Maximum amount of results returned, defaults to 10, maximum is 20. ### Request Example ```json { "start": 1, "limit": 2 } ``` ### Response #### Success Response (200) - **id** (Integer) - Identification number of entry. - **dataset_type** (Integer) - Dataset Type chosen when adding the entry / Leaderboard type. (0: Synth, 1: Multi, 2: Piano, 3: Lead/Back Vocals, 4: Guitar, 5: Medley Vox, 6: Strings, 7: Wind, 8: DNR v3 Test, 9: Super Resolution Checker for Music, 10: Drums Separation (5 stems), 11: Male/Female vocals separation). - **date** (String) - Created date of the entry. - **algo_name** (String) - Name of the used separation type/algorithm. - **main_text** (String) - Description of the used separation type/algorithm. - **proc** (Integer) - Status of the processing (0: Not processed, 1: Processed). - **proc_remote_date** (String) - Timestamp of processing date. - **msg** (String) - Returns "OK" if successful, otherwise shows error message. - **metrics** (Object) - Information about entry metrics. - **sdr_* ** (Number) - SDR of the corresponding stems (wildcard). - **dataset_name** (String) - Name of the dataset. #### Response Example ```json [ { "id": 123, "dataset_type": 1, "date": "2023-10-27T10:00:00Z", "algo_name": "Example Algorithm", "main_text": "Example Description", "proc": 1, "proc_remote_date": "2023-10-27T10:05:00Z", "msg": "OK", "metrics": {}, "sdr_vocals": -5.2, "dataset_name": "Example Dataset" } ] ``` ``` -------------------------------- ### GET /api/app/algorithms Source: https://mvsep.com/en/full_api/index Retrieves detailed data about available separation types. This endpoint provides information on different algorithms, their parameters, descriptions, and usage statistics. ```APIDOC ## GET /api/app/algorithms ### Description To get the detailed data about separation types, you need to make a GET call to the following url. ### Method GET ### Endpoint https://mvsep.com/api/app/algorithms ### Parameters None ### Request Example ```bash curl --location --request GET 'https://mvsep.com/api/app/algorithms' ``` ### Response #### Success Response (200) Returns data as an array of separation types. Each separation type includes: - **render_id** (string): Separation type value (ID) - **name** (string): The name of the separation type - **algorithm_group_id** (integer): The group where separation type belongs (0: Experimental, 1: Old Models, 2: HQ Models, 3: Ensemble) - **orientation** (integer): For whom does this separation type intended (0: All users, 1: Registered users, 2: Premium users) - **order_id** (integer): The order of the separation type - **price_coefficient** (float): Used to calculate credits for premium users. - **usage** (integer): Monthly usage count of the separation type. - **rating** (object): Monthly usage rating (average, total). - **algorithm_fields** (array): Contains information about additional fields (name, text, options, default_key). - **algorithm_descriptions** (array): Contains descriptions (short_description, long_description, lang). #### Response Example ```json [ { "render_id": "voice", "name": "Voice separation", "algorithm_group_id": 2, "orientation": 0, "order_id": 1, "price_coefficient": 0.5, "usage": 1500, "rating": { "average": 4.5, "total": 120 }, "algorithm_fields": [ { "name": "add_opt1", "text": "Voice Type", "options": "{\"key1\": \"value1\", \"key2\": \"value2\"}", "default_key": "key1" } ], "algorithm_descriptions": [ { "short_description": "Separates voice from music.", "long_description": "

This algorithm is designed to separate vocal tracks from instrumental music with high precision.

", "lang": "en" } ] } ] ``` ``` -------------------------------- ### Get Quality Checker Leaderboard (curl) Source: https://mvsep.com/en/full_api/index Retrieves information about Quality Checker leaderboards. Supports filtering by dataset type, start offset, limit, algorithm name, and sorting by SDR. ```curl curl --location --request GET 'https://mvsep.com/api/quality_checker/leaderboard?&start=1&limit=2&algo_name_filter=MVSep' ``` -------------------------------- ### Get Separation Types API Request Source: https://mvsep.com/en/full_api/index Fetches detailed data about available audio separation types. This is a GET request to the /api/app/algorithms endpoint. The response includes details like render_id, name, algorithm group, orientation, pricing, usage, rating, and algorithm fields. ```curl curl --location --request GET 'https://mvsep.com/api/app/algorithms' ``` -------------------------------- ### Get Quality Checker Entry by ID (curl) Source: https://mvsep.com/en/full_api/index Fetches details for a specific Quality Checker queue entry using its unique ID. The response structure is similar to the GET QUEUE response. ```curl curl --location --request GET 'https://mvsep.com/api/quality_checker/entry?id=7675' ``` -------------------------------- ### Get Separation History API - Curl Source: https://mvsep.com/en/full_api/index Retrieves the user's separation history. Requires the user's API token and accepts optional start and limit parameters for pagination. Returns a list of past separations with their details. ```curl curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=&start=1&limit=2' ``` -------------------------------- ### Get User Information API Source: https://mvsep.com/en/full_api/index This endpoint retrieves basic information about the authenticated user using their API token. ```APIDOC ## GET /api/app/user ### Description Retrieves the profile information of the user associated with the provided API token. ### Method GET ### Endpoint `https://mvsep.com/api/app/user` ### Parameters #### Query Parameters - **api_token** (String) - Required - The API key of the user. ### Request Example ```json { "api_token": "YOUR_API_TOKEN" } ``` ### Response #### Success Response (200) - **success** (Boolean) - `true` if the API key is valid, `false` otherwise. - **data** (Object) - Contains user information if the API key is valid. - **name** (String) - Name of the user. - **email** (String) - Email of the user. - **api_token** (String) - The API key of the user. - **premium_minutes** (Integer) - Credits left for the user. - **premium_enabled** (Integer) - Whether user allowed credits to be spent (`0` - disallowed, `1` - allowed). - **long_filenames_enabled** (Integer) - Whether user wants extra information in filenames (`0` - shorter, `1` - longer). - **current_queue** (Array) - Shows ongoing separations for the user. #### Error Response (400) - **success** (Boolean) - `false`. - **message** (String) - "Invalid API key." ``` -------------------------------- ### Get User Profile API - Curl Source: https://mvsep.com/en/full_api/index Retrieves the authenticated user's profile information. Requires the user's API token. Returns user details including credits and enabled features. ```curl curl --location --request GET 'https://mvsep.com/api/app/user?api_token=' ``` -------------------------------- ### Get Separation History API Source: https://mvsep.com/en/full_api/index This endpoint retrieves a basic history of the user's audio separation jobs. ```APIDOC ## GET /api/app/separation_history ### Description Retrieves a list of previous audio separation jobs for the user. ### Method GET ### Endpoint `https://mvsep.com/api/app/separation_history` ### Parameters #### Query Parameters - **api_token** (String) - Required - API key of the user. - **start** (Integer) - Optional - Starting point offset, defaults to 0 (i.e., start from latest). - **limit** (Integer) - Optional - Maximum amount of results returned, defaults to 10, maximum is 20. ### Request Example ```json { "api_token": "YOUR_API_TOKEN", "start": 1, "limit": 2 } ``` ### Response #### Success Response (200) - **success** (Boolean) - `true` if the API key is valid, `false` otherwise. - **data** (Array) - Contains basic information about previous separations. - **hash** (String) - Separation Hash. - **job_exists** (Boolean) - Indicates if the separation job exists. - **credits** (Integer or null) - How many credits were used for the job, `null` if separation does not exist. - **time_left** (Integer) - Approximate time left until the job is deleted. - **algorithm** (String) - The separation algorithm used. #### Error Response (400) - **success** (Boolean) - `false`. - **message** (String) - "Invalid API key." ``` -------------------------------- ### GET /api/separation/get Source: https://mvsep.com/en/full_api/index Retrieves the separation result for a given hash. This endpoint supports an optional mirror parameter for using alternative mirrors, which requires an API token and consumes one credit. ```APIDOC ## GET /api/separation/get ### Description Retrieves the separation result for a given hash. This endpoint supports an optional mirror parameter for using alternative mirrors, which requires an API token and consumes one credit. ### Method GET ### Endpoint https://mvsep.com/api/separation/get ### Parameters #### Query Parameters - **hash** (String) - Required - Separation Hash - **mirror** (Integer) - Optional - Uses another mirror if set to 1, defaults to 0. Requires api_token and 1 credit if set to 1. - **api_token** (string) - Optional - API key of the user. Required if mirror parameter is set to 1. ### Request Example ```bash curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3' ``` ### Response #### Success Response (200) - **success** (Boolean) - Indicates if the file hash is found and valid. - **status** (String) - The current status of the job (e.g., `not_found`, `waiting`, `processing`, `done`, `failed`, `distributing`, `merging`). - **data** (Object) - Contains extra information depending on the `status` key. - **data.queue_count** (Integer) - Shows unprocessed jobs count in user's priority (only shown when `status` is `waiting` or `distributing`). - **data.current_order** (Integer) - Shows the order of user's job (only shown when `status` is `waiting` or `distributing`). - **data.message** (String) - Shows the description of status (shown on all statuses, shows error reason instead when `status` is `failed`). - **data.algorithm** (String) - Shows the used algorithm on job (only shown when `status` is `done`). - **data.algorithm_description** (String) - Shows the used algorithm details on job (only shown when `status` is `done`). - **data.output_format** (String) - Shows the output format of job (only shown when `status` is `done`). - **data.tags** (Object) - Shows the audio meta tags (only shown when `status` is `done`). - **data.input_file** (Object) - Shows the input audio download details (only shown when `status` is `done`). - **data.files** (Array) - Shows the output audios download details (only shown when `status` is `done`). - **data.date** (String) - Shows the job processing date (only shown when `status` is `done`). - **data.finished_chunks** (Integer) - Shows the number of finished parts of a large job (only shown when `status` is `distributing`). - **data.all_chunks** (Integer) - Shows the number of all parts of a large job (only shown when `status` is `distributing`). #### Response Example ```json { "success": true, "status": "done", "data": { "message": "Job successfully processed.", "algorithm": "MDX-Net", "algorithm_description": "A deep learning model for source separation.", "output_format": "mp3", "tags": { "title": "Example Song" }, "input_file": { "name": "dimensions.mp3", "url": "https://mvsep.com/download/input/... }, "files": [ { "name": "vocals.mp3", "url": "https://mvsep.com/download/vocals/... }, { "name": "instrumental.mp3", "url": "https://mvsep.com/download/instrumental/... } ], "date": "2023-03-27T07:16:01Z", "finished_chunks": 0, "all_chunks": 0 } } ``` ``` -------------------------------- ### Get Separation Result Source: https://mvsep.com/en/full_api/index Retrieve the result of a previous audio separation job using its hash. This endpoint allows optional mirroring to use alternative servers. It returns status and data related to the separation job. ```curl curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3' ``` -------------------------------- ### CREATE ENTRY Source: https://mvsep.com/en/full_api/index Creates a new Quality Checker entry by uploading a zip file and providing algorithm details. ```APIDOC ## CREATE ENTRY ### Description To create a Quality Checker entry, you need to make a POST call to the following url. This endpoint allows you to upload a zip file, specify algorithm details, and set various parameters. ### Method POST ### Endpoint `/api/quality_checker/add` ### Parameters #### Query Parameters - **api_token** (String) - Required - Your API key. - **zipfile** (Binary) - Required - Zip file to be processed. - **algo_name** (String) - Required - Name of the algorithm. - **main_text** (String) - Required - Description of the algorithm. - **dataset_type** (String) - Optional - Dataset type. Defaults to `0`. * `0` - Synth * `1` - Multi * `2` - Piano * `3` - Lead/Back Vocals * `4` - Guitar * `5` - Medley Vox * `6` - Strings * `7` - Wind * `8` - DNR v3 Test * `9` - Super Resolution Checker for Music * `10` - Drums Separation (5 stems) * `11` - Male/Female vocals separation - **password** (String) - Required - Password to delete the algorithm. - **ensemble** (Integer) - Optional - `0` if the algorithm is not ensemble, `1` if it is ensemble. ### Request Example ```bash curl --location 'https://mvsep.com/api/quality_checker/add' \ --form 'zipfile=@"/path/to/zipfile"' \ --form 'algo_name="Test Algorithm Name"' \ --form 'main_text="Test Algorithm Description"' \ --form 'dataset_type="2"' \ --form 'ensemble="1"' \ --form 'password="test"' ``` ### Response #### Success Response (200) - **success** (Boolean) - `true` if the entry was created successfully, `false` otherwise. - **data** (Object) - Contains information about the entry. - **id** (Integer) - ID of the entry. - **link** (String) - Link to the entry. #### Response Example ```json { "success": true, "data": { "id": 456, "link": "https://mvsep.com/api/quality_checker/entry?id=456" } } ``` ``` -------------------------------- ### Enable Premium Usage Source: https://mvsep.com/en/full_api/index Enables premium usage for a user by making a POST request to the API. ```APIDOC ## POST /api/app/enable_premium ### Description Enables premium usage for the user. ### Method POST ### Endpoint https://mvsep.com/api/app/enable_premium ### Parameters #### Query Parameters - **api_token** (String) - Required - API key of the user ### Request Example ```json { "api_token": "" } ``` ### Response #### Success Response (200) - **success** (Boolean) - Indicates if the operation was successful. `true` for success, `false` for failure. - **message** (String) - Informs about the status of the operation. #### Response Example ```json { "success": true, "message": "Premium usage enabled successfully." } ``` ``` -------------------------------- ### Create Quality Checker Entry (curl) Source: https://mvsep.com/en/full_api/index Creates a new Quality Checker entry by uploading a zip file. Requires API token, zip file, algorithm name, description, dataset type, and password. Ensemble status is optional. ```curl curl --location 'https://mvsep.com/api/quality_checker/add' --form 'zipfile=@"/path/to/zipfile"' --form 'algo_name="Test Algorithm Name"' --form 'main_text="Test Algorithm Description"' --form 'dataset_type="2"' --form 'ensemble="1"' --form 'password="test"' ``` -------------------------------- ### Enable Premium Usage (Curl) Source: https://mvsep.com/en/full_api/index Enables premium usage for a user by making a POST call to the enable_premium endpoint. Requires a valid API token. Returns success status and a message. ```curl curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token=""' ``` -------------------------------- ### User Registration API Source: https://mvsep.com/en/full_api/index This endpoint allows new users to register on the MVSEP platform. It requires user's name, email, password, and password confirmation. ```APIDOC ## POST /api/app/register ### Description Registers a new user on the MVSEP platform. ### Method POST ### Endpoint `https://mvsep.com/api/app/register` ### Parameters #### Query Parameters - **name** (String) - Required - Name of the user. - **email** (String) - Required - Email of the user. - **password** (String) - Required - Password of the user. - **password_confirmation** (String) - Required - Repeat the password of the user. ### Request Example ```json { "name": "John Doe", "email": "john.doe@example.com", "password": "secure_password", "password_confirmation": "secure_password" } ``` ### Response #### Success Response (200) - **success** (Boolean) - `true` if registration is successful. - **message** (String) - A success message. #### Error Response (400) - **success** (Boolean) - `false`. - **message** (String) - Indicates the reason for failure (e.g., invalid email, user exists, incorrect password confirmation). ``` -------------------------------- ### MVSep Keys (keys, other) Source: https://mvsep.com/en/full_api/index Separates key instrument tracks from audio. ```APIDOC ## GET /websites/mvsep_en_full_api/mvsep_keys ### Description Separates key instrument tracks from audio. ### Method GET ### Endpoint /websites/mvsep_en_full_api/mvsep_keys ### Parameters No specific parameters mentioned for this model in the provided text. ### Response #### Success Response (200) - **audio_files** (object) - Contains URLs to the separated key instrument audio tracks. ``` -------------------------------- ### htdemucs_6s Source: https://mvsep.com/en/full_api/index 6 stems separation model with additional piano and guitar outputs. ```APIDOC ## GET /websites/mvsep_en_full_api/htdemucs_6s ### Description Performs audio separation into 6 stems, including additional outputs for piano and guitar. ### Method GET ### Endpoint /websites/mvsep_en_full_api/htdemucs_6s ### Parameters #### Query Parameters - **add_opt1** (integer) - Optional - Model selection for stem separation. Options: 2 (htdemucs_6s - default). ### Response #### Success Response (200) - **audio_files** (object) - Contains URLs to the separated audio stems. ``` -------------------------------- ### Create Separation API Source: https://mvsep.com/en/full_api/index Initiates an audio separation process. You can upload an audio file directly or provide a URL. Optional parameters allow for specifying separation types, additional options, output format, and demo publishing. ```APIDOC ## POST /api/separation/create ### Description To create separation you need to make a POST call to the following url. ### Method POST ### Endpoint `https://mvsep.com/api/separation/create` ### Parameters #### Query Parameters - **api_token** (String) - Required - Your API key - **audiofile** (Binary) - Optional - Audiofile to be processed. Not required if `url` parameter is set - **url** (String) - Optional - Link to the audiofile. Not required if `audiofile` parameter is set - **remote_type** (String) - Optional - Remote type of the audiofile. Defaults to `direct`. Supported types are `direct`, `mega`, `drive`, `dropbox` - **sep_type** (Integer) - Optional - Separation Type, defaults to 20. Refer to the GET SEPARATION TYPES section for more information. - **add_opt1** (String) - Optional - Separation Type first additional field - **add_opt2** (String) - Optional - Separation Type second additional field - **add_opt3** (String) - Optional - Separation Type third additional field - **output_format** (Integer) - Optional - output format, defaults to 0 (mp3 (320kbps)) - **is_demo** (Boolean) - Optional - should the separation be published to demo page, defaults to false ### Request Example ```json { "api_token": "YOUR_API_TOKEN", "audiofile": "(binary data)", "url": "(optional audio url)", "remote_type": "direct", "sep_type": 20, "add_opt1": "(optional)", "add_opt2": "(optional)", "add_opt3": "(optional)", "output_format": 0, "is_demo": false } ``` ### Response #### Success Response (200) - **job_id** (String) - The unique identifier for the separation job. - **status** (String) - The current status of the job (e.g., "processing", "completed", "failed"). #### Response Example ```json { "job_id": "a1b2c3d4e5f67890", "status": "processing" } ``` ``` -------------------------------- ### MVSep Acoustic Guitar (acoustic-guitar, other) Source: https://mvsep.com/en/full_api/index Extracts acoustic guitar tracks from audio. ```APIDOC ## GET /websites/mvsep_en_full_api/mvsep_acoustic_guitar ### Description Extracts acoustic guitar tracks from audio, with options for extraction method. ### Method GET ### Endpoint /websites/mvsep_en_full_api/mvsep_acoustic_guitar ### Parameters #### Query Parameters - **add_opt2** (integer) - Optional - Specifies how to extract the acoustic guitar. Options: 0 (Extract directly from mixture - default), 1 (Extract from guitar part). ### Response #### Success Response (200) - **audio_files** (object) - Contains URLs to the separated acoustic guitar audio tracks. ``` -------------------------------- ### Register User API - Curl Source: https://mvsep.com/en/full_api/index Registers a new user to the MVSEP site. Requires name, email, password, and password confirmation. Returns success or failure status with a message. ```curl curl --location --request GET 'https://mvsep.com/api/app/register' --form 'name="user"' --form 'email="asdf@example.com"' --form 'password="ASDFQWEr123"' --form 'password_confirmation="ASDFQWEr123"' ``` -------------------------------- ### MVSep Electric Guitar (electric-guitar, other) Source: https://mvsep.com/en/full_api/index Extracts electric guitar tracks from audio. ```APIDOC ## GET /websites/mvsep_en_full_api/mvsep_electric_guitar ### Description Extracts electric guitar tracks from audio, with options for extraction method. ### Method GET ### Endpoint /websites/mvsep_en_full_api/mvsep_electric_guitar ### Parameters #### Query Parameters - **add_opt2** (integer) - Optional - Specifies how to extract the electric guitar. Options: 0 (Extract directly from mixture - default), 1 (Extract from guitar part). ### Response #### Success Response (200) - **audio_files** (object) - Contains URLs to the separated electric guitar audio tracks. ``` -------------------------------- ### POST /api/separation/cancel Source: https://mvsep.com/en/full_api/index Cancels an ongoing separation job. If the separation has not yet started processing, the credits used for the job will be refunded. ```APIDOC ## POST /api/separation/cancel ### Description Cancels an ongoing separation job. If the separation has not yet started processing, the credits used for the job will be refunded. ### Method POST ### Endpoint https://mvsep.com/api/separation/cancel ### Parameters #### Query Parameters - **api_token** (string) - Required - API key of the user - **hash** (string) - Required - Separation Hash ### Request Example ```bash curl --location --request POST 'https://mvsep.com/api/separation/cancel' \ --form 'api_token=""' \ --form 'hash=""' ``` ### Response #### Success Response (200) *The response for this endpoint is not explicitly detailed in the provided documentation. Typically, it would return a success message or status indicating the cancellation. #### Response Example ```json { "success": true, "message": "Separation cancelled successfully." } ``` ``` -------------------------------- ### Separation Type: BS Roformer SW (vocals, bass, drums, guitar, piano, other) Source: https://mvsep.com/en/full_api/index Configures audio separation for a specific set of instruments using the BS Roformer model. ```APIDOC ## POST /websites/mvsep_en_full_api ### Description This endpoint allows for audio separation with various configuration options, including separation type and additional model parameters. ### Method POST ### Endpoint /websites/mvsep_en_full_api ### Parameters #### Request Body - **sep_type** (integer) - Required - The type of separation. For 'BS Roformer SW (vocals, bass, drums, guitar, piano, other)', the value is 63. ### Request Example ```json { "sep_type": 63 } ``` ### Response #### Success Response (200) - **output_url** (string) - URL to the processed audio file. - **status** (string) - Processing status. #### Response Example ```json { "output_url": "http://example.com/output.wav", "status": "processing" } ``` ``` -------------------------------- ### MVSep Lead/Rhythm Guitar (lead-guitar, rhythm-guitar) Source: https://mvsep.com/en/full_api/index Separates lead and rhythm guitar tracks using MVSep models. ```APIDOC ## GET /websites/mvsep_en_full_api/mvsep_lead_rhythm_guitar ### Description Separates lead and rhythm guitar tracks using MVSep models, with options for one-stage or two-stage extraction. ### Method GET ### Endpoint /websites/mvsep_en_full_api/mvsep_lead_rhythm_guitar ### Parameters #### Query Parameters - **add_opt1** (integer) - Optional - Specifies the model type. Options: 0 (Two-stage model - default), 1 (One-stage model). ### Response #### Success Response (200) - **audio_files** (object) - Contains URLs to the separated lead and rhythm guitar audio tracks. ``` -------------------------------- ### GET /api/separation/get-remote Source: https://mvsep.com/en/full_api/index Retrieves the result of a remote job using its hash. This endpoint is used to check the status and obtain the link for results of jobs initiated remotely. ```APIDOC ## GET /api/separation/get-remote ### Description Retrieves the result of a remote job using its hash. This endpoint is used to check the status and obtain the link for results of jobs initiated remotely. ### Method GET ### Endpoint https://mvsep.com/api/separation/get-remote ### Parameters #### Query Parameters - **hash** (String) - Required - Separation Hash ### Request Example ```bash curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR' ``` ### Response #### Success Response (200) - **success** (Boolean) - Indicates if the file hash is found and valid. - **status** (String) - The current status of the job (e.g., `not_found`, `waiting`, `processing`, `done`, `failed`). - **data** (Object) - Contains extra information depending on the `status` key. - **data.queue_count** (Integer) - Shows unprocessed jobs count in user's priority (only shown when `status` is `waiting`). - **data.current_order** (Integer) - Shows the order of user's job (only shown when `status` is `waiting`). - **data.message** (String) - Shows the description of status (only when `status` is `failed`). - **data.link** (String) - Shows link to "GET RESULT" URL of created job (only shown when `status` is `done`). - **data.hash** (String) - Hash of the separation (only shown when `status` is `done`). #### Response Example ```json { "success": true, "status": "done", "data": { "message": "Job finished.", "link": "https://mvsep.com/get/result/xyz123abc", "hash": "xyz123abc" } } ``` ``` -------------------------------- ### MVSep Digital Piano (digital-piano, other) Source: https://mvsep.com/en/full_api/index Extracts digital piano tracks from audio. ```APIDOC ## GET /websites/mvsep_en_full_api/mvsep_digital_piano ### Description Extracts digital piano tracks from audio, with options for extraction method. ### Method GET ### Endpoint /websites/mvsep_en_full_api/mvsep_digital_piano ### Parameters #### Query Parameters - **add_opt2** (integer) - Optional - Specifies how to extract the digital piano. Options: 0 (Extract directly from mixture - default), 1 (Extract from piano part). ### Response #### Success Response (200) - **audio_files** (object) - Contains URLs to the separated digital piano audio tracks. ``` -------------------------------- ### Get Remote Separation Result Source: https://mvsep.com/en/full_api/index Retrieve the result of a remote audio separation job using its hash. This endpoint is specifically for jobs initiated remotely and provides status and a link to the result upon completion. ```curl curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR' ``` -------------------------------- ### Enable Long Filenames (Curl) Source: https://mvsep.com/en/full_api/index Enables long filenames for a user by making a POST call to the enable_long_filenames endpoint. Requires a valid API token. Returns success status and a message. ```curl curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token=""' ``` -------------------------------- ### Cancel Separation Job Source: https://mvsep.com/en/full_api/index Cancel an ongoing or pending audio separation job. This action may refund credits if the job has not yet started processing. It requires the user's API token and the separation hash. ```curl curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token=""' --form 'hash=""' ``` -------------------------------- ### MVSep Guitar (guitar, other) Source: https://mvsep.com/en/full_api/index Separates guitar tracks from other instruments using various MVSep Guitar models. ```APIDOC ## GET /websites/mvsep_en_full_api/mvsep_guitar ### Description Separates guitar tracks from other audio components using a selection of MVSep Guitar models. ### Method GET ### Endpoint /websites/mvsep_en_full_api/mvsep_guitar ### Parameters #### Query Parameters - **add_opt1** (integer) - Optional - Specifies the Guitar model type. Options: 0 (mdx23c 2023.08), 2 (mdx23c 2024.06), 3 (MelRoformer), 5 (BSRoformer), 6 (Ensemble - BS + Mel), 7 (BS Roformer SW - default). ### Response #### Success Response (200) - **audio_files** (object) - Contains URLs to the separated guitar and other instrument audio tracks. ``` -------------------------------- ### Login User API - Curl Source: https://mvsep.com/en/full_api/index Authenticates a user and retrieves their API key. Requires email and password. Returns user details upon successful authentication, otherwise indicates an error. ```curl curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email=""' --form 'password=""' ```