turbo@mvsep.com
L’API MVSEP FOURNIT UN ACCÈS PROGRAMMATIQUE POUR CRÉER UNE SÉPARATION, RENVOYER LES RÉSULTATS, OBTENIR DES INFORMATIONS SUR LE SITE ET CONTRÔLER LES CAPACITÉS DE L’UTILISATEUR.
Pour utiliser cette API vous avez besoin d'une clé d'API. Vous n’êtes pas connecté, veuillez vous connecter pour obtenir votre jeton 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
Notez que les utilisateurs Premium peuvent demander jusqu'à 10 tâches simultanées, tandis que les utilisateurs non Premium ne peuvent demander que 1 tâche simultanée.
Pour créer une séparation vous devez effectuer un appel POST à l'URL suivante :
https://mvsep.com/api/separation/create
| Champ | Type | Description |
|---|---|---|
| api_token | String | Votre clé API |
| audiofile | Binary | Fichier audio à traiter. 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 | (facultatif) Type de séparation, par défaut 11 (Demucs3 modèle B (chant, batterie, basse, autre)) |
| add_opt1 | String | (facultatif) Type de séparation, champ supplémentaire 1 |
| add_opt2 | String | (facultatif) Type de séparation, champ supplémentaire 2 |
| add_opt3 | String | (facultatif) Troisième champ supplémentaire de type de séparation |
| output_format | Integer | (facultatif) format de sortie, 0 par défaut (mp3 (320 kbps)) |
| is_demo | Boolean | (facultatif) si la séparation result devrait être publié sur la page de démonstration, false par défaut |
| Nom | Valeur | 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 |
| Nom | Valeur |
|---|---|
| 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="<Votre jeton API>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Clé | Valeur |
|---|---|
| success |
|
| data | Contient des informations supplémentaires en fonction de la clé success |
| data -> link | Affiche le lien vers l’URL « GET RESULT » de la tâche créée (affiché uniquement lorsque success est true) |
| data -> hash | Affiche le hachage de la tâche créée (affiché uniquement lorsque success est true) |
| data -> message | Affiche la description d’une erreur (uniquement lorsque success est false) |
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Certains paramètres sont manquants ou invalides. Cette erreur apparaît lorsqu'on ne transmette pas tous les paramètres obligatoires ou lorsqu'on transmette des paramètres non valides. |
| 401 |
api_token est inconnu ou non valide. Cette erreur se produit si l'on utilise une clé API inconnue
|
Pour obtenir le résultat de la séparation, vous devez effectuer un appel GET à l'url suivante :
https://mvsep.com/api/separation/get
| Champ | Type | Description |
|---|---|---|
| hash | String | Ыomme de hachage de séparation |
| mirror | Integer | (facultatif) Utilise un autre miroir s'il est défini sur 1, la valeur par défaut est 0. Nécessite api_token et 1 crédit s'il est défini sur 1. |
| api_token | string | (facultatif) Clé API de l'utilisateur. Obligatoire si le paramètre miroir est défini sur 1. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Clé | Valeur |
|---|---|
| success |
|
| status |
|
| data | Contient des informations supplémentaires en fonction de la touche status |
| data -> queue_count | Affiche le nombre de tâches non traitées dans la priorité de l'utilisateur (affiché uniquement lorsque le statut est en attente ou en cours de distribution) |
| data -> current_order | Affiche l'ordre des tâches de l'utilisateur (affiché uniquement lorsque le statut est en attente ou en cours de distribution) |
| data -> message | Affiche la description de l'état (affiché sur tous les états, affiche la raison de l'erreur à la place lorsque l'état est échoué) |
| data -> algorithm | Affiche l’algorithme utilisé sur le travail (affiché uniquement lorsque status est done) |
| data -> algorithm_description | Affiche les détails de l’algorithme utilisé sur le travail (uniquement lorsque status est done) |
| data -> output_format | Affiche le format de sortie de la tâche (affiché uniquement lorsque status est done) |
| data -> tags | Affiche les balises méta audio (uniquement affichées lorsque status est done) |
| data -> input_file | Affiche les détails du téléchargement de l’audio d’entrée (uniquement lorsque status est done) |
| data -> files | Affiche les détails de téléchargement des audios de sortie (uniquement lorsque status est done) |
| data -> date | Affiche la date de traitement de la tâche (affichée uniquement lorsque status est done) |
| data -> finished_chunks | Affiche le nombre de pièces terminées d’un travail volumineux (uniquement lorsque status est distributing) |
| data -> all_chunks | Affiche le nombre de toutes les parties d’une tâche volumineuse (uniquement lorsque status est 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
| Champ | Type | Description |
|---|---|---|
| hash | String | Ыomme de hachage de séparation |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Clé | Valeur |
|---|---|
| success |
|
| status |
|
| data | Contient des informations supplémentaires en fonction de la touche 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
| Champ | Type | Description |
|---|---|---|
| api_token | string | Clé API de l'utilisateur |
| hash | string | Ыomme de hachage de séparation |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Votre jeton API>"' --form 'hash="<hash>"'
| Clé | Valeur |
|---|---|
| success |
|
Pour obtenir les données détaillées sur les types de séparation, vous devez effectuer un appel GET à l’URL suivante :
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Renvoie les données sous forme de tableau:
| Clé | Valeur |
|---|---|
| render_id | Valeur du type de séparation (ID) |
| name | Le nom du type de séparation |
| algorithm_group_id |
Le groupe auquel appartient le type de séparation :
|
| orientation |
À qui s'adresse ce type de séparation :
|
| order_id | L'ordre du type de séparation |
| price_coefficient |
Utilisé pour calculer combien de crédits le travail prend à l'utilisateur premium. Utilise cette formule : floor(<durée du fichier audio en secondes> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | Contient des informations sur les champs supplémentaires du type de séparation |
| algorithm_fields -> name |
Affiche le champ supplémentaire du type de séparation :
|
| algorithm_fields -> text | Nom d'affichage du champ supplémentaire du type de séparation. |
| algorithm_fields -> options | Chaînes clé-valeur codées JSON de champs supplémentaires |
| algorithm_fields -> default_key | Valeur par défaut du champ supplémentaire. Une des clés de <code>algorithm_fields -> options</code> |
| algorithm_descriptions | Contient des informations sur les descriptions du type de séparation |
| algorithm_descriptions -> short_description | Petite description du type de séparation qui n'utilise pas HTML. |
| algorithm_descriptions -> long_description | Description détaillée du type de séparation qui utilise HTML. |
| algorithm_descriptions -> lang | Code de langue spécifié de la description. |
Pour obtenir des informations sur les dernières nouvelles concernant MVSEP, vous devez effectuer un appel GET à l’URL suivante :
https://mvsep.com/api/app/news
| Champ | Type | Description |
|---|---|---|
| lang | String | (facultatif) Code de langue à 2 lettres (en, ru) |
| start | Integer | (facultatif) Décalage du point de départ, par défaut 0 (c'est-à-dire démarrer à partir du plus récent) |
| limit | Integer | (facultatif) Quantité maximale de résultats renvoyés, la valeur par défaut est 10, le maximum est 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Renvoie les données sous forme de tableau:
| Clé | Valeur |
|---|---|
| title | Titre de la nouvelle |
| lang | Titre de la nouvelle |
| text | Description complète de l'actualité |
| created_at | Date de la nouvelle |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Champ | Type | Description |
|---|---|---|
| api_token | String | (optional) Clé API de l'utilisateur |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Clé | Valeur |
|---|---|
| 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):
|
Pour obtenir des informations sur les séparations de démonstration, vous devez effectuer un appel GET à l'URL suivante :
https://mvsep.com/api/app/demo
| Champ | Type | Description |
|---|---|---|
| start | Integer | (facultatif) Décalage du point de départ, par défaut 0 (c'est-à-dire démarrer à partir du plus récent) |
| limit | Integer | (facultatif) Quantité maximale de résultats renvoyés, la valeur par défaut est 10, le maximum est 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Renvoie les données sous forme de tableau:
| Clé | Valeur |
|---|---|
| hash | Ыomme de hachage de séparation |
| date | Date de séparation |
| input_audio | URL d'entrée audio |
| size | Taille audio d'entrée |
| algorithm | Contient des informations de base sur le type de séparation utilisé (reportez-vous à l'onglet OBTENIR LES TYPES DE SÉPARATION pour plus d'informations sur les paramètres renvoyés) |
Pour authentifier l'utilisateur et obtenir sa clé API, vous devez effectuer un appel POST à l'URL suivante :
https://mvsep.com/api/app/login
| Champ | Type | Description |
|---|---|---|
| String | Email de l'utilisateur | |
| password | String | Mot de passe de l'utilisateur |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Email de l'utilisateur>"' --form 'password="<Mot de passe de l'utilisateur>"'
| Clé | Valeur |
|---|---|
| success |
|
| data | Contient des informations lorsque les informations d'identification sont valides |
| data -> name | Nom de l'utilisateur |
| data -> email | Email de l'utilisateur |
| data -> api_token | La clé API de l'utilisateur. Assurez-vous de la stocker dans un espace de stockage sécurisé et de l'utiliser pour les opérations ultérieures. |
| data -> premium_minutes | Crédits laissés à l'utilisateur |
| data -> premium_enabled |
Si l'utilisateur a autorisé la dépense de crédits.
|
| data -> long_filenames_enabled |
Si l'utilisateur souhaite des informations supplémentaires dans les noms de fichiers :
|
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Informations d'identification incorrectes spécifiées |
Pour inscrire l’utilisateur sur le site MVSEP, vous devez effectuer un appel POST à l’url suivante :
https://mvsep.com/api/app/register
| Champ | Type | Description |
|---|---|---|
| name | String | Nom de l'utilisateur |
| String | Email de l'utilisateur | |
| password | String | Mot de passe de l'utilisateur |
| password_confirmation | String | Répéter le mot de passe de l'utilisateur |
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"'
| Clé | Valeur |
|---|---|
| success |
|
| message | Se produit lorsque le formulaire n'est pas valide |
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Le formulaire n'est pas valide |
Pour obtenir des informations sur l'utilisateur, vous devez effectuer un appel GET à l'URL suivante :
https://mvsep.com/api/app/user
| Champ | Type | Description |
|---|---|---|
| api_token | String | Clé API de l'utilisateur |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Votre jeton API>'
| Clé | Valeur |
|---|---|
| success |
|
| data | Contient des informations lorsque les informations d'identification sont valides |
| data -> name | Nom de l'utilisateur |
| data -> email | Email de l'utilisateur |
| data -> api_token | La clé API de l'utilisateur. Assurez-vous de la stocker dans un espace de stockage sécurisé et de l'utiliser pour les opérations ultérieures. |
| data -> premium_minutes | Crédits laissés à l'utilisateur |
| data -> premium_enabled |
Si l'utilisateur a autorisé la dépense de crédits.
|
| data -> long_filenames_enabled |
Si l'utilisateur souhaite des informations supplémentaires dans les noms de fichiers :
|
| data -> current_queue | Affiche les séparations en cours pour l'utilisateur |
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Clé API non valide |
Pour obtenir des informations de base sur l'historique de séparation de l'utilisateur, vous devez effectuer un appel GET à l'URL suivante :
https://mvsep.com/api/app/separation_history
| Champ | Type | Description |
|---|---|---|
| api_token | String | Clé API de l'utilisateur |
| start | Integer | (facultatif) Décalage du point de départ, par défaut 0 (c'est-à-dire démarrer à partir du plus récent) |
| limit | Integer | (facultatif) Quantité maximale de résultats renvoyés, la valeur par défaut est 10, le maximum est 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Votre jeton API>&start=1&limit=2'
| Clé | Valeur |
|---|---|
| success |
|
| data | Contient un tableau d'informations de base sur les séparations précédentes |
| data -> hash | Ыomme de hachage de séparation |
| data -> job_exists | Contient un tableau d'informations de base sur les séparations précédentes |
| data -> credits | Combien de crédits ont été utilisés pour le travail, nul si la séparation n'existe pas |
| data -> time_left | Temps approximatif restant avant la suppression du travail |
| data -> algorithm | Contient des informations de base sur le type de séparation utilisé (reportez-vous à l'onglet OBTENIR LES TYPES DE SÉPARATION pour plus d'informations sur les paramètres renvoyés) |
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Clé API non valide |
Pour activer l'utilisation premium pour l'utilisateur, vous devez effectuer un appel POST vers l'URL suivante :
https://mvsep.com/api/app/enable_premium
| Champ | Type | Description |
|---|---|---|
| api_token | String | Clé API de l'utilisateur |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Votre jeton API>"'
| Clé | Valeur |
|---|---|
| success |
|
| message | Informe sur l'état de l'opération |
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Clé API non valide |
Pour désactiver l'utilisation premium pour l'utilisateur, vous devez effectuer un appel POST vers l'URL suivante :
https://mvsep.com/api/app/disable_premium
| Champ | Type | Description |
|---|---|---|
| api_token | String | Clé API de l'utilisateur |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Votre jeton API>"'
| Clé | Valeur |
|---|---|
| success |
|
| message | Informe sur l'état de l'opération |
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Clé API non valide |
Pour activer les noms de fichiers longs pour l'utilisateur, vous devez effectuer un appel POST vers l'URL suivante :
https://mvsep.com/api/app/enable_long_filenames
| Champ | Type | Description |
|---|---|---|
| api_token | String | Clé API de l'utilisateur |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Votre jeton API>"'
| Clé | Valeur |
|---|---|
| success |
|
| message | Informe sur l'état de l'opération |
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Clé API non valide |
Pour désactiver les noms de fichiers longs pour l'utilisateur, vous devez effectuer un appel POST vers l'URL suivante :
https://mvsep.com/api/app/disable_long_filenames
| Champ | Type | Description |
|---|---|---|
| api_token | String | Clé API de l'utilisateur |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Votre jeton API>"'
| Clé | Valeur |
|---|---|
| success |
|
| message | Informe sur l'état de l'opération |
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Clé API non valide |
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
| Champ | Type | Description |
|---|---|---|
| start | Integer | (facultatif) Décalage du point de départ, par défaut 0 (c'est-à-dire démarrer à partir du plus récent) |
| limit | Integer | (facultatif) Quantité maximale de résultats renvoyés, la valeur par défaut est 10, le maximum est 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Renvoie les données sous forme de tableau:
| Clé | Valeur |
|---|---|
| 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
| Champ | Type | Description |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (facultatif) Décalage du point de départ, par défaut 0 (c'est-à-dire démarrer à partir du plus récent) |
| limit | Integer | (facultatif) Quantité maximale de résultats renvoyés, la valeur par défaut est 10, le maximum est 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'
| Clé | Valeur |
|---|---|
| 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
| Champ | Type | Description |
|---|---|---|
| api_token | String | (required) Votre clé 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"'
| Clé | Valeur |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
MVSEP API utilise les codes d'erreur suivants :
| Code d'erreur | Signification |
|---|---|
| 400 | Le formulaire n'est pas valide |
| 401 |
api_token est inconnu ou non valide. Cette erreur se produit si l'on utilise une clé API inconnue
|
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
| Champ | Type | Description |
|---|---|---|
| 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
| Champ | Type | Description |
|---|---|---|
| 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"'
| Clé | Valeur |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com