turbo@mvsep.com
ה- API של MVSEP מספק גישה תוכניתית ליצירת הפרדה, החזרת התוצאות, קבלת מידע על האתר ושליטה ביכולות המשתמש.
כדי להשתמש ב-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
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.
כדי ליצור מחיצה, עליך לבצע קריאת POST לכתובת ה-URL הבאה:
https://mvsep.com/api/separation/create
| תחום | סוג | תיאור |
|---|---|---|
| api_token | String | מפתח ה-API שלך |
| audiofile | Binary | קובץ שמע המיועד לעיבוד. 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 | (אופציונלי) סוג הפרדה, ברירת המחדל היא 11 (Demucs3 Model 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 | |
| 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:
|
| שם | ערך |
|---|---|
| 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="<אסימון ה-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 | הצגת קישור לכתובת URL "קבל תוצאה" של המשימה שנוצרה (מוצגת רק כאשר success הוא true) |
| data -> hash | מציג קוד hash של משימה שנוצרה (מוצג רק כאשר success הוא true) |
| data -> message | מציג את תיאור השגיאה (מוצג רק כאשר success הוא false) |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | פרמטרים מסוימים חסרים או לא תקינים. שגיאה זו מופיעה כאשר אינך מעביר כל פרמטר חובה או מעביר פרמטרים לא תקינים. |
| 401 |
api_token לא ידוע או לא חוקי. שגיאה זו מופיעה אם אתה משתמש במפתח API לא ידוע
|
כדי לקבל את תוצאת ההפרדה, עליך לבצע שיחת GET לגורמים הבאים
https://mvsep.com/api/separation/get
| תחום | סוג | תיאור |
|---|---|---|
| hash | String | הפרדת גיבוב |
| mirror | Integer | (אופציונלי) משתמש בשיקוף אחר אם מוגדר ל- 1, ברירת המחדל היא 0. דורש api_token ואשראי אחד אם מוגדר ל- 1. |
| api_token | string | מפתח API (אופציונלי) של המשתמש. נדרש אם פרמטר המראה מוגדר ל- 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 |
|
כדי לקבל את הנתונים המפורטים על סוגי הפרדות, עליך לבצע שיחת GET לכתובת האתר הבאה:
https://mvsep.com/api/app/algorithms
| תחום | סוג | תיאור |
|---|---|---|
| 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'
החזרת נתונים כמערך:
| מפתח | ערך |
|---|---|
| render_id | ערך סוג הפרדת צבע (ID) |
| name | שם סוג ההפרדה |
| algorithm_group_id | הקבוצה אליה שייך סוג ההפרדה: |
| 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 |
למי מיועד סוג הפרדה זה:
|
| 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 | ערך ברירת המחדל של השדה הנוסף. אחד המפתחות של <קוד>algorithm_fields -אפשרויות >< / קוד> |
| algorithm_descriptions | מכיל מידע על תיאורים של סוג הפרדת הצבע |
| algorithm_descriptions -> short_description | תיאור קטן של סוג ההפרדה שאינו משתמש ב- HTML. |
| algorithm_descriptions -> long_description | תיאור מפורט של סוג ההפרדה המשתמש ב- HTML. |
| algorithm_descriptions -> lang | קוד השפה שצוין של התיאור. |
כדי לקבל מידע על החדשות האחרונות על MVSEP, עליך לבצע שיחת 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):
|
כדי לקבל מידע על הפרדות הדגמה, עליך לבצע שיחת GET לכתובת ה- URL הבאה:
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 של המשתמש, עליך לבצע שיחת POST לכתובת ה- URL הבאה:
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 |
אם המשתמש מעוניין במידע נוסף בשמות קבצים:
|
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | אישורים שגויים שצוינו |
כדי לרשום משתמש לאתר MVSEP, עליך לבצע שיחת 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 | מתרחש כאשר הטופס חוקי |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | הטופס אינו חוקי |
כדי לקבל פרטי משתמש, עליך לבצע שיחת GET לכתובת ה- URL הבאה:
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 | הצגת הפרדות צבע מתמשכות עבור המשתמש |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי לקבל היסטוריית הפרדת מידע בסיסית של המשתמש, עליך לבצע שיחת 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 | כמה קרדיטים שימשו למשימה, בטלים אם ההפרדה אינה קיימת |
| data -> time_left | הזמן המשוער שנותר עד למחיקת המשימה |
| data -> algorithm | מכיל מידע בסיסי על סוג הפרדת הצבע שנעשה בו שימוש (עיין בכרטיסייה GET SEPARATION TYPES לקבלת מידע על פרמטרים שהוחזרו) |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי לאפשר שימוש פרימיום עבור המשתמש, עליך לבצע שיחת POST לכתובת ה- URL הבאה:
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 | מודיע על מצב הפעולה |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי להשבית את השימוש בתשלום עבור המשתמש, עליך לבצע שיחת 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 | מודיע על מצב הפעולה |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי לאפשר שמות קבצים ארוכים עבור המשתמש, עליך לבצע שיחת POST לכתובת ה- URL הבאה:
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 | מודיע על מצב הפעולה |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי להשבית שמות קבצים ארוכים עבור המשתמש, עליך לבצע שיחת POST לכתובת ה- URL הבאה:
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 | מודיע על מצב הפעולה |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 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. |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 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 |
turbo@mvsep.com