turbo@mvsep.com
La API de MVSEP proporciona acceso programático para crear una separación, devolver los resultados, obtener información del sitio y controlar las capacidades del usuario.
Para utilizar esta API, necesita una clave API. No ha iniciado sesión, inicie sesión para obtener su clave API <code>(api_token)<code>.
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
OpenAPI Specification: mvsep-openapi-spec.json
Note that Premium users can request unlimited concurrent jobs, while non-Premium users can only request 1 concurrent job.
Para crear la separación es necesario hacer una petición POST a la siguiente URL:
https://mvsep.com/api/separation/create
| Campo | Tipo | Descripción |
|---|---|---|
| api_token | String | Tu clave API |
| audiofile | Binary | Archivo de audio a procesar. Not required if url parameter is set or model do not use file input. For matchering models use target_audiofile and reference_audiofile for input instead of audiofile. |
| 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 | (opcional) Tipo de separación, por defecto 11 [Demucs3 Modelo B (voz, batería, bajo, otros)] |
| add_opt1 | String | (opcional) Tipo de separación, primer campo adicional |
| add_opt2 | String | (opcional) Tipo de separación, segundo campo adicional |
| add_opt3 | String | (opcional) Tipo de Separación, tercer campo adicional |
| output_format | Integer | (opcional) Formato de salida, por defecto 0 [mp3 (320kbps)] |
| is_demo | Boolean | (opcional) Si la separación debe publicarse en la página de demostración. Por defecto es <code>false<code> |
| Formato | Valor | 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 | |
| Demucs4 HT (vocals, drums, bass, other) | 20 | Key: add_opt1 Name: Model type Options:
|
| 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:
|
| 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 | |
| MVSep 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 Crowd removal (crowd, other) | 34 | 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:
|
| MVSep Choir (choir, other) | 112 | Key: add_opt2 Name: How to extract Options:
|
| MVSep SATB Choir (soprano, alto, tenor, bass) | 111 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract 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 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 Synth (synth, other) | 88 | Key: add_opt1 Name: How to extract 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:
|
| MVSep Piano (piano, other) | 29 | Key: add_opt1 Name: Piano model type Options:
|
| MVSep Digital Piano (digital-piano, other) | 79 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Keys (keys, other) | 106 | |
| MVSep Organ (organ, other) | 58 | Key: add_opt1 Name: Organ model type Options:
|
| MVSep Harpsichord (harpsichord, other) | 91 | |
| MVSep Accordion (accordion, other) | 99 | |
| MVSep Guitar (guitar, other) | 31 | Key: add_opt1 Name: Guitar model type Options:
|
| MVSep Acoustic Guitar (acoustic-guitar, other) | 66 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Electric Guitar (electric-guitar, other) | 81 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Lead/Rhythm Guitar (lead-guitar, rhythm-guitar) | 101 | Key: add_opt1 Name: Model type Options:
|
| MVSep Plucked Strings (plucked-strings, other) | 102 | |
| MVSep Harp (harp, other) | 72 | |
| MVSep Mandolin (mandolin, other) | 74 | |
| MVSep Banjo (banjo, other) | 83 | |
| MVSep Sitar (sitar, other) | 90 | |
| MVSep Ukulele (ukulele, other) | 96 | |
| MVSep Dobro (dobro, other) | 97 | |
| MVSep Bowed Strings (strings, other) | 52 | Key: add_opt1 Name: String model type Options:
Key: add_opt2 Name: How to extract Options:
|
| MVSep Violin (violin, other) | 65 | |
| MVSep Viola (viola, other) | 69 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Cello (cello, other) | 70 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Double Bass (double-bass, other) | 73 | Key: add_opt2 Name: How to extract Options:
|
| 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 Brass (brass, other) | 107 | Key: add_opt1 Name: How to extract Options:
|
| MVSep Woodwind (woodwind, other) | 108 | Key: add_opt1 Name: How to extract Options:
|
| MVSep Saxophone (saxophone, other) | 61 | Key: add_opt1 Name: Model type Options:
|
| MVSep Flute (flute, other) | 67 | Key: add_opt1 Name: Flute model type Options:
Key: add_opt2 Name: How to extract Options:
|
| MVSep Trumpet (trumpet, other) | 71 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Trombone (trombone, other) | 75 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Oboe (oboe, other) | 77 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Clarinet (clarinet, other) | 78 | Key: add_opt2 Name: How to extract Options:
|
| MVSep French Horn (french-horn, other) | 82 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Harmonica (harmonica, other) | 87 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Tuba (tuba, other) | 92 | |
| MVSep Bassoon (bassoon, other) | 93 | |
| MVSep Bagpipes (bagpipes , other) | 116 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Percussion (percussion, other) | 105 | |
| MVSep Tambourine (tambourine, other) | 76 | |
| MVSep Marimba (marimba, other) | 84 | |
| MVSep Glockenspiel (glockenspiel, other) | 85 | |
| MVSep Timpani (timpani, other) | 86 | |
| MVSep Triangle (triangle, other) | 89 | |
| MVSep Congas (congas , other) | 94 | |
| MVSep Bells (bells, other) | 95 | |
| MVSep Wind Chimes (wind-chimes, other) | 98 | |
| MVSep Xylophone (xylophone, other) | 109 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Celesta (celesta, other) | 110 | Key: add_opt2 Name: How to extract Options:
|
| MVSep Demucs4HT DNR (speech, music, effects) | 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, effects) | 56 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: How to extract Options:
Key: add_opt3 Name: Output files Options:
|
| MVSep Braam (braam , other) | 117 | |
| Apollo Enhancers (by JusperLee, Lew, baicai1145) | 51 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Cutoff (Hz) Options:
|
| Reverb Removal (noreverb) | 22 | Key: add_opt1 Name: Model Type Options:
Key: add_opt2 Name: Preprocess Options:
|
| DeNoise by aufr33 | 47 | Key: add_opt1 Name: Model type Options:
|
| AudioSR (Super Resolution) | 59 | Key: add_opt1 Name: Cutoff (Hz) Options:
|
| FlashSR (Super Resolution) | 60 | |
| Stable Audio Open Gen | 62 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Length (in seconds) 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:
Key: add_opt2 Name: Version Options:
|
| VibeVoice (Voice Cloning) | 103 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Text prompt Options: Key: add_opt3 Name: Extract vocals first Options:
|
| VibeVoice (TTS) | 104 | Key: add_opt1 Name: Model type Options:
Key: add_opt2 Name: Text prompt Options: |
| Qwen3-TTS (Custom Voice) | 118 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Speaker Options:
Key: add_opt3 Name: Language Options:
Key: add_opt4 Name: Voice description Options: |
| Qwen3-TTS (Voice Design) | 119 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Voice description Options: Key: add_opt3 Name: Language Options:
|
| Qwen3-TTS (Voice Cloning) | 120 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Reference text in audio (optional) Options: Key: add_opt3 Name: Language Options:
Key: add_opt4 Name: Extract vocals first Options:
|
| Bark (Speech Gen) | 115 | Key: add_opt1 Name: Text prompt Options: Key: add_opt2 Name: Speaker Options:
|
| MVSep MultiSpeaker (MDX23C) | 42 | Key: add_opt1 Name: Model Type Options:
|
| Aspiration (by Sucial) | 50 | Key: add_opt1 Name: Model type Options:
|
| Phantom Centre extraction (by wesleyr36) | 55 | |
| Matchering (by sergree) | 68 | |
| SOME (Singing-Oriented MIDI Extractor) | 80 | Key: add_opt1 Name: How to use Options:
|
| Transkun (piano -> midi) | 113 | Key: add_opt1 Name: How to extract Options:
|
| Basic Pitch (MIDI Extraction) | 114 | |
| Demucs3 Model (vocals, drums, bass, other) | 10 | Key: add_opt1 Name: Model type Options:
|
| MDX A/B (vocals, drums, bass, other) | 7 | Key: add_opt1 Name: Vocal 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 Old 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:
|
| Formato | Valor |
|---|---|
| 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="<Su token API>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Clave | Valor |
|---|---|
| success |
|
| data | Contiene información adicional dependiendo de la clave success |
| data -> link | Muestra el enlace a la URL "OBTENER RESULTADO" del trabajo creado (solo se muestra cuando success es true) |
| data -> hash | Muestra el hash del trabajo creado (solo se muestra cuando success es true) |
| data -> message | Muestra la descripción de un error (solo se muestra cuando success es false) |
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Parámetros faltantes o inválidos. Este error aparece cuando no se pasan todos los parámetros obligatorios o se pasan parámetros no válidos. |
| 401 |
api_token desconocido o inválido. Este error aparece si utiliza una clave API desconocida
|
Para obtener el resultado de la separación, debe realizar una petición GET a la siguiente URL:
https://mvsep.com/api/separation/get
| Campo | Tipo | Descripción |
|---|---|---|
| hash | String | Hash de separación |
| mirror | Integer | (opcional) Utiliza otra ventana si se establece en 1, el valor predeterminado es 0. Requiere <code>api_token<code> y 1 crédito si se establece en 1. |
| api_token | string | (opcional) Clave API del usuario. Requerido si el parámetro <code>ventana<code> está establecido en 1. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Clave | Valor |
|---|---|
| success |
|
| status |
|
| data | Contiene información adicional, dependiendo de la clave de estado |
| data -> queue_count | Muestra el recuento de trabajos sin procesar de acuerdo a la prioridad del usuario (solo se muestra cuando el estado está en waiting o en distributing) |
| data -> current_order | Muestra el orden del trabajo del usuario (solo se muestra cuando el estado está en waiting o en distributing) |
| data -> message | Muestra la descripción del estado (se muestra en todos los estados, muestra el motivo del error cuando el estado es failed) |
| data -> algorithm | Muestra el algoritmo utilizado en el trabajo (solo se muestra cuando el estado es done) |
| data -> algorithm_description | Muestra los detalles del algoritmo utilizado en el trabajo (solo se muestra cuando el estado es done) |
| data -> output_format | Muestra el formato de salida del trabajo (solo se muestra cuando el estado está terminado) |
| data -> tags | Muestra las etiquetas de metadatos de audio (solo se muestra cuando el estado está terminado) |
| data -> input_file | Muestra los detalles de descarga de audio de entrada (solo se muestra cuando el estado está terminado) |
| data -> files | Muestra los detalles de descarga de los audios de salida (solo se muestra cuando el estado está terminado) |
| data -> date | Muestra la fecha de procesamiento del trabajo (solo se muestra cuando el estado está terminado) |
| data -> finished_chunks | Muestra el número de piezas terminadas de un trabajo grande (solo se muestra cuando el estado está en distribución) |
| data -> all_chunks | Muestra el número de todas las partes de un trabajo grande (solo se muestra cuando el estado está en distribución) |
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 | Descripción |
|---|---|---|
| hash | String | Hash de separación |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Clave | Valor |
|---|---|
| success |
|
| status |
|
| data | Contiene información adicional, dependiendo de la clave de estado |
| 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 | Descripción |
|---|---|---|
| api_token | string | Clave API del usuario |
| hash | string | Hash de separación |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Su token API>"' --form 'hash="<hash>"'
| Clave | Valor |
|---|---|
| success |
|
Para obtener datos detallados sobre los tipos de separación, debe realizar una petición GET a la siguiente URL:
https://mvsep.com/api/app/algorithms
| Campo | Tipo | Descripción |
|---|---|---|
| scopes | String | Whether to include models that use different form of input.
single_upload if not provided. To get all models, set scopes=single_upload,no_upload,matchering_upload
|
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Devuelve los datos como un arreglo (matriz):
| Clave | Valor |
|---|---|
| render_id | Valor del tipo de separación (ID) |
| name | El nombre del tipo de separación |
| algorithm_group_id | El grupo al que pertenece el tipo de separación: |
| algorithm_group | Contains information about the algorithm group that the algorithm belongs to. |
| algorithm_group -> name | Name of the algorithm group. |
| audio_widget |
The type of audio widget to use for the algorithm. This can be used to determine how to display the audio player for the algorithm on the frontend. Possible values are:
|
| orientation |
Qué usuarios pueden disponer de este tipo de separación:
|
| order_id | El orden del tipo de separación |
| price_coefficient |
Se utiliza para calcular cuántos créditos consume el trabajo al usuario premium. Usa esta formula : floor(<duración del archivo de audio en segundos> * 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 información sobre campos adicionales del tipo de separación |
| algorithm_fields -> name |
Muestra cuál campo adicional del tipo de separación:
|
| algorithm_fields -> text | Nombre con el que se muestra el campo adicional del tipo de separación. |
| algorithm_fields -> options | Cadenas clave-valor codificadas en JSON del campo adicional |
| algorithm_fields -> default_key | Valor predeterminado del campo adicional. Una de las claves de <code>campos_algoritmo -> opciones<code> |
| algorithm_descriptions | Contiene información sobre descripciones del tipo de separación. |
| algorithm_descriptions -> short_description | Pequeña descripción del tipo de separación que no utiliza HTML. |
| algorithm_descriptions -> long_description | Descripción detallada del tipo de separación que utiliza HTML. |
| algorithm_descriptions -> lang | Código específico de idioma, de la descripción. |
Para obtener información sobre las últimas noticias sobre MVSEP, debe realizar una petición GET a la siguiente URL:
https://mvsep.com/api/app/news
| Campo | Tipo | Descripción |
|---|---|---|
| lang | String | (opcional) Código de 2 letras del idioma(en, es) |
| start | Integer | (opcional) Desplazamiento desde el punto inicial, el valor predeterminado es 0 (es decir, se comienza por el último) |
| limit | Integer | (opcional) Cantidad máxima de resultados devueltos, el valor predeterminado es 10, el máximo es 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Devuelve los datos como un arreglo (matriz):
| Clave | Valor |
|---|---|
| title | Título de las noticias |
| lang | Título de las noticias |
| text | Descripción completa de las noticias |
| created_at | Fecha de las noticias |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Campo | Tipo | Descripción |
|---|---|---|
| api_token | String | (optional) Clave API del usuario |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Clave | Valor |
|---|---|
| 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):
|
Para obtener información sobre las separaciones de la página de demostración, debe realizar una petición GET a la siguiente URL:
https://mvsep.com/api/app/demo
| Campo | Tipo | Descripción |
|---|---|---|
| start | Integer | (opcional) Desplazamiento desde el punto inicial, el valor predeterminado es 0 (es decir, se comienza por el último) |
| limit | Integer | (opcional) Cantidad máxima de resultados devueltos, el valor predeterminado es 10, el máximo es 20. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Devuelve los datos como un arreglo (matriz):
| Clave | Valor |
|---|---|
| hash | Hash de separación |
| date | Fecha de la separación |
| input_audio | URL del audio de entrada |
| size | Tamaño del audio de entrada |
| algorithm | Contiene información básica sobre el tipo de separación utilizado (consulte la pestaña OBTENER TIPOS DE SEPARACIÓN para obtener información sobre los parámetros devueltos) |
Para autenticar al usuario y obtener su clave API, debe realizar una petición POST a la siguiente URL:
https://mvsep.com/api/app/login
| Campo | Tipo | Descripción |
|---|---|---|
| String | Correo electrónico del usuario | |
| password | String | Contraseña del usuario |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<Correo electrónico del usuario>"' --form 'password="<Contraseña del usuario>"'
| Clave | Valor |
|---|---|
| success |
|
| data | Contiene información cuando las credenciales son válidas. |
| data -> name | Nombre del usuario |
| data -> email | Correo electrónico del usuario |
| data -> api_token | La clave API del usuario. Asegúrese de guardarlo en un lugar seguro y utilizarlo para operaciones posteriores. |
| data -> premium_minutes | Créditos restantes del usuario |
| data -> premium_enabled |
Si el usuario permitió gastar créditos.
|
| data -> long_filenames_enabled |
Si el usuario desea información adicional en los nombres de los archivos:
|
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Se especificaron credenciales incorrectas |
Para registrar un usuario en el sitio MVSEP, debe realizar una petición POST a la siguiente URL:
https://mvsep.com/api/app/register
| Campo | Tipo | Descripción |
|---|---|---|
| name | String | Nombre del usuario |
| String | Correo electrónico del usuario | |
| password | String | Contraseña del usuario |
| password_confirmation | String | Repetir la contraseña del usuario |
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"'
| Clave | Valor |
|---|---|
| success |
|
| message | Ocurre cuando el formulario es válido. |
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Formulario no válido |
Para obtener información del usuario, debe realizar una petición GET a la siguiente URL:
https://mvsep.com/api/app/user
| Campo | Tipo | Descripción |
|---|---|---|
| api_token | String | Clave API del usuario |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Su token API>'
| Clave | Valor |
|---|---|
| success |
|
| data | Contiene información cuando las credenciales son válidas. |
| data -> name | Nombre del usuario |
| data -> email | Correo electrónico del usuario |
| data -> api_token | La clave API del usuario. Asegúrese de guardarlo en un lugar seguro y utilizarlo para operaciones posteriores. |
| data -> premium_minutes | Créditos restantes del usuario |
| data -> premium_enabled |
Si el usuario permitió gastar créditos.
|
| data -> long_filenames_enabled |
Si el usuario desea información adicional en los nombres de los archivos:
|
| data -> current_queue | Muestra separaciones en curso del usuario. |
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Clave API no válida |
Para obtener información básica del historial de separación del usuario, debe realizar una llamada GET a la siguiente URL:
https://mvsep.com/api/app/separation_history
| Campo | Tipo | Descripción |
|---|---|---|
| api_token | String | Clave API del usuario |
| start | Integer | (opcional) Desplazamiento desde el punto inicial, el valor predeterminado es 0 (es decir, se comienza por el último) |
| limit | Integer | (opcional) Cantidad máxima de resultados devueltos, el valor predeterminado es 10, el máximo es 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Su token API>&start=1&limit=2'
| Clave | Valor |
|---|---|
| success |
|
| data | Contiene una matriz de información básica sobre separaciones anteriores. |
| data -> hash | Hash de separación |
| data -> job_exists | Contiene una matriz de información básica sobre separaciones anteriores. |
| data -> credits | Cuántos créditos se consumierom para el trabajo, nulo si no existe separación |
| data -> time_left | Tiempo aproximado restante hasta que se elimine el trabajo |
| data -> algorithm | Contiene información básica sobre el tipo de separación utilizado (consulte la pestaña OBTENER TIPOS DE SEPARACIÓN para obtener información sobre los parámetros devueltos) |
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Clave API no válida |
Para habilitar el uso premium para el usuario, debe realizar una petición POST a la siguiente URL:
https://mvsep.com/api/app/enable_premium
| Campo | Tipo | Descripción |
|---|---|---|
| api_token | String | Clave API del usuario |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Su token API>"'
| Clave | Valor |
|---|---|
| success |
|
| message | Informa sobre el estado de la operación |
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Clave API no válida |
Para deshabilitar el uso premium para el usuario, debe realizar una petición POST a la siguiente URL:
https://mvsep.com/api/app/disable_premium
| Campo | Tipo | Descripción |
|---|---|---|
| api_token | String | Clave API del usuario |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Su token API>"'
| Clave | Valor |
|---|---|
| success |
|
| message | Informa sobre el estado de la operación |
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Clave API no válida |
Para habilitar los nombres extensos de archivos para el usuario, debe realizar una petición POST a la siguiente URL:
https://mvsep.com/api/app/enable_long_filenames
| Campo | Tipo | Descripción |
|---|---|---|
| api_token | String | Clave API del usuario |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Su token API>"'
| Clave | Valor |
|---|---|
| success |
|
| message | Informa sobre el estado de la operación |
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Clave API no válida |
Para deshabilitar los nombres extensos de archivos para el usuario, debe realizar una petición POST a la siguiente URL:
https://mvsep.com/api/app/disable_long_filenames
| Campo | Tipo | Descripción |
|---|---|---|
| api_token | String | Clave API del usuario |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Su token API>"'
| Clave | Valor |
|---|---|
| success |
|
| message | Informa sobre el estado de la operación |
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Clave API no válida |
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 | Descripción |
|---|---|---|
| start | Integer | (opcional) Desplazamiento desde el punto inicial, el valor predeterminado es 0 (es decir, se comienza por el último) |
| limit | Integer | (opcional) Cantidad máxima de resultados devueltos, el valor predeterminado es 10, el máximo es 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Devuelve los datos como un arreglo (matriz):
| Clave | Valor |
|---|---|
| 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 | Descripción |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (opcional) Desplazamiento desde el punto inicial, el valor predeterminado es 0 (es decir, se comienza por el último) |
| limit | Integer | (opcional) Cantidad máxima de resultados devueltos, el valor predeterminado es 10, el máximo es 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'
| Clave | Valor |
|---|---|
| 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 | Descripción |
|---|---|---|
| api_token | String | (required) Tu clave 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"'
| Clave | Valor |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
La API de MVSEP utiliza los siguientes códigos de error:
| Código | Significado |
|---|---|
| 400 | Formulario no válido |
| 401 |
api_token desconocido o inválido. Este error aparece si utiliza una clave API desconocida
|
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 | Descripción |
|---|---|---|
| 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 | Descripción |
|---|---|---|
| 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"'
| Clave | Valor |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com