turbo@mvsep.com
A API MVSEP fornece acesso programático para criar uma separação, retornar os resultados, obter informações do site e controlar as capacidades do usuário
Para usar essa API, você precisa de um API key. você não está conectado, conectar-se para obter seu token de 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
Observe que os usuários Premium podem solicitar até 10 trabalhos simultâneos, enquanto os usuários não-Premium podem solicitar apenas 1 trabalho simultâneo.
Para criar uma separação, você precisa criar uma chamada POST para a seguinte url:
https://mvsep.com/api/separation/create
| Campo | Tipo | Descrição |
|---|---|---|
| api_token | String | Sua chave API |
| audiofile | Binary | Arquivo a ser processado. 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 | (opcional) Tipo de separação, o padrão é 11 (Demucs3 Modelo B (vocais, bateria, baixo, e outros)) |
| add_opt1 | String | (opcional) Tipo de separação, primeiro campo adicional |
| add_opt2 | String | (opcional) Tipo de separação, segundo campo adicional |
| add_opt3 | String | (opcional) Terceiro campo adicional do tipo de separação |
| output_format | Integer | (opcional) formato de saída, o padrão é 0 (mp3 (320kbps)) |
| is_demo | Boolean | (opcional) caso a separação seja publicada na página de demonstração, o padrão é falso |
| Nome | 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 | |
| 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 | 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="<Seu Token da API>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| Chave | Valor |
|---|---|
| success |
|
| data | Contém informações adicionais dependendo da chave success |
| data -> link | Mostra o link para a URL "OBTER RESULTADO" do trabalho criado (apenas exibido quando success é true) |
| data -> hash | Mostra o hash do trabalho criado (apenas exibido quando success é true) |
| data -> message | Mostra a descrição de um erro (apenas exibido quando success é false) |
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | Alguns parâmetros estão faltando ou estão inválidos. Este erro aparece quando você não passa todos os parâmetros obrigatórios ou passa parâmetros inválidos. |
| 401 |
Desconhecido ou inválido api_token. Esse erro aparece se você usa uma chave de API desconhecida.
|
Para ter o resultado, você precisa fazer uma chamada GET para a seguinte url:
https://mvsep.com/api/separation/get
| Campo | Tipo | Descrição |
|---|---|---|
| hash | String | Hash de separação |
| mirror | Integer | (opcional) Usa outro espelho se definido como 1, padrão é 0. Requer api_token e 1 crédito se definido como 1 |
| api_token | string | (opcional) Chave API do usuário. Necessária se o parâmetro de espelho for definido como 1 |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| Chave | Valor |
|---|---|
| success |
|
| status |
|
| data | Contém informações adicionais dependendo da chave status |
| data -> queue_count | Mostra a contagem de trabalhos não processados na prioridade do usuário (apenas exibido quando status é waiting ou distributing) |
| data -> current_order | Mostra a ordem do trabalho do usuário (apenas exibido quando status é waiting ou distributing) |
| data -> message | Mostra a descrição do status (exibido em todos os status, mostra a razão do erro quando status é failed) |
| data -> algorithm | Mostra o algoritmo usado no trabalho (apenas exibido quando status é done) |
| data -> algorithm_description | Mostra os detalhes do algoritmo usado no trabalho (apenas exibido quando status é done) |
| data -> output_format | Mostra o formato de saída do trabalho (apenas exibido quando status é done) |
| data -> tags | Mostra as tags meta de áudio (apenas exibido quando status é done) |
| data -> input_file | Mostra os detalhes do download do áudio de entrada (apenas exibido quando status é done) |
| data -> files | Mostra os detalhes do download dos áudios de saída (apenas exibido quando status é done) |
| data -> date | Mostra a data de processamento do trabalho (apenas exibido quando status é done) |
| data -> finished_chunks | Mostra o número de partes concluídas de um grande trabalho (apenas exibido quando status é distributing) |
| data -> all_chunks | Mostra o número total de partes de um grande trabalho (apenas exibido 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 | Descrição |
|---|---|---|
| hash | String | Hash de separação |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| Chave | Valor |
|---|---|
| success |
|
| status |
|
| data | Contém informações adicionais dependendo da chave 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 | Descrição |
|---|---|---|
| api_token | string | chave de api do usuário |
| hash | string | Hash de separação |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Seu Token da API>"' --form 'hash="<hash>"'
| Chave | Valor |
|---|---|
| success |
|
Para obter os dados detalhados sobre os tipos de separação, você precisa fazer uma chamada GET para a seguinte URL:
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
Retorna os dados como um array:
| Chave | Valor |
|---|---|
| render_id | Valor do tipo de separação (ID) |
| name | o nome do tipo de separação |
| algorithm_group_id |
o grupo ao qual pertence o tipo de separação:
|
| orientation |
a quem se destina esse tipo de separação:
|
| order_id | ordem do tipo de separação |
| price_coefficient |
usado para calcular quantos créditos a tarefa recebe do usuário premium. usa esta fórmula : floor(<duração do arquivo de áudio em 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 | contém informações sobre campos adicionais do tipo de separação |
| algorithm_fields -> name |
mostra qual campo adicional do tipo de separação:
|
| algorithm_fields -> text | nome de exibição do campo adicional do tipo de separação. |
| algorithm_fields -> options | Cadeias de chave-valor codificadas em JSON do campo adicional |
| algorithm_fields -> default_key | Valor padrão do campo adicional. Uma das chaves de <code>algorithm_fields -> options</code> |
| algorithm_descriptions | contém informações sobre as descrições do tipo de separação |
| algorithm_descriptions -> short_description | Pequena descrição do tipo de separação que não usa html. |
| algorithm_descriptions -> long_description | descrição detalhada do tipo de separação que usa html. |
| algorithm_descriptions -> lang | código de idioma especificado da descrição. |
Para obter informações sobre as últimas notícias sobre o MVSEP, você precisa fazer uma chamada GET para a seguinte URL:
https://mvsep.com/api/app/news
| Campo | Tipo | Descrição |
|---|---|---|
| lang | String | (opcional) Código de idioma de 2 letras (en, ru) |
| start | Integer | (opcional) Ponto de partida de deslocamento, padrão é 0 (ou seja, começa a partir do mais recente) |
| limit | Integer | (opcional) Quantidade máxima de resultados retornados, padrão é 10, máximo é 20 |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
Retorna os dados como um array:
| Chave | Valor |
|---|---|
| title | título da noticia |
| lang | título da noticia |
| text | descrição completa da notícia |
| created_at | data da noticia |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| Campo | Tipo | Descrição |
|---|---|---|
| api_token | String | (optional) chave de api do usuário |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| Chave | 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 obter informações sobre separações de demonstração, você precisa fazer uma chamada GET para a seguinte URL:
https://mvsep.com/api/app/demo
| Campo | Tipo | Descrição |
|---|---|---|
| start | Integer | (opcional) Ponto de partida de deslocamento, padrão é 0 (ou seja, começa a partir do mais recente) |
| limit | Integer | (opcional) Quantidade máxima de resultados retornados, padrão é 10, máximo é 20 |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
Retorna os dados como um array:
| Chave | Valor |
|---|---|
| hash | Hash de separação |
| date | data da separação |
| input_audio | url do áudio de entrada |
| size | tamanho do áudio de entrada |
| algorithm | Contém informações básicas sobre o tipo de separação utilizado (consulte a aba GET SEPARATION TYPES para informações sobre os parâmetros retornados) |
Para autenticar o usuário e obter a chave API do usuário, você precisa fazer uma chamada POST para a seguinte URL:
https://mvsep.com/api/app/login
| Campo | Tipo | Descrição |
|---|---|---|
| String | email do usuário | |
| password | String | senha do usuário |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<email do usuário>"' --form 'password="<senha do usuário>"'
| Chave | Valor |
|---|---|
| success |
|
| data | contém informações quando as credenciais são válidas |
| data -> name | Nome do usuário |
| data -> email | email do usuário |
| data -> api_token | chave de api do usuário. certifique-se de armazená-la em um local seguro e usá-la em operações subsequentes. |
| data -> premium_minutes | créditos deixados para o usuário |
| data -> premium_enabled |
caso o usuário tenha permitido que os créditos fosse gastos
|
| data -> long_filenames_enabled |
caso o usuário deseje informações adicionais nos nomes de arquivos:
|
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | credenciais incorretas especificadas |
Para registrar o usuário no site MVSEP, você precisa fazer uma chamada POST para a seguinte URL:
https://mvsep.com/api/app/register
| Campo | Tipo | Descrição |
|---|---|---|
| name | String | Nome do usuário |
| String | email do usuário | |
| password | String | senha do usuário |
| password_confirmation | String | repita a senha do usuário |
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"'
| Chave | Valor |
|---|---|
| success |
|
| message | ocorre quando o formulário é inválido |
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | o formulário é inválido |
Para obter informações do usuário, você precisa fazer uma chamada GET para a seguinte URL:
https://mvsep.com/api/app/user
| Campo | Tipo | Descrição |
|---|---|---|
| api_token | String | chave de api do usuário |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Seu Token da API>'
| Chave | Valor |
|---|---|
| success |
|
| data | contém informações quando as credenciais são válidas |
| data -> name | Nome do usuário |
| data -> email | email do usuário |
| data -> api_token | chave de api do usuário. certifique-se de armazená-la em um local seguro e usá-la em operações subsequentes. |
| data -> premium_minutes | créditos deixados para o usuário |
| data -> premium_enabled |
caso o usuário tenha permitido que os créditos fosse gastos
|
| data -> long_filenames_enabled |
caso o usuário deseje informações adicionais nos nomes de arquivos:
|
| data -> current_queue | mostra as separações em andamento para o usuário |
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | chave de api inválida |
Para obter informações básicas sobre o histórico de separações do usuário, você precisa fazer uma chamada GET para a seguinte URL:
https://mvsep.com/api/app/separation_history
| Campo | Tipo | Descrição |
|---|---|---|
| api_token | String | chave de api do usuário |
| start | Integer | (opcional) Ponto de partida de deslocamento, padrão é 0 (ou seja, começa a partir do mais recente) |
| limit | Integer | (opcional) Quantidade máxima de resultados retornados, padrão é 10, máximo é 20 |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Seu Token da API>&start=1&limit=2'
| Chave | Valor |
|---|---|
| success |
|
| data | contém uma matriz de informações básicas sobre separações anteriores |
| data -> hash | Hash de separação |
| data -> job_exists | contém uma matriz de informações básicas sobre separações anteriores |
| data -> credits | quantos créditos foram usados para a tarefa, nulo se não houver separação |
| data -> time_left | tempo restante estimado até que a tarefa seja deletada |
| data -> algorithm | Contém informações básicas sobre o tipo de separação utilizado (consulte a aba GET SEPARATION TYPES para informações sobre os parâmetros retornados) |
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | chave de api inválida |
Para habilitar o uso premium para o usuário, você precisa fazer uma chamada POST para a seguinte URL:
https://mvsep.com/api/app/enable_premium
| Campo | Tipo | Descrição |
|---|---|---|
| api_token | String | chave de api do usuário |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Seu Token da API>"'
| Chave | Valor |
|---|---|
| success |
|
| message | informa sobre o status da operação |
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | chave de api inválida |
Para desabilitar o uso premium para o usuário, você precisa fazer uma chamada POST para a seguinte URL:
https://mvsep.com/api/app/disable_premium
| Campo | Tipo | Descrição |
|---|---|---|
| api_token | String | chave de api do usuário |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Seu Token da API>"'
| Chave | Valor |
|---|---|
| success |
|
| message | informa sobre o status da operação |
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | chave de api inválida |
Para habilitar nomes de arquivos longos para o usuário, você precisa fazer uma chamada POST para a seguinte URL:
https://mvsep.com/api/app/enable_long_filenames
| Campo | Tipo | Descrição |
|---|---|---|
| api_token | String | chave de api do usuário |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Seu Token da API>"'
| Chave | Valor |
|---|---|
| success |
|
| message | informa sobre o status da operação |
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | chave de api inválida |
Para desabilitar nomes de arquivos longos para o usuário, você precisa fazer uma chamada POST para a seguinte URL:
https://mvsep.com/api/app/disable_long_filenames
| Campo | Tipo | Descrição |
|---|---|---|
| api_token | String | chave de api do usuário |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Seu Token da API>"'
| Chave | Valor |
|---|---|
| success |
|
| message | informa sobre o status da operação |
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | chave de api invá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 | Descrição |
|---|---|---|
| start | Integer | (opcional) Ponto de partida de deslocamento, padrão é 0 (ou seja, começa a partir do mais recente) |
| limit | Integer | (opcional) Quantidade máxima de resultados retornados, padrão é 10, máximo é 20 |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
Retorna os dados como um array:
| Chave | 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 | Descrição |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (opcional) Ponto de partida de deslocamento, padrão é 0 (ou seja, começa a partir do mais recente) |
| limit | Integer | (opcional) Quantidade máxima de resultados retornados, padrão é 10, máximo é 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'
| Chave | 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 | Descrição |
|---|---|---|
| api_token | String | (required) Sua chave 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"'
| Chave | Valor |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
A API de MVSEP usa os seguintes códigos de erro:
| Código de erro | Significado |
|---|---|
| 400 | o formulário é inválido |
| 401 |
Desconhecido ou inválido api_token. Esse erro aparece se você usa uma chave de API desconhecida.
|
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 | Descrição |
|---|---|---|
| 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 | Descrição |
|---|---|---|
| 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"'
| Chave | Valor |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
turbo@mvsep.com