MVSEP API는 분리를 생성하고, 결과를 반환하고, 사이트 정보를 얻고, 사용자 기능을 제어할 수 있는 프로그래밍 방식의 액세스를 제공합니다.
이 API를 사용하려면 API 키가 필요합니다. 로그인하지 않았습니다. 로그인하여 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
프리미엄 사용자는 10개의 동시 작업을 요청할 수 있으나, 비프리미엄 사용자는 1개의 동시 작업만 요청할 수 있습니다.
분리를 생성하기 위해서는 다음의 URL로 POST 호출을 해야 합니다.
https://mvsep.com/api/separation/create
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | String | 당신의 API 키 |
| audiofile | Binary | 처리할 오디오파일. 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 | (선택 과목) 분리 유형, 기본값은 11입니다 (Demucs3 모델 B (보컬, 드럼, 베이스, 기타)) |
| add_opt1 | String | (선택 과목) 분리 유형 첫 번째 추가 필드 |
| add_opt2 | String | (선택 과목) 분리 유형 두 번째 추가 필드 |
| add_opt3 | String | (선택 사항) 분리 유형 세 번째 추가 필드 |
| output_format | Integer | (선택 과목) 출력 형식, 기본값은 0입니다 (mp3 (320kbps)) |
| is_demo | Boolean | (선택 과목) 분리 결과를 데모 페이지에 게시할 것인가, 기본값은 false입니다. |
| 이름 | 값 | 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:
|
| 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:
|
| 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 | |
| MVSep MelBand Roformer (vocals, instrum) | 35 | |
| Byte Dance (vocals, drums, bass, other) | 16 | |
| 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:
|
| Phantom Centre extraction (by wesleyr36) | 55 | |
| AudioSR (Super Resolution) | 59 | Key: add_opt1 Name: Cutoff (Hz) Options:
|
| FlashSR (Super Resolution) | 60 |
| 이름 | 값 |
|---|---|
| mp3 (320 kbps) | 0 |
| wav (uncompressed) | 1 |
| flac (lossless) | 2 |
| m4a (lossy) | 3 |
curl --location --request POST 'https://mvsep.com/api/separation/create'
--form 'audiofile=@"/path/to/file.mp3"'
--form 'api_token="<당신의 API 토큰>"'
--form 'sep_type="9"'
--form 'add_opt1="0"'
--form 'add_opt2="1"'
--form 'output_format="1"'
--form 'is_demo="1"'
| 키 | 값 |
|---|---|
| success |
|
| data | success 키에 따라 추가 정보를 보유합니다. |
| data -> link | 생성된 작업의 "GET RESULT" URL에 대한 링크 표시(success가 true인 경우에만 표시됨) |
| data -> hash | 생성된 작업 해시를 표시합니다(success가 true인 경우에만 표시됨). |
| data -> message | 오류에 대한 설명을 표시합니다(success가 false인 경우에만 표시됨). |
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 일부 매개변수가 누락되었거나 유효하지 않습니다. 필수 매개변수를 모두 전달하지 않거나 잘못된 매개변수를 전달할 때 이 오류가 발생합니다. |
| 401 |
알 수 없거나 유효하지 않은 api_token. 알려지지 않은 API 키를 사용할 경우 이 오류가 나타납니다.
|
분리 결과를 얻으려면 다음 URL로 GET 요청을 해야 합니다:
https://mvsep.com/api/separation/get
| 필드 | 타입 | 설명 |
|---|---|---|
| hash | String | 분리 해시 |
| mirror | Integer | (선택 사항) 1로 설정된 경우 다른 미러를 사용하고 기본값은 0입니다. 1로 설정된 경우 api_token와 1학점이 필요합니다. |
| api_token | string | (선택 사항) 사용자의 API 키입니다. mirror 매개 변수가 1로 설정된 경우 필요합니다. |
curl --location --request GET 'https://mvsep.com/api/separation/get?hash=20230327071601-0e3e5c6c85-13-dimensions.mp3'
| 키 | 값 |
|---|---|
| success |
|
| status |
|
| data | status 키에 따라 추가 정보를 보유합니다. |
| data -> queue_count | 사용자 우선 순위에 처리되지 않은 작업 수를 표시합니다(status가 waiting 또는 distributing인 경우에만 표시됨). |
| data -> current_order | 사용자의 작업 순서를 표시합니다(status가 waiting 또는 distributing인 경우에만 표시됨). |
| data -> message | 상태에 대한 설명을 표시합니다(모든 상태에 표시되며 status가 failed일 때 대신 오류 이유를 표시합니다. |
| data -> algorithm | 작업에 사용된 알고리즘을 표시합니다(status가 done인 경우에만 표시됨). |
| data -> algorithm_description | 작업에 사용된 알고리즘 세부 정보를 표시합니다(status가 done인 경우에만 표시됨). |
| data -> output_format | 작업의 출력 형식을 표시합니다(status가 done인 경우에만 표시됨). |
| data -> tags | 오디오 메타 태그를 표시합니다(status가 done인 경우에만 표시됨). |
| data -> input_file | 입력 오디오 다운로드 세부 정보를 표시합니다(status이 done인 경우에만 표시됨). |
| data -> files | 출력 오디오 다운로드 세부 정보를 표시합니다(status가 done인 경우에만 표시됨). |
| data -> date | 작업 처리 날짜를 표시합니다(status가 done인 경우에만 표시됨). |
| data -> finished_chunks | 대형 작업의 완료된 부품 수를 표시합니다(status가 distributing인 경우에만 표시됨). |
| data -> all_chunks | 대규모 작업의 모든 부분 수를 표시합니다(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
| 필드 | 타입 | 설명 |
|---|---|---|
| hash | String | 분리 해시 |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| 키 | 값 |
|---|---|
| success |
|
| status |
|
| data | 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
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | string | 사용자의 API 키 |
| hash | string | 분리 해시 |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<당신의 API 토큰>"' --form 'hash="<hash>"'
| 키 | 값 |
|---|---|
| success |
|
분리 유형에 대한 자세한 데이터를 얻으려면 다음 URL로 GET 호출을 해야 합니다:
https://mvsep.com/api/app/algorithms
curl --location --request GET 'https://mvsep.com/api/app/algorithms'
데이터를 어레이로 반환합니다:
| 키 | 값 |
|---|---|
| render_id | 분리 유형 값(ID) |
| name | 분리 유형의 이름 |
| algorithm_group_id |
분리 유형이 속하는 그룹:
|
| orientation |
이 분리 유형은 누구를 대상으로 하나요:
|
| order_id | 분리 유형의 순서 |
| price_coefficient |
프리미엄 사용자로부터 작업 크레딧을 얼마나 받는지 계산하는 데 사용됩니다. 이 공식 사용 : floor(<오디오 파일 지속 시간(초)> * price_coefficient / 60)?:1
|
| usage | Shows monthly usage count of separation type |
| rating | Shows monthly usage rating of separation type as array:
|
| algorithm_fields | 분리 유형의 추가 필드에 대한 정보를 포함합니다 |
| algorithm_fields -> name |
분리 유형의 추가 필드를 표시합니다:
|
| algorithm_fields -> text | 분리 유형의 추가 필드 표시 이름입니다. |
| algorithm_fields -> options | 추가 필드의 JSON 인코딩된 키-값 체인 |
| algorithm_fields -> default_key | 추가 필드의 기본값입니다. <code>algorithm_fields -> options</code>의 키 중 하나입니다> |
| algorithm_descriptions | 분리 유형에 대한 설명에 대한 정보를 포함합니다. |
| algorithm_descriptions -> short_description | HTML을 사용하지 않는 분리 유형에 대한 간단한 설명입니다. |
| algorithm_descriptions -> long_description | HTML을 사용하는 분리 유형에 대한 자세한 설명입니다. |
| algorithm_descriptions -> lang | 설명의 지정된 언어 코드입니다. |
MVSEP에 대한 최신 뉴스를 확인하려면 다음 URL로 GET 호출을 해야 합니다:
https://mvsep.com/api/app/news
| 필드 | 타입 | 설명 |
|---|---|---|
| lang | String | (선택 사항) 2글자 언어 코드(EN, RU) |
| start | Integer | (선택 사항) 시작점 오프셋, 기본값은 0(즉, 최신부터 시작)입니다. |
| limit | Integer | (선택 사항) 반환되는 최대 결과 수, 기본값은 10개, 최대값은 20개입니다. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
데이터를 어레이로 반환합니다:
| 키 | 값 |
|---|---|
| title | 뉴스 제목 |
| lang | 뉴스 제목 |
| text | 뉴스에 대한 전체 설명 |
| created_at | 뉴스 날짜 |
To get site queue information, you need to make a GET call to the following url:
https://mvsep.com/api/app/queue
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | String | (optional) 사용자의 API 키 |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| 키 | 값 |
|---|---|
| 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):
|
데모 분리에 대한 정보를 얻으려면 다음 URL에 대한 GET 호출을 수행해야 합니다.
https://mvsep.com/api/app/demo
| 필드 | 타입 | 설명 |
|---|---|---|
| start | Integer | (선택 사항) 시작점 오프셋, 기본값은 0(즉, 최신부터 시작)입니다. |
| limit | Integer | (선택 사항) 반환되는 최대 결과 수, 기본값은 10개, 최대값은 20개입니다. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
데이터를 어레이로 반환합니다:
| 키 | 값 |
|---|---|
| hash | 분리 해시 |
| date | 분리 날짜 |
| input_audio | 오디오 URL 입력 |
| size | 입력 오디오 크기 |
| algorithm | 사용된 분리 유형에 대한 기본 정보를 포함합니다(반환된 매개변수에 대한 정보는 GET SEPARATION TYPES 탭 참조). |
사용자를 인증하고 사용자의 API 키를 받으려면 다음 URL로 POST 호출을 해야 합니다:
https://mvsep.com/api/app/login
| 필드 | 타입 | 설명 |
|---|---|---|
| String | 사용자의 이메일 | |
| password | String | 사용자의 비밀번호 |
curl --location --request POST 'https://mvsep.com/api/app/login' --form 'email="<사용자의 이메일>"' --form 'password="<사용자의 비밀번호>"'
| 키 | 값 |
|---|---|
| success |
|
| data | 자격 증명이 유효한 경우 정보를 포함합니다 |
| data -> name | 사용자 이름 |
| data -> email | 사용자의 이메일 |
| data -> api_token | 사용자의 API 키입니다. 안전한 저장소에 보관하고 이후 작업에 사용하세요. |
| data -> premium_minutes | 사용자에게 남은 크레딧 |
| data -> premium_enabled |
사용자가 크레딧 사용을 허용했는지 여부입니다.
|
| data -> long_filenames_enabled |
사용자가 파일 이름에 추가 정보를 원하는지 여부:
|
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 잘못된 자격 증명이 지정됨 |
MVSEP 사이트에 사용자를 등록하려면 다음 URL로 POST 호출을 해야 합니다:
https://mvsep.com/api/app/register
| 필드 | 타입 | 설명 |
|---|---|---|
| name | String | 사용자 이름 |
| String | 사용자의 이메일 | |
| password | String | 사용자의 비밀번호 |
| password_confirmation | String | 사용자의 비밀번호를 반복 입력합니다 |
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"'
| 키 | 값 |
|---|---|
| success |
|
| message | 양식이 유효할 때 발생합니다 |
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 양식이 잘못되었습니다 |
사용자 정보를 가져오려면 다음 URL로 GET 호출을 해야 합니다:
https://mvsep.com/api/app/user
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | String | 사용자의 API 키 |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<당신의 API 토큰>'
| 키 | 값 |
|---|---|
| success |
|
| data | 자격 증명이 유효한 경우 정보를 포함합니다 |
| data -> name | 사용자 이름 |
| data -> email | 사용자의 이메일 |
| data -> api_token | 사용자의 API 키입니다. 안전한 저장소에 보관하고 이후 작업에 사용하세요. |
| data -> premium_minutes | 사용자에게 남은 크레딧 |
| data -> premium_enabled |
사용자가 크레딧 사용을 허용했는지 여부입니다.
|
| data -> long_filenames_enabled |
사용자가 파일 이름에 추가 정보를 원하는지 여부:
|
| data -> current_queue | 사용자의 진행 중인 분리를 보여줍니다 |
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 잘못된 API 키 |
사용자의 기본 정보 분리 기록을 가져오려면 다음 URL로 GET 호출을 해야 합니다:
https://mvsep.com/api/app/separation_history
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | String | 사용자의 API 키 |
| start | Integer | (선택 사항) 시작점 오프셋, 기본값은 0(즉, 최신부터 시작)입니다. |
| limit | Integer | (선택 사항) 반환되는 최대 결과 수, 기본값은 10개, 최대값은 20개입니다. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<당신의 API 토큰>&start=1&limit=2'
| 키 | 값 |
|---|---|
| success |
|
| data | 이전 분리에 대한 기본 정보 배열 포함 |
| data -> hash | 분리 해시 |
| data -> job_exists | 이전 분리에 대한 기본 정보 배열 포함 |
| data -> credits | 작업에 사용된 크레딧 수(분리가 없는 경우 null) |
| data -> time_left | 작업 삭제까지 대략적인 남은 시간 |
| data -> algorithm | 사용된 분리 유형에 대한 기본 정보를 포함합니다(반환된 매개변수에 대한 정보는 GET SEPARATION TYPES 탭 참조). |
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 잘못된 API 키 |
사용자의 프리미엄 사용을 활성화하려면 다음 URL로 POST 호출을 해야 합니다:
https://mvsep.com/api/app/enable_premium
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | String | 사용자의 API 키 |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<당신의 API 토큰>"'
| 키 | 값 |
|---|---|
| success |
|
| message | 작업 상태에 대한 정보 제공 |
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 잘못된 API 키 |
사용자의 프리미엄 사용을 비활성화하려면 다음 URL로 POST 호출을 해야 합니다:
https://mvsep.com/api/app/disable_premium
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | String | 사용자의 API 키 |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<당신의 API 토큰>"'
| 키 | 값 |
|---|---|
| success |
|
| message | 작업 상태에 대한 정보 제공 |
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 잘못된 API 키 |
사용자에게 긴 파일 이름을 사용하도록 설정하려면 다음 URL로 POST 호출을 해야 합니다:
https://mvsep.com/api/app/enable_long_filenames
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | String | 사용자의 API 키 |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<당신의 API 토큰>"'
| 키 | 값 |
|---|---|
| success |
|
| message | 작업 상태에 대한 정보 제공 |
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 잘못된 API 키 |
사용자의 긴 파일명을 사용하지 않으려면 다음 URL로 POST 호출을 해야 합니다:
https://mvsep.com/api/app/disable_long_filenames
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | String | 사용자의 API 키 |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<당신의 API 토큰>"'
| 키 | 값 |
|---|---|
| success |
|
| message | 작업 상태에 대한 정보 제공 |
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 잘못된 API 키 |
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
| 필드 | 타입 | 설명 |
|---|---|---|
| start | Integer | (선택 사항) 시작점 오프셋, 기본값은 0(즉, 최신부터 시작)입니다. |
| limit | Integer | (선택 사항) 반환되는 최대 결과 수, 기본값은 10개, 최대값은 20개입니다. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
데이터를 어레이로 반환합니다:
| 키 | 값 |
|---|---|
| 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
| 필드 | 타입 | 설명 |
|---|---|---|
| dataset_type | String | Dataset Type, defaults to 0 if not given
|
| start | Integer | (선택 사항) 시작점 오프셋, 기본값은 0(즉, 최신부터 시작)입니다. |
| limit | Integer | (선택 사항) 반환되는 최대 결과 수, 기본값은 10개, 최대값은 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'
| 키 | 값 |
|---|---|
| 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
| 필드 | 타입 | 설명 |
|---|---|---|
| api_token | String | (required) 당신의 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"'
| 키 | 값 |
|---|---|
| success |
|
| data | Contains information about entry |
| data -> id | ID of the entry. |
| data -> link | Link to the entry. |
MVSEP API는 다음 오류 코드를 사용합니다:
| 오류 코드 | 의미 |
|---|---|
| 400 | 양식이 잘못되었습니다 |
| 401 |
알 수 없거나 유효하지 않은 api_token. 알려지지 않은 API 키를 사용할 경우 이 오류가 나타납니다.
|
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
| 필드 | 타입 | 설명 |
|---|---|---|
| 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
| 필드 | 타입 | 설명 |
|---|---|---|
| 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"'
| 키 | 값 |
|---|---|
| success |
|
| data->message | Shows whether entry was deleted |
