turbo@mvsep.com
L'API di MVSEP fornisce accesso programmatico per creare una separazione, restituisce i risultati, ottiene le informazione del sito e controlla la capacità dell'utente.
Per utilizzare questa API, hai bisogno di una chiave API. Non sei loggato, accedi per ottenere il tuo token API.
Examples in Python: https://github.com/ZFTurbo/MVSep-API-Examples
Unofficial application MacVSep for Mac OS: https://github.com/septcoco/macvsep
Webhooks can be setup here: Webhooks Page
Si noti che gli utenti Premium possono richiedere fino a 10 lavori contemporanei, mentre gli utenti non Premium possono richiedere solo 1 lavoro contemporaneo.
Per creare una separazione devi effettuare una chiamata POST al seguente URL:
https://mvsep.com/api/separation/create
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | String | La tua chiave API |
| audiofile | Binary | File audio da elaborare. Not required if url parameter is set |
| url | String | Link to the audiofile. Not required if audiofile parameter is set |
| remote_type | String | (optional) Remote type of the audiofile. Defaults to direct. Not required if audiofile parameter is set. Supported types are direct (Direct Download), mega (MEGA), drive (Google Drive), dropbox (Dropbox) |
| sep_type | Integer | (opzionale) Tipo di separazione, predefinito 11 (Modello Demucs3 B (voce, batteria, basso, altro)) |
| add_opt1 | String | (opzionale) Primo campo aggiuntivo del tipo di separazione |
| add_opt2 | String | (opzionale) Secondo campo aggiuntivo del tipo di separazione |
| add_opt3 | String | (Facoltativo) Tipo di separazione, terzo campo addizionale |
| output_format | Integer | (opzionale) formato di output, predefinito 0 (mp3 (320kbps)) |
| is_demo | Boolean | (opzionale) la separazione dovrebbe essere pubblicata sulla pagina demo, predefinito è falso |
| Nome | Valore | Additional fields |
|---|---|---|
| Ensemble (vocals, instrum) | 26 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| Ensemble (vocals, instrum, bass, drums, other) | 28 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | Key: add_opt1 Name: Output files Options:
Key: add_opt2 Name: Model Type Options:
|
| BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
| BS Roformer (vocals, instrumental) | 40 | Key: add_opt1 Name: Vocal model type Options:
|
| MelBand Roformer (vocals, instrumental) | 48 | Key: add_opt1 Name: Vocal model type Options:
|
| MDX23C (vocals, instrumental) | 25 | Key: add_opt1 Name: Vocal model type Options:
|
| SCNet (vocals, instrumental) | 46 | Key: add_opt1 Name: Vocal model type Options:
|
| Demucs4 HT (vocals, drums, bass, other) | 20 | Key: add_opt1 Name: Model type Options:
|
| MDX B (vocals, instrumental) | 23 | Key: add_opt1 Name: Vocal model type Options:
|
| Ultimate Vocal Remover VR (vocals, music) | 9 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Agressiveness Options:
|
| Demucs4 Vocals 2023 (vocals, instrum) | 27 | |
| MelBand Karaoke (lead/back vocals) | 49 | Key: add_opt1 Name: Karaoke model type Options:
Key: add_opt2 Name: Extraction type Options:
|
| MDX-B Karaoke (lead/back vocals) | 12 | Key: add_opt1 Name: Karaoke model type Options:
|
| MVSep Piano (piano, other) | 29 | Key: add_opt1 Name: Piano model type Options:
|
| MVSep Guitar (guitar, other) | 31 | Key: add_opt1 Name: Guitar model type Options:
|
| MVSep Bass (bass, other) | 41 | Key: add_opt1 Name: Bass model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| MVSep Drums (drums, other) | 44 | Key: add_opt1 Name: Drums model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| MVSep Strings (strings, other) | 52 | |
| MVSep Wind (wind, other) | 54 | Key: add_opt1 Name: Wind model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| MVSep Organ (organ, other) | 58 | Key: add_opt1 Name: Organ model type Options:
|
| MVSep Saxophone (saxophone, other) | 61 | Key: add_opt1 Name: Model type Options:
|
| MVSep Violin (violin, other) | 65 | |
| Apollo Enhancers (by JusperLee and Lew) | 51 | Key: add_opt1 Name: Model type Options:
|
| Reverb Removal (noreverb) | 22 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
| MVSep Crowd removal (crowd, other) | 34 | Key: add_opt1 Name: Model type Options:
|
| MVSep Demucs4HT DNR (dialog, sfx, music) | 24 | Key: add_opt1 Name: Model type Options:
|
| BandIt Plus (speech, music, effects) | 36 | |
| BandIt v2 (speech, music, effects) | 45 | Key: add_opt1 Name: Model Type Options:
|
| MVSep DnR v3 (speech, music, sfx) | 56 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| DrumSep (4-6 stems: kick, snare, cymbals, toms, ride, hh, crash) | 37 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
| DeNoise by aufr33 | 47 | Key: add_opt1 Name: Model type Options:
|
| Whisper (extract text from audio) | 39 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Transcription type Options:
|
| Parakeet (extract text from audio) | 64 | Key: add_opt1 Name: Model type Options:
|
| Medley Vox (Multi-singer separation) | 53 | Key: add_opt1 Name: Model type Options:
|
| MVSep Multichannel BS (vocals, instrumental) | 43 | Key: add_opt1 Name: Model Type Options:
|
| MVSep Male/Female separation | 57 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
|
| MDX A/B (vocals, drums, bass, other) | 7 | Key: add_opt1 Name: Vocal model type Options:
|
| Demucs3 Model (vocals, drums, bass, other) | 10 | Key: add_opt1 Name: Model type Options:
|
| Vit Large 23 (vocals, instrum) | 33 | Key: add_opt1 Name: Model type Options:
|
| UVRv5 Demucs (vocals, music) | 17 | Key: add_opt1 Name: Model Type Options:
|
| MVSep DNR (music, sfx, speech) | 18 | |
| MVSep Vocal Model (vocals, music) | 19 | |
| Demucs2 (vocals, drums, bass, other) | 13 | |
| Danna Sep (vocals, drums, bass, other) | 15 | |
| Byte Dance (vocals, drums, bass, other) | 16 | |
| MVSep MelBand Roformer (vocals, instrum) | 35 | |
| spleeter | 0 | Key: add_opt1 Name: Model type Options:
|
| UnMix | 3 | Key: add_opt1 Name: Model type Options:
|
| Zero Shot (Query Based) (Low quality) | 14 | Key: add_opt1 Name: Model Type Options:
|
| LarsNet (kick, snare, cymbals, toms, hihat) | 38 | Key: add_opt1 Name: Model type Options:
|
| Stable Audio Open Gen | 62 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Length (in seconds) Options:
|
| MVSep MultiSpeaker (MDX23C) | 42 | Key: add_opt1 Name: Model Type Options:
|
| Aspiration (by Sucial) | 50 | Key: add_opt1 Name: Model type Options:
|
| AudioSR (Super Resolution) | 59 | Key: add_opt1 Name: Cutoff (Hz) Options:
|
| Phantom Centre extraction (by wesleyr36) | 55 | |
| FlashSR (Super Resolution) | 60 |
| Nome | Valore |
|---|---|
| mp3 (320 kbps) | 0 |
| wav (uncompressed, 16 bit) | 1 |
| flac (lossless, 16 bit) | 2 |
| m4a (lossy) | 3 |
| wav (uncompressed, 32 bit) | 4 |
| flac (lossless, 24 bit) | 5 |
curl --location --request POST 'https://mvsep.com/api/separation/create'
--form 'audiofile=@"/path/to/file.mp3"'
--form 'api_token="<Il tuo Token API>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Chiave | Valore |
|---|---|
| success |
|
| data | Contiene informazioni extra dipendenti dalla chiave success |
| data -> link | Mostra link all'URL "OTTIENI IL RISULTATO" del processo creato (mostrato solo nel caso in cui success è true) |
| data -> hash | Mostra l'hash del processo creato (mostrato solo nel caso in cui success è true) |
| data -> message | Mostra la descrizione di un errore (mostrato solo nel caso in cui success è false
|
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Mancano alcuni parametri o sono non validi. Questo errore appare quando non si passano tutti i parametri obbligatori o si passano parametri non validi. |
| 401 |
api_token sconosciuto o non valido. Questo errore appare se si utilizza una chiave API sconosciuta
|
Per ottenere il risultato della separazione, è necessario effettuare una chiamata GET al seguente URL:
https://mvsep.com/api/separation/get
| Campo | Tipo | Descrizione |
|---|---|---|
| hash | String | Hash della separazione |
| mirror | Integer | (Facoltativo) Usa un altro mirror se è impostato su 1, predefinito a 0. Richiede api_token e 1 credito se impostato a 1. |
| api_token | string | (Facoltativo) Chiave API dell'utente. Richiesto se il parametro del mirror è impostato a 1. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Chiave | Valore |
|---|---|
| success |
|
| status |
|
| data | Contiene informazioni extra che dipendono dalla chiave status |
| data -> queue_count | Mostra il numero dei processi non completati nella priority dell'utente (mostrato solo nel caso in cui status è waiting o distributing) |
| data -> current_order | Mostra l'ordine del processo dell'utente (mostrato solo nel caso in cui status è waiting o distributing) |
| data -> message | Mostra la descrizione dello stato (mostrato su tutti gli status, altrimenti mostra la ragione degli errori quando i>status è failed) |
| data -> algorithm | Mostra l'algoritmo utilizzato nel processo (mostrato solo quando status è done) |
| data -> algorithm_description | Mostra i dettagli dell'algoritmo utilizzato nel processo (mostrato solo quando status è done) |
| data -> output_format | Mostra il formato dell'output del processo (mostrato solo quando status è done) |
| data -> tags | Mostra i meta tags dell'audio (mostrato solo quando status è done) |
| data -> input_file | Mostra i dettagli del download dell'input audio (mostrato solo quando status è done) |
| data -> files | Mostra i dettagli del download degli output audio (mostrato solo quando status è done |
| data -> date | Mostra la data dell'inizio del processo (mostrato solo quando status è done) |
| data -> finished_chunks | Mostra il numero delle parti finite di un processo grande (mostrato solo quando status è distributing) |
| data -> all_chunks | Mostra il numero di tutte le parti di un processo grande (mostrato solo quando status è distributing) |
To get the result of remote job, you need to make a GET call to the following url:
https://mvsep.com/api/separation/get-remote
| Campo | Tipo | Descrizione |
|---|---|---|
| hash | String | Hash della separazione |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Chiave | Valore |
|---|---|
| success |
|
| status |
|
| data | Contiene informazioni extra che dipendono dalla chiave status |
| data -> queue_count | Shows unprocessed jobs count in user's priority (only shown when status is waiting) |
| data -> current_order | Shows the order of user's job (only shown when status is waiting) |
| data -> message | Shows the description of status (only when status is failed) |
| data -> link | Shows link to "GET RESULT" URL of created job (only shown when status is done) |
| data -> hash | Hash of the separation (only shown when status is done) |
To cancel the separation and refund used credits (if the separation is not being processed yet), you need to make a POST call to the following url:
https://mvsep.com/api/separation/cancel
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | string | Chiave API dell'utente |
| hash | string | Hash della separazione |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Il tuo Token API>"' --form 'hash="<hash>"'
| Chiave | Valore |
|---|---|
| success |
|
Per ottenere dati dettagliati sui tipi di separazione, devi fare una chiamata GET al seguente url:
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Restituisce i dati come un array (vettore):
| Chiave | Valore |
|---|---|
| render_id | Valore del tipo di separazione (ID) |
| name | Nome del tipo di separazione |
| algorithm_group_id |
Il gruppo a cui appartiene il tipo di separazione:
|
| orientation |
Per coloro a cui è destinato questo tipo di separazione:
|
| order_id | L'ordine del tipo di separazione |
| price_coefficient |
Usato per calcolare quanti crediti servono al processo per un utente premium. Usa questa formula : floor(<Durata dell'audiofile in secondi> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | Contiene informazioni riguardo i campi addizionali dei tipi di separazione |
| algorithm_fields -> name |
Mostra quale campo addizionale del tipo di separazione:
|
| algorithm_fields -> text | Mostra il nome del campo addizionale del tipo di separazione |
| algorithm_fields -> options | Valore delle catene della chiave codificata JSON del campo addizionale |
| algorithm_fields -> default_key | Valore predefinito del campo addizionale. Una delle chiavi di <code>algorithm_fields -> options</code> |
| algorithm_descriptions | Contiene informazioni sulla descrizione del tipo di separazione. |
| algorithm_descriptions -> short_description | Piccola descrizione del tipo di separazione che non usa HTML. |
| algorithm_descriptions -> long_description | Descrizione dettagliata del tipo di separazione che usa HTML. |
| algorithm_descriptions -> lang | Specifica il codice della lingua della descrizione. |
Per ottenere informazioni sulle ultime novità di MVSEP, devi fare una chiamata GET al seguente url:
https://mvsep.com/api/app/news
| Campo | Tipo | Descrizione |
|---|---|---|
| lang | String | (facoltativo) codice lingua a 2 lettere (en, ru) |
| start | Integer | (facoltativo) Punto di inizio offset, predefiniti a 0 (i.e. comincia dall'ultimo) |
| limit | Integer | (facoltativo) Massima quantità di dettagli restituita, predefiniti a 10, il massimo è 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Restituisce i dati come un array (vettore):
| Chiave | Valore |
|---|---|
| title | Titolo delle notizie |
| lang | Titolo delle notizie |
| text | Descrizione completa delle notizie |
| created_at | Data delle notizie |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | String | (optional) Chiave API dell'utente |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Chiave | Valore |
|---|---|
| queue |
Contains array of current queues for different plans:
|
| plan |
Contains current queue for current plan (add api_token to request for registered/premium plan):
|
Per avere informazioni sulle separazioni demo, devi fare una chiamata GET al seguente url:
https://mvsep.com/api/app/demo
| Campo | Tipo | Descrizione |
|---|---|---|
| start | Integer | (facoltativo) Punto di inizio offset, predefiniti a 0 (i.e. comincia dall'ultimo) |
| limit | Integer | (facoltativo) Massima quantità di dettagli restituita, predefiniti a 10, il massimo è 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Restituisce i dati come un array (vettore):
| Chiave | Valore |
|---|---|
| hash | Hash della separazione |
| date | Data della separazione |
| input_audio | URL dell'input audio |
| size | Dimensioni dell'input audio |
| algorithm | Contieni informazioni base sul tipo di separazione utilizzata (si riferisce al tab "OTTIENI TIPI DI SEPARAZIONE" per informazioni sui parametri restituiti) |
Per autenticare l'utente e ottenere la sua chiave API, devi fare una chiamata POST al seguente url:
https://mvsep.com/api/app/login
| Campo | Tipo | Descrizione |
|---|---|---|
| String | Email dell'utente | |
| password | String | Password dell'utente |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Email dell'utente>"' --form 'password="<Password dell'utente>"'
| Chiave | Valore |
|---|---|
| success |
|
| data | Contiene informazioni quando le credenziali sono corrette |
| data -> name | Nome dell'utente |
| data -> email | Email dell'utente |
| data -> api_token | La chiave API dell'utente. Assicurati di conservarla in un posto sicuro e usuale per le operazioni successive. |
| data -> premium_minutes | Crediti rimanenti dell'utente |
| data -> premium_enabled |
Se l'utente ha acconsentito che i crediti vengano spesi.
|
| data -> long_filenames_enabled |
Se l'utente vuole informazioni extra sui nomi dei file:
|
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Credenziali inserite non corrette |
Per registrare l'utente al sito MVSEP, devi fare una chiamata POST al seguente url:
https://mvsep.com/api/app/register
| Campo | Tipo | Descrizione |
|---|---|---|
| name | String | Nome dell'utente |
| String | Email dell'utente | |
| password | String | Password dell'utente |
| password_confirmation | String | Reinserisci la password dell'utente |
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"'
| Chiave | Valore |
|---|---|
| success |
|
| message | Avviene quando il modulo è valido |
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Modulo invalido |
Per ottenere informazioni sull'utente, devi fare una chiamata GET al seguente url:
https://mvsep.com/api/app/user
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | String | Chiave API dell'utente |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Il tuo Token API>'
| Chiave | Valore |
|---|---|
| success |
|
| data | Contiene informazioni quando le credenziali sono corrette |
| data -> name | Nome dell'utente |
| data -> email | Email dell'utente |
| data -> api_token | La chiave API dell'utente. Assicurati di conservarla in un posto sicuro e usuale per le operazioni successive. |
| data -> premium_minutes | Crediti rimanenti dell'utente |
| data -> premium_enabled |
Se l'utente ha acconsentito che i crediti vengano spesi.
|
| data -> long_filenames_enabled |
Se l'utente vuole informazioni extra sui nomi dei file:
|
| data -> current_queue | Mostra le separazioni in corso per l'utente |
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Chiave API non valida |
Per ottenere informazioni di base sulla cronologia dell'utente, devi fare una chiamata GET al seguente url:
https://mvsep.com/api/app/separation_history
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | String | Chiave API dell'utente |
| start | Integer | (facoltativo) Punto di inizio offset, predefiniti a 0 (i.e. comincia dall'ultimo) |
| limit | Integer | (facoltativo) Massima quantità di dettagli restituita, predefiniti a 10, il massimo è 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Il tuo Token API>&start=1&limit=2'
| Chiave | Valore |
|---|---|
| success |
|
| data | Contiene array di informazione di base sulle precedenti operazioni |
| data -> hash | Hash della separazione |
| data -> job_exists | Contiene array di informazione di base sulle precedenti operazioni |
| data -> credits | Quando crediti utilizzati per il processo, è nullo se la separazione non esiste |
| data -> time_left | Tempo approssimativo rimanente prima che il processo sia cancellato |
| data -> algorithm | Contieni informazioni base sul tipo di separazione utilizzata (si riferisce al tab "OTTIENI TIPI DI SEPARAZIONE" per informazioni sui parametri restituiti) |
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Chiave API non valida |
Per abilitare l'uso premium per l'utente, devi fare una chiamata POST al seguente url:
https://mvsep.com/api/app/enable_premium
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | String | Chiave API dell'utente |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Il tuo Token API>"'
| Chiave | Valore |
|---|---|
| success |
|
| message | Informa sullo stato dell'operazione |
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Chiave API non valida |
Per disabilitare l'uso premium per l'utente, devi fare una chiamata POST al seguente url:
https://mvsep.com/api/app/disable_premium
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | String | Chiave API dell'utente |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Il tuo Token API>"'
| Chiave | Valore |
|---|---|
| success |
|
| message | Informa sullo stato dell'operazione |
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Chiave API non valida |
Per abilitare lunghi filenames per l'utente, devi fare una chiamata POST al seguente url:
https://mvsep.com/api/app/enable_long_filenames
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | String | Chiave API dell'utente |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Il tuo Token API>"'
| Chiave | Valore |
|---|---|
| success |
|
| message | Informa sullo stato dell'operazione |
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Chiave API non valida |
Per disabilitare lunghi filenames per l'utente, devi fare una chiamata POST al seguente url:
https://mvsep.com/api/app/disable_long_filenames
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | String | Chiave API dell'utente |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Il tuo Token API>"'
| Chiave | Valore |
|---|---|
| success |
|
| message | Informa sullo stato dell'operazione |
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Chiave API non valida |
To get information about Quality Checker queue entries, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/queue
| Campo | Tipo | Descrizione |
|---|---|---|
| start | Integer | (facoltativo) Punto di inizio offset, predefiniti a 0 (i.e. comincia dall'ultimo) |
| limit | Integer | (facoltativo) Massima quantità di dettagli restituita, predefiniti a 10, il massimo è 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Restituisce i dati come un array (vettore):
| Chiave | Valore |
|---|---|
| id | Identification number of entry |
| dataset_type | Dataset Type chosen when adding the entry / Leaderboard type
|
| date | Created date of the entry |
| algo_name | Name of the used separation type/algorithm |
| main_text | Description of the used separation type/algorithm |
| proc | Status of the processing
|
| proc_remote_date | Timestamp of processing date |
| msg | Returns "OK" if successful, otherwise shows error message |
| metrics | Information about entry metrics |
| sdr_* (wildcard) | SDR of the corresponding stems |
| dataset_name | Name of the dataset |
To get information about Quality Checker leaderboards, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/leaderboard
| Campo | Tipo | Descrizione |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (facoltativo) Punto di inizio offset, predefiniti a 0 (i.e. comincia dall'ultimo) |
| limit | Integer | (facoltativo) Massima quantità di dettagli restituita, predefiniti a 10, il massimo è 20. |
| algo_name_filter | String | Filters Separation Type/Algorithm names by given text |
| sort | String | Sort by given SDR of the stem. You can get list of sortable values for given dataset type from sortables key in response |
curl --location --request GET 'https://mvsep.com/api/quality_checker/leaderboard?&start=1&limit=2&algo_name_filter=MVSep'
| Chiave | Valore |
|---|---|
| data | Contains array of Quality Checker entries. Refer to GET QUEUE response from Quality Checker Section for more information |
| dataset_type | Used dataset type key |
| sortables | Keys that can be used to sort used dataset type by given stem in sequential order. |
| sort | Used sorting key from sortable. |
To create Quality Checker entry, you need to make a POST call to the following url:
https://mvsep.com/api/quality_checker/add
| Campo | Tipo | Descrizione |
|---|---|---|
| api_token | String | (required) La tua chiave API |
| 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 | Dataset type. Defaults to 0.
|
| password | String | (required) Password to delete algorithm |
| ensemble | integer | 0 - algorithm is not ensemble. 1 - algorithm is ensemble. |
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"'
| Chiave | Valore |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
L'API MVSEP utilizza i seguenti codici di errore:
| Codice di errore | Significato |
|---|---|
| 400 | Modulo invalido |
| 401 |
api_token sconosciuto o non valido. Questo errore appare se si utilizza una chiave API sconosciuta
|
To get information about Quality Checker queue entry by id, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/entry
| Campo | Tipo | Descrizione |
|---|---|---|
| id | Integer | (required) ID of the entry |
curl --location --request GET 'https://mvsep.com/api/quality_checker/entry?id=7675'
To delete Quality Checker queue entry by id and password, you need to make a GET call to the following url:
https://mvsep.com/api/quality_checker/delete
| Campo | Tipo | Descrizione |
|---|---|---|
| id | Integer | (required) ID of the entry |
| password | String | (required) Used password for the entry |
curl --location 'https://mvsep.com/api/quality_checker/delete' --form 'id="7720"' --form 'password="test"'
| Chiave | Valore |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com