turbo@mvsep.com
ה- API של MVSEP מספק גישה תוכניתית ליצירת הפרדה, החזרת התוצאות, קבלת מידע על האתר ושליטה ביכולות המשתמש.
כדי להשתמש ב-API זה, אתה צריך מפתח API. אינך מחובר, אנא התחבר כדי לקבל את אסימון ה- API שלך.
דוגמאות בפייתון: https://github.com/ZFTurbo/MVSep-API-Examples
אפליקציה לא רשמית MacVSep עבור Mac OS: https://github.com/septcoco/macvsep
ניתן להגדיר Webhooks כאן: עמוד Webhooks
מפרט OpenAPI: mvsep-openapi-spec.json
שימו לב שמשתמשי פרימיום יכולים לבקש מספר בלתי מוגבל של עבודות בו זמנית, בעוד שמשתמשים שאינם פרימיום יכולים לבקש רק עבודה אחת בו זמנית.
כדי ליצור מחיצה, עליך לבצע קריאת POST לכתובת ה-URL הבאה:
https://mvsep.com/api/separation/create
| תחום | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח ה-API שלך |
| audiofile | בינארי | קובץ שמע לעיבוד. לא נדרש אם הפרמטר url מוגדר או שהמודל אינו משתמש בקלט קובץ. עבור מודלים תואמים, השתמש ב-target_audiofile וב-reference_audiofile לקלט במקום ב-audiofile. |
| url | מחרוזת | קישור לקובץ האודיו. לא נדרש אם הפרמטר audiofile מוגדר. |
| remote_type | מחרוזת | (אופציונלי) סוג מרוחק של קובץ האודיו. ברירת המחדל היא direct. לא נדרש אם הפרמטר audiofile מוגדר. הסוגים הנתמכים הם direct (הורדה ישירה), mega (MEGA), drive (Google Drive), dropbox (Dropbox). |
| sep_type | מספר שלם | (אופציונלי) סוג הפרדה, ברירת המחדל היא 11 (Demucs3 Model B (שירה, תופים, בס, אחר) |
| add_opt1 | מחרוזת | (אופציונלי) הפרדה סוג השדה הנוסף הראשון |
| add_opt2 | מחרוזת | (אופציונלי) הפרדה הקלד שדה נוסף שני |
| add_opt3 | מחרוזת | (אופציונלי) סוג הפרדה שדה שלישי נוסף |
| output_format | מספר שלם | פורמט פלט (אופציונלי), ברירת המחדל היא 0 (mp3 (320kbps)) |
| is_demo | בוליאני | (אופציונלי) אם ההפרדה תתפרסם בדף הדגמה, ברירת המחדל היא false |
| שם | ערך | שדות נוספים |
|---|---|---|
| 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 אפשרויות:
|
| BS PolarFormer (vocals, instrumental) | 123 | מפתח: add_opt1 שם: Overlap אפשרויות:
|
| MelBand Roformer (vocals, instrumental) | 48 | מפתח: add_opt1 שם: Vocal model type אפשרויות:
|
| 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 אפשרויות:
|
| 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 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 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 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 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 (braam , other) | 117 | |
| MVSep FX (fx, other) | 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 אפשרויות:
|
| 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 | |
| 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 אפשרויות:
|
| שם | ערך |
|---|---|
| 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 | מחרוזת | הפרדת גיבוב |
| mirror | מספר שלם | (אופציונלי) משתמש בשיקוף אחר אם מוגדר ל- 1, ברירת המחדל היא 0. דורש api_token ואשראי אחד אם מוגדר ל- 1. |
| api_token | מחרוזת | מפתח 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) |
כדי לקבל את התוצאה של עבודה מרוחקת, עליך לבצע קריאה מסוג GET לכתובת ה-URL הבאה:
https://mvsep.com/api/separation/get-remote
| תחום | סוג | תיאור |
|---|---|---|
| hash | מחרוזת | הפרדת גיבוב |
curl --location --request GET 'https://mvsep.com/api/separation/get-remote?hash=n2AwBjy4KsFZfqqR'
| מפתח | ערך |
|---|---|
| success |
|
| status |
|
| data | מכיל מידע נוסף בהתאם למפתח status |
| data -> queue_count | מציג את ספירת המשימות שלא עובדו בעדיפות המשתמש (מוצג רק כאשר הסטטוס הוא ממתין). |
| data -> current_order | מציג את סדר עבודת המשתמש (מוצג רק כאשר הסטטוס הוא ממתין). |
| data -> message | מציג את תיאור הסטטוס (רק כאשר הסטטוס הוא נכשל). |
| data -> link | מציג קישור לכתובת האתר "GET RESULT" של המשימה שנוצרה (מוצג רק כאשר הסטטוס הוא done). |
| data -> hash | גיבוב של ההפרדה (מוצג רק כאשר הסטטוס הוא done). |
כדי לבטל את ההפרדה ולהחזיר את הקרדיטים שנעשה בהם שימוש (אם ההפרדה עדיין לא מעובדת), עליך לבצע קריאה POST לכתובת ה-URL הבאה:
https://mvsep.com/api/separation/cancel
| תחום | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח API של המשתמש |
| hash | מחרוזת | הפרדת גיבוב |
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 | מחרוזת | האם לכלול מודלים המשתמשים בצורות שונות של קלט.
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 | ערך ברירת המחדל של השדה הנוסף. אחד המפתחות של <קוד>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 | מחרוזת | (אופציונלי) קוד שפה בן 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 | מחרוזת | קובץ גולמי אופציונלי מכיל סינון כנגד נתוני אפשרויות עבודה מאוחסנים. יש להעדיף 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 | הפרדת גיבוב |
| date | תאריך הפרידה |
| input_audio | כתובת URL של קלט שמע |
| size | קלט גודל שמע |
| algorithm | מכיל מידע בסיסי על סוג הפרדת הצבע שנעשה בו שימוש (עיין בכרטיסייה GET SEPARATION TYPES לקבלת מידע על פרמטרים שהוחזרו) |
כדי לאמת משתמש ולקבל את מפתח ה- 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 | אישורים שגויים שצוינו |
כדי לרשום משתמש לאתר 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 | הטופס אינו חוקי |
כדי לקבל פרטי משתמש, עליך לבצע שיחת GET לכתובת ה- URL הבאה:
https://mvsep.com/api/app/user
| תחום | סוג | תיאור |
|---|---|---|
| api_token | מחרוזת | מפתח 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 | מחרוזת | מפתח API של המשתמש |
| start | מספר שלם | (אופציונלי) היסט נקודת התחלה, ברירת המחדל היא 0 (כלומר, התחל מהמאוחר) |
| limit | מספר שלם | (אופציונלי) הסכום המרבי של התוצאות המוחזרות, ברירת המחדל היא 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 | מחרוזת | מפתח 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 | מחרוזת | מפתח 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 | מחרוזת | מפתח 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 | מחרוזת | מפתח API של המשתמש |
curl --location --request POST 'https://mvsep.com/api/app/disable_long_filenames' --form 'api_token="<אסימון ה-API שלך>"'
| מפתח | ערך |
|---|---|
| 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 | מחזיר "אישור" אם הפעולה הצליחה, אחרת מציג הודעת שגיאה |
| metrics | מידע על מדדי כניסה |
| sdr_* (wildcard) | SDR של הגבעולים המתאימים |
| 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 נתון של הגזע. ניתן לקבל רשימה של ערכים ניתנים למיון עבור סוג מערך נתונים נתון ממפתח 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 | מפתחות שניתן להשתמש בהם כדי למיין את סוג קבוצת הנתונים המשומשת לפי גזע נתון בסדר עוקב. |
| sort | נעשה שימוש במפתח מיון מ-sortable. |
כדי ליצור ערך לבדיקת איכות, עליך לבצע קריאה ל-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 | מציג האם הערך נמחק |
turbo@mvsep.com