ה- API של MVSEP מספק גישה תוכניתית ליצירת הפרדה, החזרת התוצאות, קבלת מידע על האתר ושליטה ביכולות המשתמש.
כדי להשתמש ב-API זה, אתה צריך מפתח API. אינך מחובר, אנא התחבר כדי לקבל את אסימון ה- API שלך.
שימו לב שמשתמשי פרימיום יכולים לבקש מספר בלתי מוגבל של עבודות בו זמנית, בעוד שמשתמשים שאינם פרימיום יכולים לבקש רק עבודה אחת בו זמנית.
MVSEP מפעילה נקודות קצה אזוריות ל-API. כל האזורים חולקים מסד נתונים אחד של חשבונות, כך שאותו חשבון, אותו מפתח API ואותם ערכי hash של משימות פועלים בכולם:
https://de.mvsep.com/apihttps://de2.mvsep.com/apihttps://hk.mvsep.com/apiבקשות אל https://mvsep.com/api מנותבות לפי מיקום גאוגרפי: פונים מאירופה מנותבים אל de, פונים מצפון אסיה אל hk, וכל השאר אל de2. באינטגרציות API אנו ממליצים לפנות במפורש לנקודת קצה אזורית — כך כל מחזור החיים של המשימה נשאר על אותו מארח, ללא תלות במקום שממנו נשלחות הבקשות.
כל הפרדה מעובדת ומאוחסנת באזור שבו היא נוצרה, וכתובות ה-URL של ההורדה המוחזרות בתגובות תמיד מצביעות על המארח של אותו אזור. לקבלת הביצועים הטובים ביותר, בחר את נקודת הקצה הקרובה ביותר לשרתים שלך והשתמש באותו מארח לאורך כל מחזור החיים של המשימה — יצירה, תשאול סטטוס והורדת קבצים.
אפשר לבדוק את הסטטוס של כל משימה מכל אזור (מסד הנתונים משותף), אך קובצי הפלט עצמם תמיד מוגשים על-ידי האזור שאליו שייכת המשימה.
כדי ליצור הפרדה עליך לבצע קריאת POST לכתובת ה-URL הבאה:
https://mvsep.com/api/separation/create
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח ה-API שלך |
| audiofile | בינארי | קובץ שמע לעיבוד. לא נדרש אם הפרמטר url מוגדר או שהמודל אינו משתמש בקלט קובץ. עבור מודלים מסוג matchering השתמש ב-target_audiofile וב-reference_audiofile כקלט במקום ב-audiofile. |
| url | מחרוזת | קישור לקובץ האודיו. לא נדרש אם הפרמטר audiofile מוגדר. |
| remote_type | מחרוזת | (אופציונלי) סוג מרוחק של קובץ האודיו. ברירת המחדל היא direct. לא נדרש אם הפרמטר audiofile מוגדר. הסוגים הנתמכים הם direct (הורדה ישירה), mega (MEGA), drive (Google Drive), dropbox (Dropbox). |
| sep_type | מספר שלם | (אופציונלי) סוג ההפרדה, ברירת המחדל היא 20. זהו מזהה סוג ההפרדה; ראה את המקטע GET SEPARATION TYPES למידע נוסף. המערכת מתעלמת ממנו כאשר מועבר <code class="higlighted">preset_id</code>. |
| preset_id | מספר שלם | (אופציונלי) ניתן להפעיל אחד מה־presets השמורים שלך על הקובץ במקום להשתמש באלגוריתם יחיד. יש לספק את sep_type או את preset_id. ה־preset מגדיר את האלגוריתמים, האפשרויות ותבניות הפלט שלו, ולכן sep_type, השדות add_opt ו־output_format יזכו להתעלמות. בתגובה יוחזר hash שניתן לבצע עליו polling בדיוק כפי שעושים עבור משימת הפרדה; התוצאה מכילה רשומה אחת עבור כל צומת Output של ה־preset. ניתן למצוא את המזהים (id) שלך בטבלת ה־presets שלהלן. |
| add_opt1 | מחרוזת | (אופציונלי) השדה הנוסף הראשון של סוג ההפרדה |
| add_opt2 | מחרוזת | (אופציונלי) השדה הנוסף השני של סוג ההפרדה |
| add_opt3 | מחרוזת | (אופציונלי) השדה הנוסף השלישי של סוג ההפרדה |
| output_format | מספר שלם | פורמט פלט (אופציונלי), ברירת המחדל היא 0 (mp3 (320kbps)) |
| is_demo | בוליאני | (אופציונלי) אם ההפרדה תתפרסם בדף הדגמה, ברירת המחדל היא false |
| webhook_url | מחרוזת | (optional) A URL we will POST the finished result to, so you do not have to keep polling. The body is the same JSON as GET SEPARATION. This overrides the account-wide address set on the webhooks page, which is useful when several of your own users share one API token. Must be a publicly reachable http or https address. |
| שם | ערך | שדות נוספים |
|---|---|---|
| Ensemble (vocals, instrum) | 26 | מפתח: add_opt1 שם: Output files אפשרויות:
מפתח: add_opt2 שם: Model Type אפשרויות:
|
| Ensemble (vocals, instrum, bass, drums, other) | 28 | מפתח: add_opt1 שם: Output files אפשרויות:
מפתח: add_opt2 שם: Model Type אפשרויות:
|
| Ensemble All-In (vocals, bass, drums, piano, guitar, lead/back vocals, other) | 30 | מפתח: add_opt1 שם: Output files אפשרויות:
מפתח: add_opt2 שם: Model Type אפשרויות:
|
| BS Roformer SW (vocals, bass, drums, guitar, piano, other) | 63 | |
| Demucs4 HT (vocals, drums, bass, other) | 20 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| BS Roformer (vocals, instrumental) | 40 | מפתח: add_opt1 שם: Vocal model type אפשרויות:
מפתח: add_opt2 שם: Overlap אפשרויות:
מפתח: add_opt3 שם: Set of stems אפשרויות:
|
| BS PolarFormer (vocals, instrumental) | 123 | מפתח: add_opt1 שם: Model type אפשרויות:
מפתח: add_opt2 שם: Overlap אפשרויות:
|
| MelBand Roformer (vocals, instrumental) | 48 | מפתח: add_opt1 שם: Vocal model type אפשרויות:
מפתח: add_opt2 שם: Overlap אפשרויות:
|
| MDX23C (vocals, instrumental) | 25 | מפתח: add_opt1 שם: Vocal model type אפשרויות:
|
| SCNet (vocals, instrumental) | 46 | מפתח: add_opt1 שם: Vocal model type אפשרויות:
|
| MDX B (vocals, instrumental) | 23 | מפתח: add_opt1 שם: Vocal model type אפשרויות:
|
| Ultimate Vocal Remover VR (vocals, music) | 9 | מפתח: add_opt1 שם: Model Type אפשרויות:
מפתח: add_opt2 שם: Agressiveness אפשרויות:
|
| Demucs4 Vocals 2023 (vocals, instrum) | 27 | |
| MVSep Karaoke (lead/back vocals) | 49 | מפתח: add_opt1 שם: Karaoke model type אפשרויות:
מפתח: add_opt2 שם: Extraction type אפשרויות:
|
| MDX-B Karaoke (lead/back vocals) | 12 | מפתח: add_opt1 שם: Karaoke model type אפשרויות:
|
| MVSep Crowd removal (crowd, other) | 34 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| Medley Vox (Multi-singer separation) | 53 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| MVSep Multichannel BS (vocals, instrumental) | 43 | מפתח: add_opt1 שם: Model Type אפשרויות:
מפתח: add_opt2 שם: Processing Mode אפשרויות:
|
| MVSep Male/Female separation | 57 | מפתח: add_opt1 שם: Model type אפשרויות:
מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Choir (choir, other) | 112 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep SATB Choir (soprano, alto, tenor, bass) | 111 | מפתח: add_opt1 שם: Model type אפשרויות:
מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Drums (drums, other) | 44 | מפתח: add_opt1 שם: Drums model type אפשרויות:
מפתח: add_opt2 שם: How to extract אפשרויות:
מפתח: add_opt3 שם: Output files אפשרויות:
|
| MVSep Bass (bass, other) | 41 | מפתח: add_opt1 שם: Bass model type אפשרויות:
מפתח: add_opt2 שם: How to extract אפשרויות:
מפתח: add_opt3 שם: Output files אפשרויות:
|
| MVSep Synth (synth, other) | 88 | מפתח: add_opt1 שם: How to extract אפשרויות:
|
| DrumSep (4-6 stems: kick, snare, cymbals, toms, ride, hh, crash) | 37 | מפתח: add_opt1 שם: Model Type אפשרויות:
מפתח: add_opt2 שם: Preprocess אפשרויות:
|
| MVSep Piano (piano, other) | 29 | מפתח: add_opt1 שם: Piano model type אפשרויות:
|
| MVSep Digital Piano (digital-piano, other) | 79 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Keys (keys, other) | 106 | |
| MVSep Organ (organ, other) | 58 | מפתח: add_opt1 שם: Organ model type אפשרויות:
|
| MVSep Harpsichord (harpsichord, other) | 91 | |
| MVSep Accordion (accordion, other) | 99 | |
| MVSep Vibraphone | 129 | |
| MVSep Metal Bars | 130 | |
| MVSep Rhodes | 131 | |
| MVSep Clavinet | 135 | |
| MVSep Mellotron | 136 | |
| MVSep Guitar (guitar, other) | 31 | מפתח: add_opt1 שם: Guitar model type אפשרויות:
|
| MVSep Acoustic Guitar (acoustic-guitar, other) | 66 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Electric Guitar (electric-guitar, other) | 81 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Lead/Rhythm Guitar (lead-guitar, rhythm-guitar) | 101 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| MVSep Pedal Steel Guitar | 124 | |
| 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 | מפתח: add_opt1 שם: String model type אפשרויות:
מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Violin (violin, other) | 65 | |
| MVSep Viola (viola, other) | 69 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Cello (cello, other) | 70 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Double Bass (double-bass, other) | 73 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Wind (wind, other) | 54 | מפתח: add_opt1 שם: Wind model type אפשרויות:
מפתח: add_opt2 שם: How to extract אפשרויות:
מפתח: add_opt3 שם: Output files אפשרויות:
|
| MVSep Brass (brass, other) | 107 | מפתח: add_opt1 שם: How to extract אפשרויות:
|
| MVSep Woodwind (woodwind, other) | 108 | מפתח: add_opt1 שם: How to extract אפשרויות:
|
| MVSep Saxophone (saxophone, other) | 61 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| MVSep Flute (flute, other) | 67 | מפתח: add_opt1 שם: Flute model type אפשרויות:
מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Trumpet (trumpet, other) | 71 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Trombone (trombone, other) | 75 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Oboe (oboe, other) | 77 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Clarinet (clarinet, other) | 78 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep French Horn (french-horn, other) | 82 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Harmonica (harmonica, other) | 87 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Tuba (tuba, other) | 92 | |
| MVSep Bassoon (bassoon, other) | 93 | |
| MVSep Bagpipes (bagpipes , other) | 116 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Whistle | 132 | |
| 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 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Celesta (celesta, other) | 110 | מפתח: add_opt2 שם: How to extract אפשרויות:
|
| MVSep Clap | 133 | |
| MVSep Cowbell | 128 | |
| MVSep Demucs4HT DNR (speech, music, effects) | 24 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| BandIt Plus (speech, music, effects) | 36 | |
| BandIt v2 (speech, music, effects) | 45 | מפתח: add_opt1 שם: Model Type אפשרויות:
|
| MVSep DnR v3 (speech, music, effects) | 56 | מפתח: add_opt1 שם: Model type אפשרויות:
מפתח: add_opt2 שם: How to extract אפשרויות:
מפתח: add_opt3 שם: Output files אפשרויות:
|
| MVSep Braam | 117 | |
| MVSep Risers | 125 | |
| MVSep FX | 122 | |
| Apollo Enhancers (by JusperLee, Lew, baicai1145) | 51 | מפתח: add_opt1 שם: Model type אפשרויות:
מפתח: add_opt2 שם: Cutoff (Hz) אפשרויות:
|
| Reverb Removal (noreverb) | 22 | מפתח: add_opt1 שם: Model Type אפשרויות:
מפתח: add_opt2 שם: Preprocess אפשרויות:
|
| DeNoise by aufr33 and gabox | 47 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| AudioSR (Super Resolution) | 59 | מפתח: add_opt1 שם: Cutoff (Hz) אפשרויות:
|
| FlashSR (Super Resolution) | 60 | |
| Stable Audio Open Gen | 62 | מפתח: add_opt1 שם: Text prompt אפשרויות: מפתח: add_opt2 שם: Length (in seconds) אפשרויות:
|
| Whisper (extract text from audio) | 39 | מפתח: add_opt1 שם: Model type אפשרויות:
מפתח: add_opt2 שם: Transcription type אפשרויות:
|
| Parakeet (extract text from audio) | 64 | מפתח: add_opt1 שם: Model type אפשרויות:
מפתח: add_opt2 שם: Version אפשרויות:
|
| VibeVoice (Voice Cloning) | 103 | מפתח: add_opt1 שם: Model type אפשרויות:
מפתח: add_opt2 שם: Text prompt אפשרויות: מפתח: add_opt3 שם: Extract vocals first אפשרויות:
|
| VibeVoice (TTS) | 104 | מפתח: add_opt1 שם: Model type אפשרויות:
מפתח: add_opt2 שם: Text prompt אפשרויות: |
| Qwen3-TTS (Custom Voice) | 118 | מפתח: add_opt1 שם: Text prompt אפשרויות: מפתח: add_opt2 שם: Speaker אפשרויות:
מפתח: add_opt3 שם: Language אפשרויות:
מפתח: add_opt4 שם: Voice description אפשרויות: |
| Qwen3-TTS (Voice Design) | 119 | מפתח: add_opt1 שם: Text prompt אפשרויות: מפתח: add_opt2 שם: Voice description אפשרויות: מפתח: add_opt3 שם: Language אפשרויות:
|
| Qwen3-TTS (Voice Cloning) | 120 | מפתח: add_opt1 שם: Text prompt אפשרויות: מפתח: add_opt2 שם: Reference text in audio (optional) אפשרויות: מפתח: add_opt3 שם: Language אפשרויות:
מפתח: add_opt4 שם: Extract vocals first אפשרויות:
|
| Mega 53-stem Model | 126 | |
| Upmixing by Jazzpear | 137 | |
| Bark (Speech Gen) | 115 | מפתח: add_opt1 שם: Text prompt אפשרויות: מפתח: add_opt2 שם: Speaker אפשרויות:
|
| MVSep MultiSpeaker (MDX23C) | 42 | מפתח: add_opt1 שם: Model Type אפשרויות:
|
| Aspiration (by Sucial) | 50 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| Phantom Centre extraction | 55 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| Matchering (by sergree) | 68 | |
| SOME (Singing-Oriented MIDI Extractor) | 80 | מפתח: add_opt1 שם: How to use אפשרויות:
|
| Transkun (Piano -> MIDI) | 113 | מפתח: add_opt1 שם: How to extract אפשרויות:
|
| Basic Pitch (MIDI Extraction) | 114 | |
| ADTOF Plus (Drums -> MIDI) | 127 | מפתח: add_opt1 שם: How to extract אפשרויות:
|
| HeartMuLa (Song Gen) | 121 | מפתח: add_opt1 שם: Lyrics אפשרויות: מפתח: add_opt10 שם: Topic אפשרויות:
מפתח: add_opt2 שם: Tags (optional) אפשרויות: מפתח: add_opt3 שם: Genre אפשרויות:
מפתח: add_opt4 שם: Timbre אפשרויות:
מפתח: add_opt5 שם: Gender אפשרויות:
מפתח: add_opt6 שם: Mood אפשרויות:
מפתח: add_opt7 שם: Instrument אפשרויות:
מפתח: add_opt8 שם: Scene אפשרויות:
מפתח: add_opt9 שם: Region אפשרויות:
|
| Demucs3 Model (vocals, drums, bass, other) | 10 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| MDX A/B (vocals, drums, bass, other) | 7 | מפתח: add_opt1 שם: Vocal model type אפשרויות:
|
| Vit Large 23 (vocals, instrum) | 33 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| UVRv5 Demucs (vocals, music) | 17 | מפתח: add_opt1 שם: Model Type אפשרויות:
|
| 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 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| UnMix | 3 | מפתח: add_opt1 שם: Model type אפשרויות:
|
| Zero Shot (Query Based) (Low quality) | 14 | מפתח: add_opt1 שם: Model Type אפשרויות:
|
| LarsNet (kick, snare, cymbals, toms, hihat) | 38 | מפתח: add_opt1 שם: Model type אפשרויות:
|
ה־presets הם פרטיים לחשבון שיצר אותם, ולכן טבלה זו מציגה את ה־presets שלך וכן את ה־presets המובחרים. ניתן ליצור ולערוך אותם בעורך ה־presets.
עדיין אין לך presets. התחבר למערכת וצור preset חדש ב־עורך ה־presets, וה־id שלו יופיע כאן.
| שם | ערך |
|---|---|
| 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="<Your API Token>"'
--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 של "GET RESULT" עבור המשימה שנוצרה (מוצג רק כאשר success הוא true) |
| data -> hash | מציג קוד hash של משימה שנוצרה (מוצג רק כאשר success הוא true) |
| data -> message | מציג את תיאור השגיאה (מוצג רק כאשר success הוא false) |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | פרמטרים מסוימים חסרים או לא תקינים. שגיאה זו מופיעה כאשר אינך מעביר את כל פרמטרי החובה או כאשר אתה מעביר פרמטרים לא תקינים. |
| 401 |
api_token לא ידוע או לא חוקי. שגיאה זו מופיעה אם אתה משתמש במפתח API לא ידוע
|
כדי לקבל את תוצאת ההפרדה עליך לבצע קריאת GET לכתובת ה-URL הבאה:
https://mvsep.com/api/separation/get
אותו endpoint מחזיר גם את תוצאות ההרצה של ה־presets: יש לבצע polling על ה־hash שהוחזר באמצעות preset_id, בדיוק כפי שנעשה עבור משימת הפרדה. מבנה התגובה זהה לחלוטין — הערך status עובר ברצף בין waiting, processing ו־done, והערך של data.type הוא preset_run. כל רשומה ב־data.files מייצגת צומת Output אחד של ה־preset ונקראת לפי ה־label שלה, ולא לפי stem. תוצאות ההרצה גלויות רק לחשבון שיצר את ה־preset.
| שדה | סוג | תיאור |
|---|---|---|
| hash | מחרוזת | ה-hash של ההפרדה |
| mirror | מספר שלם | (אופציונלי) משתמש בשרת מראה אחר אם מוגדר ל-1, ברירת המחדל היא 0. דורש api_token וקרדיט אחד אם מוגדר ל-1. |
| api_token | מחרוזת | (אופציונלי) מפתח ה-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) |
מחיקה של אחת ההפרדות שלך — משימה רגילה או הרצת preset. הפעולה מסירה את הרשומה ואת קובצי הפלט שלה. הפרדה שעדיין בעיבוד יש לבטל תחילה. המחיקה אינה מזכה בהחזר קרדיטים, מכיוון שהעיבוד כבר בוצע.
POST https://mvsep.com/api/separation/delete
אפשר לבדוק את הסטטוס של כל משימה מכל אזור (מסד הנתונים משותף), אך קובצי הפלט עצמם תמיד מוגשים על-ידי האזור שאליו שייכת המשימה.
| שדה | סוג | תיאור |
|---|---|---|
| hash | מחרוזת | ה-hash של ההפרדה |
| api_token | מחרוזת | מפתח ה-API של המשתמש. חובה. |
curl --location --request POST 'https://mvsep.com/api/separation/delete'
--form 'api_token="<Your API Token>"'
--form 'hash="20230327071601-0e3e5c6c85-13-dimensions.mp3"'
| מפתח | ערך |
|---|---|
| success |
|
| data -> message | מציג את תיאור המצב (מוצג בכל הסטטוסים, מציג במקום זאת את סיבת השגיאה כאשר status הוא failed) |
כדי לקבל את התוצאה של עבודה מרוחקת, עליך לבצע קריאה מסוג GET לכתובת ה-URL הבאה:
https://mvsep.com/api/separation/get-remote
| שדה | סוג | תיאור |
|---|---|---|
| hash | מחרוזת | ה-hash של ההפרדה |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| מפתח | ערך |
|---|---|
| success |
|
| status |
|
| data | מכיל מידע נוסף בהתאם למפתח status |
| data -> queue_count | מציג את מספר המשימות שטרם עובדו בעדיפות של המשתמש (מוצג רק כאשר status הוא waiting). |
| data -> current_order | מציג את מיקום המשימה של המשתמש בתור (מוצג רק כאשר status הוא waiting). |
| data -> message | מציג את תיאור הסטטוס (רק כאשר status הוא failed). |
| data -> link | מציג קישור לכתובת ה-URL של "GET RESULT" עבור המשימה שנוצרה (מוצג רק כאשר status הוא done). |
| data -> hash | ה-hash של ההפרדה (מוצג רק כאשר status הוא done). |
כדי לבטל את ההפרדה ולהחזיר את הקרדיטים שנעשה בהם שימוש (אם ההפרדה עדיין לא מעובדת), עליך לבצע קריאה POST לכתובת ה-URL הבאה:
https://mvsep.com/api/separation/cancel
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
| hash | מחרוזת | ה-hash של ההפרדה |
curl --location --request POST 'https://mvsep.com/api/separation/cancel' --form 'api_token="<Your API Token>"' --form 'hash="<hash>"'
| מפתח | ערך |
|---|---|
| success |
|
כדי לקבל את הנתונים המפורטים על סוגי הפרדות, עליך לבצע קריאת GET לכתובת האתר הבאה:
https://mvsep.com/api/app/algorithms
| שדה | סוג | תיאור |
|---|---|---|
| scopes | מחרוזת | האם לכלול מודלים המשתמשים בצורות שונות של קלט.
single_upload אם לא סופק. כדי לקבל את כל המודלים, הגדר 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 | מכיל מידע על קבוצת האלגוריתמים שאליה שייך האלגוריתם. |
| algorithm_group -> name | שם קבוצת האלגוריתמים. |
| audio_widget |
סוג ווידג'ט האודיו שיש להשתמש בו עבור האלגוריתם. ניתן להשתמש בו כדי לקבוע כיצד להציג את נגן האודיו עבור האלגוריתם בממשק המשתמש. ערכים אפשריים הם:
|
| orientation |
למי מיועד סוג הפרדה זה:
|
| order_id | סדר סוג ההפרדה |
| price_coefficient |
משמש לחישוב כמה קרדיטים העבודה לוקחת ממשתמש פרימיום. שימוש בנוסחה זו : floor(<משך קובץ שמע בשניות> * price_coefficient / 60)?:1
|
| usage | מציג ספירת שימוש חודשית של סוג ההפרדה |
| rating | מציג דירוג שימוש חודשי של סוג ההפרדה כמערך:
|
| 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, עליך לבצע קריאת GET לכתובת האתר הבאה:
https://mvsep.com/api/app/news
| שדה | סוג | תיאור |
|---|---|---|
| lang | מחרוזת | (אופציונלי) קוד שפה בן 2 אותיות (en, ru) |
| start | מספר שלם | (אופציונלי) היסט נקודת ההתחלה, ברירת המחדל היא 0 (כלומר להתחיל מהחדש ביותר) |
| limit | מספר שלם | (אופציונלי) מספר התוצאות המרבי שיוחזר, ברירת המחדל היא 10, המקסימום הוא 20. |
curl --location --request GET 'https://mvsep.com/api/app/news?lang=en&start=2&limit=1'
החזרת נתונים כמערך:
| מפתח | ערך |
|---|---|
| title | כותרת החדשות |
| lang | כותרת החדשות |
| text | תיאור מלא של החדשות |
| created_at | תאריך החדשות |
כדי לקבל מידע על תור האתר, עליך לבצע קריאה מסוג GET לכתובת ה-URL הבאה:
https://mvsep.com/api/app/queue
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | (אופציונלי) מפתח API של המשתמש |
curl --location --request GET 'https://mvsep.com/api/app/queue'
| מפתח | ערך |
|---|---|
| queue |
מכיל מערך של תורים נוכחיים עבור תוכניות שונות:
|
| plan |
מכיל את התור הנוכחי עבור התוכנית הנוכחית (הוסף api_token לבקשה עבור תוכנית רשומה/פרימיום):
|
כדי לקבל מידע על הפרדות הדגמה, עליך לבצע קריאת GET לכתובת ה- URL הבאה:
https://mvsep.com/api/app/demo
| שדה | סוג | תיאור |
|---|---|---|
| start | מספר שלם | (אופציונלי) היסט נקודת ההתחלה, ברירת המחדל היא 0 (כלומר להתחיל מהחדש ביותר) |
| limit | מספר שלם | (אופציונלי) מספר התוצאות המרבי שיוחזר, ברירת המחדל היא 10, המקסימום הוא 20. |
| algorithm_id | מספר שלם | מזהה סוג הפרדה אופציונלי. השתמש באפשרות זו כדי להחזיר הפרדות הדגמה שנוצרו על ידי אלגוריתם אחד בלבד. הערכים תואמים ל-render_id מנקודת הקצה GET SEPARATION TYPES. |
| options[FIELD] | מחרוזת / מספר שלם | מסנן אופציונלי לערכי אפשרויות אלגוריתם. החלף את FIELD במפתח שדה נוסף מ-algorithm_fields -> name בתגובת GET SEPARATION TYPES, לאחר מכן העבר אחד ממפתחות options של שדה זה כערך. דוגמה: options[vocals]=1. |
| additional_options | מחרוזת | מסנן "contains" גולמי ואופציונלי מול נתוני האפשרויות השמורים של המשימה. באינטגרציות חדשות עדיף להשתמש ב-options[FIELD], מכיוון שהוא מפורש וקל יותר להרכבה. |
curl --location --request GET 'https://mvsep.com/api/app/demo?start=0&limit=2'
curl --location --request GET 'https://mvsep.com/api/app/demo?algorithm_id=20&options[vocals]=1&start=0&limit=10'
כדי לבנות מסנני אפשרויות, שלחו תחילה בקשה אל https://mvsep.com/api/app/algorithms ובדקו את רשימת algorithm_fields של כל אלגוריתם. השתמשו בערך name של השדה בתוך options[FIELD] ובאחד ממפתחות האפשרויות של ה-JSON כערך.
החזרת נתונים כמערך:
| מפתח | ערך |
|---|---|
| hash | ה-hash של ההפרדה |
| date | תאריך ההפרדה |
| input_audio | כתובת URL של קלט שמע |
| size | גודל שמע הקלט |
| algorithm | מכיל מידע בסיסי על סוג ההפרדה שנעשה בו שימוש (עיין בלשונית GET SEPARATION TYPES לקבלת מידע על הפרמטרים המוחזרים) |
כדי לרשום משתמש לאתר MVSEP, עליך לבצע קריאת POST לכתובת האתר הבאה:
https://mvsep.com/api/app/register
| שדה | סוג | תיאור |
|---|---|---|
| name | מחרוזת | שם המשתמש |
| מחרוזת | דוא"ל של המשתמש | |
| password | מחרוזת | סיסמת המשתמש |
| password_confirmation | מחרוזת | חזור על הסיסמה של המשתמש |
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 | הטופס אינו חוקי |
כדי לאמת משתמש ולקבל את מפתח ה- API של המשתמש, עליך לבצע קריאת POST לכתובת ה- URL הבאה:
https://mvsep.com/api/app/login
| שדה | סוג | תיאור |
|---|---|---|
| מחרוזת | דוא"ל של המשתמש | |
| password | מחרוזת | סיסמת המשתמש |
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 | צוינו פרטי התחברות שגויים |
כדי לקבל פרטי משתמש, עליך לבצע קריאת GET לכתובת ה- URL הבאה:
https://mvsep.com/api/app/user
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
curl --location --request GET 'https://mvsep.com/api/app/user?api_token=<Your API Token>'
| מפתח | ערך |
|---|---|
| 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 לכתובת ה-URL הבאה:
https://mvsep.com/api/app/separation_history
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
| start | מספר שלם | (אופציונלי) היסט נקודת ההתחלה, ברירת המחדל היא 0 (כלומר להתחיל מהחדש ביותר) |
| limit | מספר שלם | (אופציונלי) מספר התוצאות המרבי שיוחזר, ברירת המחדל היא 10, המקסימום הוא 20. |
curl --location --request GET 'https://mvsep.com/api/app/separation_history?api_token=<Your API Token>&start=1&limit=2'
| מפתח | ערך |
|---|---|
| success |
|
| data | מכיל מערך עם מידע בסיסי על הפרדות קודמות |
| data -> hash | ה-hash של ההפרדה |
| data -> job_exists | מכיל מערך עם מידע בסיסי על הפרדות קודמות |
| data -> credits | כמה קרדיטים נוצלו עבור המשימה, או null אם ההפרדה אינה קיימת |
| data -> time_left | הזמן המשוער שנותר עד למחיקת המשימה |
| data -> algorithm | מכיל מידע בסיסי על סוג ההפרדה שנעשה בו שימוש (עיין בלשונית GET SEPARATION TYPES לקבלת מידע על הפרמטרים המוחזרים) |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי לקבל את רכישות הקרדיטים של החשבון, מהחדשה לישנה, עליך לבצע קריאת GET לכתובת ה-URL הבאה:
https://mvsep.com/api/purchases
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
| limit | מספר שלם | (אופציונלי) כמה רכישות להחזיר, 1-100. ברירת המחדל היא 20. |
| offset | מספר שלם | (אופציונלי) מספר רשומות הרכישה שיש לדלג עליהן לצורך חלוקה לעמודים. ברירת המחדל היא 0. |
| status | מחרוזת | (אופציונלי) החזר רק רכישות בעלות מצב זה, לדוגמה succeeded. השמט פרמטר זה (או העבר את הערך all) כדי לקבל את כל הרשומות המוצגות בדף היסטוריית הרכישות של האתר, לרבות תשלומים שהחלו אך לא הושלמו. לרשומות אלו יש את המצב unpaid, והן אינן מקנות קרדיטים. |
curl --location --request GET 'https://mvsep.com/api/purchases?api_token=<Your API Token>&status=succeeded&limit=20'
| מפתח | ערך |
|---|---|
| purchases | כל רשומת רכישה כוללת את payment_id, status, amount, מספר ה־credits שהוענקו, payment_method (stripe, paddle, yookassa, google_play או app_store) וכן את date. |
| total | כמה רכישות תואמות בסך הכול, בלי להתחשב ב-limit וב-offset — היעזר בזה כדי לדפדף בין העמודים. |
| credits | יתרת הקרדיטים הנוכחית של החשבון. |
MVSEP שולחת הודעת דואר אלקטרוני כאשר יתרת הקרדיטים שלך יורדת מתחת לערך הסף שהגדרת, כדי למנוע עצירה בלתי צפויה של אינטגרציה פעילה. בקשת GET מחזירה את ההגדרה הנוכחית, ואילו POST משמשת לשינויה. ההתראה נשלחת פעם אחת בלבד ולא תישלח שוב עד שיתרת הקרדיטים תחזור לעלות מעל ערך הסף שהוגדר.
GET https://mvsep.com/api/credit_alert
POST https://mvsep.com/api/credit_alert
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
| credit_threshold | מספר שלם | (לבקשות POST בלבד, חובה) שלח התראה כאשר יתרת הקרדיטים שווה לערך זה או נמוכה ממנו. הערך 0 מבטל את ההתראה. שינוי ערך הסף מפעיל מחדש התראה שכבר נשלחה. |
curl --location --request GET 'https://mvsep.com/api/credit_alert?api_token=<Your API Token>'
curl --location --request POST 'https://mvsep.com/api/credit_alert' --form 'api_token=<Your API Token>' --form 'credit_threshold=100'
| מפתח | ערך |
|---|---|
| credit_threshold | הסף שמוגדר כעת, בקרדיטים. |
| enabled | <code>true</code> כאשר מוגדר סף גדול מאפס, אחרת <code>false</code>. |
| credits | יתרת הקרדיטים הנוכחית של החשבון. |
| notified | <code>true</code> לאחר שההתראה נשלחה עבור הירידה הנוכחית; מתאפס מעצמו כשהיתרה עולה חזרה מעל הסף. |
| הכתובת שאליה נשלחת ההתראה. |
כדי לאפשר שימוש פרימיום עבור המשתמש, עליך לבצע קריאת POST לכתובת ה- URL הבאה:
https://mvsep.com/api/app/enable_premium
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
curl --location --request POST 'https://mvsep.com/api/app/enable_premium' --form 'api_token="<Your API Token>"'
| מפתח | ערך |
|---|---|
| success |
|
| message | מודיע על מצב הפעולה |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי להשבית שימוש פרימיום עבור המשתמש, עליך לבצע קריאת POST לכתובת ה-URL הבאה:
https://mvsep.com/api/app/disable_premium
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
curl --location --request POST 'https://mvsep.com/api/app/disable_premium' --form 'api_token="<Your API Token>"'
| מפתח | ערך |
|---|---|
| success |
|
| message | מודיע על מצב הפעולה |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי לאפשר שמות קבצים ארוכים עבור המשתמש, עליך לבצע קריאת POST לכתובת ה- URL הבאה:
https://mvsep.com/api/app/enable_long_filenames
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
curl --location --request POST 'https://mvsep.com/api/app/enable_long_filenames' --form 'api_token="<Your API Token>"'
| מפתח | ערך |
|---|---|
| success |
|
| message | מודיע על מצב הפעולה |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי להשבית שמות קבצים ארוכים עבור המשתמש, עליך לבצע קריאת POST לכתובת ה- URL הבאה:
https://mvsep.com/api/app/disable_long_filenames
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<Your API Token>"'
| מפתח | ערך |
|---|---|
| success |
|
| message | מודיע על מצב הפעולה |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | מפתח API לא חוקי |
כדי לקבל מידע על ערכי תור של בודק האיכות, עליך לבצע קריאה מסוג GET לכתובת ה-URL הבאה:
https://mvsep.com/api/quality_checker/queue
| שדה | סוג | תיאור |
|---|---|---|
| start | מספר שלם | (אופציונלי) היסט נקודת ההתחלה, ברירת המחדל היא 0 (כלומר להתחיל מהחדש ביותר) |
| limit | מספר שלם | (אופציונלי) מספר התוצאות המרבי שיוחזר, ברירת המחדל היא 10, המקסימום הוא 20. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/queue?&start=1&limit=2'
החזרת נתונים כמערך:
| מפתח | ערך |
|---|---|
| id | מספר זיהוי של הערך |
| dataset_type | סוג מערך הנתונים שנבחר בעת הוספת הערך / סוג טבלת המובילים
|
| date | תאריך יצירת הערך |
| algo_name | שם סוג/אלגוריתם ההפרדה שבוצע |
| main_text | תיאור סוג/אלגוריתם ההפרדה בו נעשה שימוש |
| proc | סטטוס העיבוד
|
| proc_remote_date | חותמת זמן של תאריך העיבוד |
| msg | מחזיר "OK" אם הפעולה הצליחה, אחרת מציג הודעת שגיאה |
| metrics | מידע על המדדים של הערך |
| sdr_* (wildcard) | ערכי ה-SDR של ה-stems המתאימים |
| dataset_name | שם מערך הנתונים |
כדי לקבל מידע על טבלאות המובילים של Quality Checker, עליך לבצע קריאה GET לכתובת ה-URL הבאה:
https://mvsep.com/api/quality_checker/leaderboard
| שדה | סוג | תיאור |
|---|---|---|
| dataset_type | מחרוזת | סוג מערך נתונים, ברירת המחדל היא 0 אם לא צוין.
|
| start | מספר שלם | (אופציונלי) היסט נקודת ההתחלה, ברירת המחדל היא 0 (כלומר להתחיל מהחדש ביותר) |
| limit | מספר שלם | (אופציונלי) מספר התוצאות המרבי שיוחזר, ברירת המחדל היא 10, המקסימום הוא 20. |
| algo_name_filter | מחרוזת | מסנן שמות סוגי/אלגוריתמי הפרדה לפי טקסט נתון |
| sort | מחרוזת | מיון לפי ערך ה-SDR של stem נתון. את רשימת הערכים שניתן למיין לפיהם עבור סוג מערך נתונים מסוים אפשר לקבל ממפתח sortables בתגובה. |
curl --location --request GET 'https://mvsep.com/api/quality_checker/leaderboard?&start=1&limit=2&algo_name_filter=MVSep'
| מפתח | ערך |
|---|---|
| data | מכיל מערך של ערכי בודק איכות. עיין בתגובת GET QUEUE מסעיף בודק האיכות לקבלת מידע נוסף. |
| dataset_type | מפתח סוג מערך נתונים בשימוש |
| sortables | מפתחות שניתן להשתמש בהם כדי למיין את סוג מערך הנתונים לפי stem מסוים בסדר רציף. |
| sort | מפתח המיון שנבחר מתוך sortables. |
כדי ליצור ערך לבדיקת איכות, עליך לבצע קריאה ל-POST לכתובת ה-URL הבאה:
https://mvsep.com/api/quality_checker/add
| שדה | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | (חובה) מפתח ה-API שלך |
| zipfile | בינארי | (חובה) קובץ Zip לעיבוד |
| algo_name | מחרוזת | (חובה) שם האלגוריתם |
| main_text | מחרוזת | (חובה) תיאור האלגוריתם |
| dataset_type | מחרוזת | סוג מערך נתונים. ברירת המחדל היא 0.
|
| password | מחרוזת | (חובה) סיסמה למחיקה של אלגוריתם |
| ensemble | מספר שלם | 0 - האלגוריתם אינו אנסמבל. 1 - האלגוריתם הוא אנסמבל. |
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 | מכיל מידע על הערך |
| data -> id | מזהה הערך |
| data -> link | קישור לערך |
ה-API של MVSEP משתמש בקודי השגיאה הבאים:
| קוד שגיאה | משמעות |
|---|---|
| 400 | הטופס אינו חוקי |
| 401 |
api_token לא ידוע או לא חוקי. שגיאה זו מופיעה אם אתה משתמש במפתח API לא ידוע
|
כדי לקבל מידע על ערך בתור של בודק האיכות לפי מזהה, עליך לבצע קריאת GET לכתובת ה-URL הבאה:
https://mvsep.com/api/quality_checker/entry
| שדה | סוג | תיאור |
|---|---|---|
| id | מספר שלם | (חובה) מזהה הערך |
curl --location --request GET 'https://mvsep.com/api/quality_checker/entry?id=7675'
כדי למחוק ערך בתור של בודק האיכות באמצעות מזהה וסיסמה, עליך לבצע קריאה מסוג GET לכתובת ה-URL הבאה:
https://mvsep.com/api/quality_checker/delete
| שדה | סוג | תיאור |
|---|---|---|
| id | מספר שלם | (חובה) מזהה הערך |
| password | מחרוזת | (חובה) הסיסמה שנקבעה עבור הערך |
curl --location 'https://mvsep.com/api/quality_checker/delete' --form 'id="7720"' --form 'password="test"'
| מפתח | ערך |
|---|---|
| success |
|
| data->message | מציג האם הערך נמחק |
ספריות, יישומים ואינטגרציות שנבנו על בסיס API זה. אלא אם צוין אחרת, מדובר בפרויקטים של הקהילה שאינם מתוחזקים על־ידי MVSEP, ולכן איננו יכולים לערוב לאיכותם או לאמינותם.
כלי זה מופץ ב־PyPI תחת השם mvsep-cli ומציג את MVSEP כמחברו, דבר שעלול ליצור רושם כי מדובר בכלי רשמי. בפועל, הוא פורסם ומתוחזק על־ידי צד שלישי ולא על־ידי MVSEP, ומאגר קוד המקור שאליו הוא מפנה כלל אינו קיים. הכלי מבקש את אסימון ה־API שלך, ולכן מומלץ לעיין בקוד המקור שלו לפני הדבקת האסימון.
mvsep-cli.: pypi.org/project/mvsep-cli
