swagger.yaml 187 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781
  1. definitions:
  2. adaptor.ConfigTemplate:
  3. properties:
  4. description:
  5. type: string
  6. example: {}
  7. name:
  8. type: string
  9. required:
  10. type: boolean
  11. type:
  12. $ref: '#/definitions/adaptor.ConfigType'
  13. type: object
  14. adaptor.ConfigTemplates:
  15. additionalProperties:
  16. $ref: '#/definitions/adaptor.ConfigTemplate'
  17. type: object
  18. adaptor.ConfigType:
  19. enum:
  20. - string
  21. - number
  22. - bool
  23. - object
  24. type: string
  25. x-enum-varnames:
  26. - ConfigTypeString
  27. - ConfigTypeNumber
  28. - ConfigTypeBool
  29. - ConfigTypeObject
  30. adaptors.AdaptorMeta:
  31. properties:
  32. config:
  33. $ref: '#/definitions/adaptor.ConfigTemplates'
  34. defaultBaseUrl:
  35. type: string
  36. fetures:
  37. items:
  38. type: string
  39. type: array
  40. keyHelp:
  41. type: string
  42. name:
  43. type: string
  44. type: object
  45. controller.AddChannelRequest:
  46. properties:
  47. base_url:
  48. type: string
  49. config:
  50. $ref: '#/definitions/model.ChannelConfig'
  51. key:
  52. type: string
  53. model_mapping:
  54. additionalProperties:
  55. type: string
  56. type: object
  57. models:
  58. items:
  59. type: string
  60. type: array
  61. name:
  62. type: string
  63. priority:
  64. type: integer
  65. sets:
  66. items:
  67. type: string
  68. type: array
  69. status:
  70. type: integer
  71. type:
  72. $ref: '#/definitions/model.ChannelType'
  73. type: object
  74. controller.AddTokenRequest:
  75. properties:
  76. models:
  77. items:
  78. type: string
  79. type: array
  80. name:
  81. type: string
  82. quota:
  83. type: number
  84. subnets:
  85. items:
  86. type: string
  87. type: array
  88. type: object
  89. controller.BuiltinModelConfig:
  90. properties:
  91. config:
  92. additionalProperties: {}
  93. type: object
  94. created_at:
  95. type: string
  96. exclude_from_tests:
  97. type: boolean
  98. force_save_detail:
  99. type: boolean
  100. image_prices:
  101. additionalProperties:
  102. format: float64
  103. type: number
  104. description: map[size]price_per_image
  105. type: object
  106. image_quality_prices:
  107. additionalProperties:
  108. additionalProperties:
  109. format: float64
  110. type: number
  111. type: object
  112. description: map[size]map[quality]price_per_image
  113. type: object
  114. max_error_rate:
  115. type: number
  116. model:
  117. type: string
  118. owner:
  119. $ref: '#/definitions/model.ModelOwner'
  120. plugin:
  121. additionalProperties:
  122. items:
  123. type: integer
  124. type: array
  125. type: object
  126. price:
  127. $ref: '#/definitions/model.Price'
  128. retry_times:
  129. type: integer
  130. rpm:
  131. type: integer
  132. timeout_config:
  133. $ref: '#/definitions/model.TimeoutConfig'
  134. tpm:
  135. type: integer
  136. type:
  137. $ref: '#/definitions/mode.Mode'
  138. updated_at:
  139. type: string
  140. warn_error_rate:
  141. type: number
  142. type: object
  143. controller.CreateGroupRequest:
  144. properties:
  145. available_sets:
  146. items:
  147. type: string
  148. type: array
  149. balance_alert_enabled:
  150. type: boolean
  151. balance_alert_threshold:
  152. type: number
  153. rpm_ratio:
  154. type: number
  155. tpm_ratio:
  156. type: number
  157. type: object
  158. controller.EmbedMCP:
  159. properties:
  160. config_templates:
  161. $ref: '#/definitions/controller.EmbedMCPConfigTemplates'
  162. embed_config:
  163. $ref: '#/definitions/model.MCPEmbeddingConfig'
  164. enabled:
  165. type: boolean
  166. github_url:
  167. type: string
  168. id:
  169. type: string
  170. name:
  171. type: string
  172. name_cn:
  173. type: string
  174. readme:
  175. type: string
  176. readme_cn:
  177. type: string
  178. readme_cn_url:
  179. type: string
  180. readme_url:
  181. type: string
  182. tags:
  183. items:
  184. type: string
  185. type: array
  186. type: object
  187. controller.EmbedMCPConfigTemplate:
  188. properties:
  189. description:
  190. type: string
  191. example:
  192. type: string
  193. name:
  194. type: string
  195. required:
  196. type: boolean
  197. type: object
  198. controller.EmbedMCPConfigTemplates:
  199. additionalProperties:
  200. $ref: '#/definitions/controller.EmbedMCPConfigTemplate'
  201. type: object
  202. controller.EnabledModelChannel:
  203. properties:
  204. id:
  205. type: integer
  206. name:
  207. type: string
  208. type:
  209. $ref: '#/definitions/model.ChannelType'
  210. type: object
  211. controller.GetModelConfigsByModelsContainsRequest:
  212. properties:
  213. models:
  214. items:
  215. type: string
  216. type: array
  217. type: object
  218. controller.GroupMCPResponse:
  219. properties:
  220. created_at:
  221. type: string
  222. description:
  223. type: string
  224. endpoints:
  225. $ref: '#/definitions/controller.MCPEndpoint'
  226. group_id:
  227. type: string
  228. id:
  229. type: string
  230. name:
  231. type: string
  232. openapi_config:
  233. $ref: '#/definitions/model.MCPOpenAPIConfig'
  234. proxy_config:
  235. $ref: '#/definitions/model.GroupMCPProxyConfig'
  236. status:
  237. $ref: '#/definitions/model.GroupMCPStatus'
  238. type:
  239. $ref: '#/definitions/model.GroupMCPType'
  240. update_at:
  241. type: string
  242. type: object
  243. controller.GroupModel:
  244. properties:
  245. config:
  246. additionalProperties: {}
  247. type: object
  248. created_at:
  249. type: integer
  250. enabled_plugins:
  251. items:
  252. type: string
  253. type: array
  254. image_prices:
  255. additionalProperties:
  256. format: float64
  257. type: number
  258. description: map[size]price_per_image
  259. type: object
  260. image_quality_prices:
  261. additionalProperties:
  262. additionalProperties:
  263. format: float64
  264. type: number
  265. type: object
  266. description: map[size]map[quality]price_per_image
  267. type: object
  268. model:
  269. type: string
  270. owner:
  271. $ref: '#/definitions/model.ModelOwner'
  272. price:
  273. $ref: '#/definitions/model.Price'
  274. rpm:
  275. type: integer
  276. tpm:
  277. type: integer
  278. type:
  279. $ref: '#/definitions/mode.Mode'
  280. updated_at:
  281. type: integer
  282. type: object
  283. controller.GroupPublicMCPDetailResponse:
  284. properties:
  285. created_at:
  286. type: string
  287. description:
  288. type: string
  289. description_cn:
  290. type: string
  291. embed_config:
  292. $ref: '#/definitions/model.MCPEmbeddingConfig'
  293. endpoints:
  294. $ref: '#/definitions/controller.MCPEndpoint'
  295. github_url:
  296. type: string
  297. hosted:
  298. type: boolean
  299. id:
  300. type: string
  301. logo_url:
  302. type: string
  303. name:
  304. type: string
  305. name_cn:
  306. type: string
  307. openapi_config:
  308. $ref: '#/definitions/model.MCPOpenAPIConfig'
  309. params:
  310. additionalProperties:
  311. type: string
  312. type: object
  313. price:
  314. $ref: '#/definitions/model.MCPPrice'
  315. proxy_config:
  316. $ref: '#/definitions/model.PublicMCPProxyConfig'
  317. readme:
  318. type: string
  319. readme_cn:
  320. type: string
  321. readme_cn_url:
  322. type: string
  323. readme_url:
  324. type: string
  325. reusing:
  326. additionalProperties:
  327. $ref: '#/definitions/model.ReusingParam'
  328. type: object
  329. status:
  330. $ref: '#/definitions/model.PublicMCPStatus'
  331. tags:
  332. items:
  333. type: string
  334. type: array
  335. test_config:
  336. allOf:
  337. - $ref: '#/definitions/model.TestConfig'
  338. description: only used by list tools
  339. tools:
  340. items:
  341. $ref: '#/definitions/mcp.Tool'
  342. type: array
  343. type:
  344. $ref: '#/definitions/model.PublicMCPType'
  345. update_at:
  346. type: string
  347. type: object
  348. controller.GroupPublicMCPResponse:
  349. properties:
  350. created_at:
  351. type: string
  352. description:
  353. type: string
  354. description_cn:
  355. type: string
  356. embed_config:
  357. $ref: '#/definitions/model.MCPEmbeddingConfig'
  358. github_url:
  359. type: string
  360. hosted:
  361. type: boolean
  362. id:
  363. type: string
  364. logo_url:
  365. type: string
  366. name:
  367. type: string
  368. name_cn:
  369. type: string
  370. openapi_config:
  371. $ref: '#/definitions/model.MCPOpenAPIConfig'
  372. price:
  373. $ref: '#/definitions/model.MCPPrice'
  374. proxy_config:
  375. $ref: '#/definitions/model.PublicMCPProxyConfig'
  376. readme:
  377. type: string
  378. readme_cn:
  379. type: string
  380. readme_cn_url:
  381. type: string
  382. readme_url:
  383. type: string
  384. status:
  385. $ref: '#/definitions/model.PublicMCPStatus'
  386. tags:
  387. items:
  388. type: string
  389. type: array
  390. test_config:
  391. allOf:
  392. - $ref: '#/definitions/model.TestConfig'
  393. description: only used by list tools
  394. type:
  395. $ref: '#/definitions/model.PublicMCPType'
  396. update_at:
  397. type: string
  398. type: object
  399. controller.GroupResponse:
  400. properties:
  401. accessed_at:
  402. type: string
  403. available_sets:
  404. items:
  405. type: string
  406. type: array
  407. balance_alert_enabled:
  408. type: boolean
  409. balance_alert_threshold:
  410. type: number
  411. created_at:
  412. type: string
  413. id:
  414. type: string
  415. request_count:
  416. type: integer
  417. rpm_ratio:
  418. type: number
  419. status:
  420. type: integer
  421. tpm_ratio:
  422. type: number
  423. used_amount:
  424. type: number
  425. type: object
  426. controller.ImportChannelFromOneAPIRequest:
  427. properties:
  428. dsn:
  429. type: string
  430. type: object
  431. controller.MCPEndpoint:
  432. properties:
  433. host:
  434. type: string
  435. sse:
  436. type: string
  437. streamable_http:
  438. type: string
  439. type: object
  440. controller.OpenAIModelPermission:
  441. properties:
  442. allow_create_engine:
  443. type: boolean
  444. allow_fine_tuning:
  445. type: boolean
  446. allow_logprobs:
  447. type: boolean
  448. allow_sampling:
  449. type: boolean
  450. allow_search_indices:
  451. type: boolean
  452. allow_view:
  453. type: boolean
  454. created:
  455. type: integer
  456. group:
  457. type: string
  458. id:
  459. type: string
  460. is_blocking:
  461. type: boolean
  462. object:
  463. type: string
  464. organization:
  465. type: string
  466. type: object
  467. controller.OpenAIModels:
  468. properties:
  469. created:
  470. type: integer
  471. id:
  472. type: string
  473. object:
  474. type: string
  475. owned_by:
  476. type: string
  477. parent:
  478. type: string
  479. permission:
  480. items:
  481. $ref: '#/definitions/controller.OpenAIModelPermission'
  482. type: array
  483. root:
  484. type: string
  485. type: object
  486. controller.PublicMCPResponse:
  487. properties:
  488. created_at:
  489. type: string
  490. description:
  491. type: string
  492. description_cn:
  493. type: string
  494. embed_config:
  495. $ref: '#/definitions/model.MCPEmbeddingConfig'
  496. endpoints:
  497. $ref: '#/definitions/controller.MCPEndpoint'
  498. github_url:
  499. type: string
  500. id:
  501. type: string
  502. logo_url:
  503. type: string
  504. name:
  505. type: string
  506. name_cn:
  507. type: string
  508. openapi_config:
  509. $ref: '#/definitions/model.MCPOpenAPIConfig'
  510. price:
  511. $ref: '#/definitions/model.MCPPrice'
  512. proxy_config:
  513. $ref: '#/definitions/model.PublicMCPProxyConfig'
  514. readme:
  515. type: string
  516. readme_cn:
  517. type: string
  518. readme_cn_url:
  519. type: string
  520. readme_url:
  521. type: string
  522. status:
  523. $ref: '#/definitions/model.PublicMCPStatus'
  524. tags:
  525. items:
  526. type: string
  527. type: array
  528. test_config:
  529. allOf:
  530. - $ref: '#/definitions/model.TestConfig'
  531. description: only used by list tools
  532. type:
  533. $ref: '#/definitions/model.PublicMCPType'
  534. update_at:
  535. type: string
  536. type: object
  537. controller.SaveEmbedMCPRequest:
  538. properties:
  539. enabled:
  540. type: boolean
  541. id:
  542. type: string
  543. init_config:
  544. additionalProperties:
  545. type: string
  546. type: object
  547. type: object
  548. controller.SaveGroupModelConfigRequest:
  549. properties:
  550. force_save_detail:
  551. type: boolean
  552. image_prices:
  553. additionalProperties:
  554. format: float64
  555. type: number
  556. type: object
  557. model:
  558. type: string
  559. override_force_save_detail:
  560. type: boolean
  561. override_limit:
  562. type: boolean
  563. override_price:
  564. type: boolean
  565. override_retry_times:
  566. type: boolean
  567. price:
  568. $ref: '#/definitions/model.Price'
  569. retry_times:
  570. type: integer
  571. rpm:
  572. type: integer
  573. tpm:
  574. type: integer
  575. type: object
  576. controller.SaveModelConfigsRequest:
  577. properties:
  578. config:
  579. additionalProperties: {}
  580. type: object
  581. created_at:
  582. type: string
  583. exclude_from_tests:
  584. type: boolean
  585. force_save_detail:
  586. type: boolean
  587. image_prices:
  588. additionalProperties:
  589. format: float64
  590. type: number
  591. description: map[size]price_per_image
  592. type: object
  593. image_quality_prices:
  594. additionalProperties:
  595. additionalProperties:
  596. format: float64
  597. type: number
  598. type: object
  599. description: map[size]map[quality]price_per_image
  600. type: object
  601. max_error_rate:
  602. type: number
  603. model:
  604. type: string
  605. owner:
  606. $ref: '#/definitions/model.ModelOwner'
  607. plugin:
  608. additionalProperties:
  609. items:
  610. type: integer
  611. type: array
  612. type: object
  613. price:
  614. $ref: '#/definitions/model.Price'
  615. retry_times:
  616. type: integer
  617. rpm:
  618. type: integer
  619. timeout_config:
  620. $ref: '#/definitions/model.TimeoutConfig'
  621. tpm:
  622. type: integer
  623. type:
  624. $ref: '#/definitions/mode.Mode'
  625. updated_at:
  626. type: string
  627. warn_error_rate:
  628. type: number
  629. type: object
  630. controller.StatusData:
  631. properties:
  632. startTime:
  633. type: integer
  634. type: object
  635. controller.TestResult:
  636. properties:
  637. data:
  638. $ref: '#/definitions/model.ChannelTest'
  639. message:
  640. type: string
  641. success:
  642. type: boolean
  643. type: object
  644. controller.TokenResponse:
  645. properties:
  646. accessed_at:
  647. type: string
  648. created_at:
  649. type: string
  650. group:
  651. type: string
  652. id:
  653. type: integer
  654. key:
  655. type: string
  656. models:
  657. items:
  658. type: string
  659. type: array
  660. name:
  661. type: string
  662. quota:
  663. type: number
  664. request_count:
  665. type: integer
  666. status:
  667. type: integer
  668. subnets:
  669. items:
  670. type: string
  671. type: array
  672. used_amount:
  673. type: number
  674. type: object
  675. controller.UpdateChannelStatusRequest:
  676. properties:
  677. status:
  678. type: integer
  679. type: object
  680. controller.UpdateGroupMCPStatusRequest:
  681. properties:
  682. status:
  683. $ref: '#/definitions/model.GroupMCPStatus'
  684. type: object
  685. controller.UpdateGroupRPMRatioRequest:
  686. properties:
  687. rpm_ratio:
  688. type: number
  689. type: object
  690. controller.UpdateGroupStatusRequest:
  691. properties:
  692. status:
  693. type: integer
  694. type: object
  695. controller.UpdateGroupTPMRatioRequest:
  696. properties:
  697. tpm_ratio:
  698. type: number
  699. type: object
  700. controller.UpdateGroupsStatusRequest:
  701. properties:
  702. groups:
  703. items:
  704. type: string
  705. type: array
  706. status:
  707. type: integer
  708. type: object
  709. controller.UpdatePublicMCPStatusRequest:
  710. properties:
  711. status:
  712. $ref: '#/definitions/model.PublicMCPStatus'
  713. type: object
  714. controller.UpdateTokenNameRequest:
  715. properties:
  716. name:
  717. type: string
  718. type: object
  719. controller.UpdateTokenStatusRequest:
  720. properties:
  721. status:
  722. type: integer
  723. type: object
  724. mcp.Meta:
  725. properties:
  726. additionalFields:
  727. additionalProperties: {}
  728. description: |-
  729. AdditionalFields are any fields present in the Meta that are not
  730. otherwise defined in the protocol.
  731. type: object
  732. progressToken:
  733. description: |-
  734. If specified, the caller is requesting out-of-band progress
  735. notifications for this request (as represented by
  736. notifications/progress). The value of this parameter is an
  737. opaque token that will be attached to any subsequent
  738. notifications. The receiver is not obligated to provide these
  739. notifications.
  740. type: object
  741. mcp.Tool:
  742. properties:
  743. _meta:
  744. allOf:
  745. - $ref: '#/definitions/mcp.Meta'
  746. description: Meta is a metadata object that is reserved by MCP for storing
  747. additional information.
  748. annotations:
  749. allOf:
  750. - $ref: '#/definitions/mcp.ToolAnnotation'
  751. description: Optional properties describing tool behavior
  752. description:
  753. description: A human-readable description of the tool.
  754. type: string
  755. inputSchema:
  756. allOf:
  757. - $ref: '#/definitions/mcp.ToolInputSchema'
  758. description: A JSON Schema object defining the expected parameters for the
  759. tool.
  760. name:
  761. description: The name of the tool.
  762. type: string
  763. type: object
  764. mcp.ToolAnnotation:
  765. properties:
  766. destructiveHint:
  767. description: If true, the tool may perform destructive updates
  768. type: boolean
  769. idempotentHint:
  770. description: If true, repeated calls with same args have no additional effect
  771. type: boolean
  772. openWorldHint:
  773. description: If true, tool interacts with external entities
  774. type: boolean
  775. readOnlyHint:
  776. description: If true, the tool does not modify its environment
  777. type: boolean
  778. title:
  779. description: Human-readable title for the tool
  780. type: string
  781. type: object
  782. mcp.ToolInputSchema:
  783. properties:
  784. $defs:
  785. additionalProperties: {}
  786. type: object
  787. properties:
  788. additionalProperties: {}
  789. type: object
  790. required:
  791. items:
  792. type: string
  793. type: array
  794. type:
  795. type: string
  796. type: object
  797. middleware.APIResponse:
  798. properties:
  799. data: {}
  800. message:
  801. type: string
  802. success:
  803. type: boolean
  804. type: object
  805. mode.Mode:
  806. enum:
  807. - 0
  808. - 1
  809. - 2
  810. - 3
  811. - 4
  812. - 5
  813. - 6
  814. - 7
  815. - 8
  816. - 9
  817. - 10
  818. - 11
  819. - 12
  820. - 13
  821. - 14
  822. - 15
  823. - 16
  824. - 17
  825. - 18
  826. - 19
  827. - 20
  828. type: integer
  829. x-enum-varnames:
  830. - Unknown
  831. - ChatCompletions
  832. - Completions
  833. - Embeddings
  834. - Moderations
  835. - ImagesGenerations
  836. - ImagesEdits
  837. - AudioSpeech
  838. - AudioTranscription
  839. - AudioTranslation
  840. - Rerank
  841. - ParsePdf
  842. - Anthropic
  843. - VideoGenerationsJobs
  844. - VideoGenerationsGetJobs
  845. - VideoGenerationsContent
  846. - Responses
  847. - ResponsesGet
  848. - ResponsesDelete
  849. - ResponsesCancel
  850. - ResponsesInputItems
  851. model.AnthropicMessageRequest:
  852. properties:
  853. messages:
  854. items:
  855. $ref: '#/definitions/model.Message'
  856. type: array
  857. model:
  858. type: string
  859. type: object
  860. model.Channel:
  861. properties:
  862. balance:
  863. type: number
  864. balance_threshold:
  865. type: number
  866. balance_updated_at:
  867. type: string
  868. base_url:
  869. type: string
  870. channel_tests:
  871. items:
  872. $ref: '#/definitions/model.ChannelTest'
  873. type: array
  874. config:
  875. $ref: '#/definitions/model.ChannelConfig'
  876. created_at:
  877. type: string
  878. enabled_auto_balance_check:
  879. type: boolean
  880. id:
  881. type: integer
  882. key:
  883. type: string
  884. last_test_error_at:
  885. type: string
  886. model_mapping:
  887. additionalProperties:
  888. type: string
  889. type: object
  890. models:
  891. items:
  892. type: string
  893. type: array
  894. name:
  895. type: string
  896. priority:
  897. type: integer
  898. request_count:
  899. type: integer
  900. retry_count:
  901. type: integer
  902. sets:
  903. items:
  904. type: string
  905. type: array
  906. status:
  907. type: integer
  908. type:
  909. $ref: '#/definitions/model.ChannelType'
  910. used_amount:
  911. type: number
  912. type: object
  913. model.ChannelConfig:
  914. properties:
  915. spec:
  916. items:
  917. type: integer
  918. type: array
  919. type: object
  920. model.ChannelTest:
  921. properties:
  922. actual_model:
  923. type: string
  924. channel_id:
  925. type: integer
  926. channel_name:
  927. type: string
  928. channel_type:
  929. $ref: '#/definitions/model.ChannelType'
  930. code:
  931. type: integer
  932. mode:
  933. $ref: '#/definitions/mode.Mode'
  934. model:
  935. type: string
  936. response:
  937. type: string
  938. success:
  939. type: boolean
  940. test_at:
  941. type: string
  942. took:
  943. type: number
  944. type: object
  945. model.ChannelType:
  946. enum:
  947. - 1
  948. - 3
  949. - 4
  950. - 12
  951. - 13
  952. - 14
  953. - 15
  954. - 16
  955. - 17
  956. - 18
  957. - 19
  958. - 20
  959. - 23
  960. - 24
  961. - 25
  962. - 26
  963. - 27
  964. - 28
  965. - 29
  966. - 30
  967. - 31
  968. - 32
  969. - 33
  970. - 34
  971. - 35
  972. - 36
  973. - 37
  974. - 40
  975. - 41
  976. - 42
  977. - 43
  978. - 44
  979. - 45
  980. - 46
  981. - 47
  982. - 48
  983. - 49
  984. type: integer
  985. x-enum-varnames:
  986. - ChannelTypeOpenAI
  987. - ChannelTypeAzure
  988. - ChannelTypeAzure2
  989. - ChannelTypeGoogleGeminiOpenAI
  990. - ChannelTypeBaiduV2
  991. - ChannelTypeAnthropic
  992. - ChannelTypeBaidu
  993. - ChannelTypeZhipu
  994. - ChannelTypeAli
  995. - ChannelTypeXunfei
  996. - ChannelTypeAI360
  997. - ChannelTypeOpenRouter
  998. - ChannelTypeTencent
  999. - ChannelTypeGoogleGemini
  1000. - ChannelTypeMoonshot
  1001. - ChannelTypeBaichuan
  1002. - ChannelTypeMinimax
  1003. - ChannelTypeMistral
  1004. - ChannelTypeGroq
  1005. - ChannelTypeOllama
  1006. - ChannelTypeLingyiwanwu
  1007. - ChannelTypeStepfun
  1008. - ChannelTypeAWS
  1009. - ChannelTypeCoze
  1010. - ChannelTypeCohere
  1011. - ChannelTypeDeepseek
  1012. - ChannelTypeCloudflare
  1013. - ChannelTypeDoubao
  1014. - ChannelTypeNovita
  1015. - ChannelTypeVertexAI
  1016. - ChannelTypeSiliconflow
  1017. - ChannelTypeDoubaoAudio
  1018. - ChannelTypeXAI
  1019. - ChannelTypeDoc2x
  1020. - ChannelTypeJina
  1021. - ChannelTypeTextEmbeddingsInference
  1022. - ChannelTypeQianfan
  1023. model.ChartData:
  1024. properties:
  1025. audio_input_tokens:
  1026. type: integer
  1027. cache_creation_tokens:
  1028. type: integer
  1029. cached_tokens:
  1030. type: integer
  1031. exception_count:
  1032. type: integer
  1033. image_input_tokens:
  1034. type: integer
  1035. input_tokens:
  1036. type: integer
  1037. output_tokens:
  1038. type: integer
  1039. reasoning_tokens:
  1040. type: integer
  1041. request_count:
  1042. type: integer
  1043. retry_count:
  1044. type: integer
  1045. status_4xx_count:
  1046. type: integer
  1047. status_500_count:
  1048. type: integer
  1049. status_5xx_count:
  1050. type: integer
  1051. status_400_count:
  1052. type: integer
  1053. status_429_count:
  1054. type: integer
  1055. timestamp:
  1056. type: integer
  1057. total_time_milliseconds:
  1058. type: integer
  1059. total_tokens:
  1060. type: integer
  1061. total_ttfb_milliseconds:
  1062. type: integer
  1063. used_amount:
  1064. type: number
  1065. web_search_count:
  1066. type: integer
  1067. type: object
  1068. model.ChatUsage:
  1069. properties:
  1070. completion_tokens:
  1071. type: integer
  1072. completion_tokens_details:
  1073. $ref: '#/definitions/model.CompletionTokensDetails'
  1074. prompt_tokens:
  1075. type: integer
  1076. prompt_tokens_details:
  1077. $ref: '#/definitions/model.PromptTokensDetails'
  1078. total_tokens:
  1079. type: integer
  1080. web_search_count:
  1081. type: integer
  1082. type: object
  1083. model.ClaudeThinkingType:
  1084. enum:
  1085. - enabled
  1086. - disabled
  1087. type: string
  1088. x-enum-varnames:
  1089. - ClaudeThinkingTypeEnabled
  1090. - ClaudeThinkingTypeDisabled
  1091. model.CompletionTokensDetails:
  1092. properties:
  1093. accepted_prediction_tokens:
  1094. type: integer
  1095. audio_tokens:
  1096. type: integer
  1097. reasoning_tokens:
  1098. type: integer
  1099. rejected_prediction_tokens:
  1100. type: integer
  1101. type: object
  1102. model.ConditionalPrice:
  1103. properties:
  1104. condition:
  1105. $ref: '#/definitions/model.PriceCondition'
  1106. price:
  1107. $ref: '#/definitions/model.Price'
  1108. type: object
  1109. model.CreateResponseRequest:
  1110. properties:
  1111. instructions:
  1112. type: string
  1113. max_output_tokens:
  1114. type: integer
  1115. messages:
  1116. items:
  1117. $ref: '#/definitions/model.Message'
  1118. type: array
  1119. metadata:
  1120. additionalProperties: {}
  1121. type: object
  1122. model:
  1123. type: string
  1124. parallel_tool_calls:
  1125. type: boolean
  1126. previous_response_id:
  1127. type: string
  1128. store:
  1129. type: boolean
  1130. stream:
  1131. type: boolean
  1132. temperature:
  1133. type: number
  1134. tool_choice: {}
  1135. tools:
  1136. items:
  1137. $ref: '#/definitions/model.Tool'
  1138. type: array
  1139. top_p:
  1140. type: number
  1141. truncation:
  1142. type: string
  1143. user:
  1144. type: string
  1145. type: object
  1146. model.DashboardResponse:
  1147. properties:
  1148. audio_input_tokens:
  1149. type: integer
  1150. cache_creation_tokens:
  1151. type: integer
  1152. cached_tokens:
  1153. type: integer
  1154. channels:
  1155. items:
  1156. type: integer
  1157. type: array
  1158. chart_data:
  1159. items:
  1160. $ref: '#/definitions/model.ChartData'
  1161. type: array
  1162. exception_count:
  1163. type: integer
  1164. image_input_tokens:
  1165. type: integer
  1166. input_tokens:
  1167. type: integer
  1168. max_rpm:
  1169. type: integer
  1170. max_tpm:
  1171. type: integer
  1172. models:
  1173. items:
  1174. type: string
  1175. type: array
  1176. output_tokens:
  1177. type: integer
  1178. reasoning_tokens:
  1179. type: integer
  1180. request_count:
  1181. type: integer
  1182. retry_count:
  1183. type: integer
  1184. rpm:
  1185. type: integer
  1186. status_400_count:
  1187. type: integer
  1188. status_429_count:
  1189. type: integer
  1190. status_4xx_count:
  1191. type: integer
  1192. status_500_count:
  1193. type: integer
  1194. status_5xx_count:
  1195. type: integer
  1196. total_count:
  1197. description: use Count.RequestCount instead
  1198. type: integer
  1199. total_time_milliseconds:
  1200. type: integer
  1201. total_tokens:
  1202. type: integer
  1203. total_ttfb_milliseconds:
  1204. type: integer
  1205. tpm:
  1206. type: integer
  1207. used_amount:
  1208. type: number
  1209. web_search_count:
  1210. type: integer
  1211. type: object
  1212. model.Document:
  1213. properties:
  1214. text:
  1215. type: string
  1216. type: object
  1217. model.EmbeddingPromptTokensDetails:
  1218. properties:
  1219. image_tokens:
  1220. type: integer
  1221. text_tokens:
  1222. type: integer
  1223. type: object
  1224. model.EmbeddingRequest:
  1225. properties:
  1226. dimensions:
  1227. type: integer
  1228. encoding_format:
  1229. type: string
  1230. input:
  1231. type: string
  1232. model:
  1233. type: string
  1234. type: object
  1235. model.EmbeddingResponse:
  1236. properties:
  1237. data:
  1238. items:
  1239. $ref: '#/definitions/model.EmbeddingResponseItem'
  1240. type: array
  1241. model:
  1242. type: string
  1243. object:
  1244. type: string
  1245. usage:
  1246. $ref: '#/definitions/model.EmbeddingUsage'
  1247. type: object
  1248. model.EmbeddingResponseItem:
  1249. properties:
  1250. embedding:
  1251. items:
  1252. type: number
  1253. type: array
  1254. index:
  1255. type: integer
  1256. object:
  1257. type: string
  1258. type: object
  1259. model.EmbeddingUsage:
  1260. properties:
  1261. prompt_tokens:
  1262. type: integer
  1263. prompt_tokens_details:
  1264. $ref: '#/definitions/model.EmbeddingPromptTokensDetails'
  1265. total_tokens:
  1266. type: integer
  1267. type: object
  1268. model.FinishReason:
  1269. enum:
  1270. - stop
  1271. - length
  1272. - content_filter
  1273. - tool_calls
  1274. - function_call
  1275. type: string
  1276. x-enum-varnames:
  1277. - FinishReasonStop
  1278. - FinishReasonLength
  1279. - FinishReasonContentFilter
  1280. - FinishReasonToolCalls
  1281. - FinishReasonFunctionCall
  1282. model.Function:
  1283. properties:
  1284. arguments:
  1285. type: string
  1286. description:
  1287. type: string
  1288. name:
  1289. type: string
  1290. parameters: {}
  1291. type: object
  1292. model.GeneralOpenAIRequest:
  1293. properties:
  1294. frequency_penalty:
  1295. type: number
  1296. function_call: {}
  1297. functions: {}
  1298. input: {}
  1299. logit_bias: {}
  1300. logprobs:
  1301. type: boolean
  1302. max_completion_tokens:
  1303. type: integer
  1304. max_tokens:
  1305. type: integer
  1306. messages:
  1307. items:
  1308. $ref: '#/definitions/model.Message'
  1309. type: array
  1310. metadata: {}
  1311. model:
  1312. type: string
  1313. num_ctx:
  1314. type: integer
  1315. presence_penalty:
  1316. type: number
  1317. prompt: {}
  1318. response_format:
  1319. $ref: '#/definitions/model.ResponseFormat'
  1320. seed:
  1321. type: number
  1322. size:
  1323. type: string
  1324. stop: {}
  1325. stream:
  1326. type: boolean
  1327. stream_options:
  1328. $ref: '#/definitions/model.StreamOptions'
  1329. temperature:
  1330. type: number
  1331. thinking:
  1332. allOf:
  1333. - $ref: '#/definitions/model.GeneralThinking'
  1334. description: aiproxy control field
  1335. tool_choice: {}
  1336. tools:
  1337. items:
  1338. $ref: '#/definitions/model.Tool'
  1339. type: array
  1340. top_k:
  1341. type: integer
  1342. top_logprobs:
  1343. type: integer
  1344. top_p:
  1345. type: number
  1346. user:
  1347. type: string
  1348. type: object
  1349. model.GeneralThinking:
  1350. properties:
  1351. budget_tokens:
  1352. description: when type is "disabled", this field must be 0
  1353. type: integer
  1354. type:
  1355. $ref: '#/definitions/model.ClaudeThinkingType'
  1356. type: object
  1357. model.GetGroupLogsResult:
  1358. properties:
  1359. channels:
  1360. items:
  1361. type: integer
  1362. type: array
  1363. logs:
  1364. items:
  1365. $ref: '#/definitions/model.Log'
  1366. type: array
  1367. models:
  1368. items:
  1369. type: string
  1370. type: array
  1371. token_names:
  1372. items:
  1373. type: string
  1374. type: array
  1375. total:
  1376. type: integer
  1377. type: object
  1378. model.GetLogsResult:
  1379. properties:
  1380. channels:
  1381. items:
  1382. type: integer
  1383. type: array
  1384. logs:
  1385. items:
  1386. $ref: '#/definitions/model.Log'
  1387. type: array
  1388. total:
  1389. type: integer
  1390. type: object
  1391. model.Group:
  1392. properties:
  1393. available_sets:
  1394. items:
  1395. type: string
  1396. type: array
  1397. balance_alert_enabled:
  1398. type: boolean
  1399. balance_alert_threshold:
  1400. type: number
  1401. created_at:
  1402. type: string
  1403. id:
  1404. type: string
  1405. request_count:
  1406. type: integer
  1407. rpm_ratio:
  1408. type: number
  1409. status:
  1410. type: integer
  1411. tpm_ratio:
  1412. type: number
  1413. used_amount:
  1414. type: number
  1415. type: object
  1416. model.GroupDashboardResponse:
  1417. properties:
  1418. audio_input_tokens:
  1419. type: integer
  1420. cache_creation_tokens:
  1421. type: integer
  1422. cached_tokens:
  1423. type: integer
  1424. channels:
  1425. items:
  1426. type: integer
  1427. type: array
  1428. chart_data:
  1429. items:
  1430. $ref: '#/definitions/model.ChartData'
  1431. type: array
  1432. exception_count:
  1433. type: integer
  1434. image_input_tokens:
  1435. type: integer
  1436. input_tokens:
  1437. type: integer
  1438. max_rpm:
  1439. type: integer
  1440. max_tpm:
  1441. type: integer
  1442. models:
  1443. items:
  1444. type: string
  1445. type: array
  1446. output_tokens:
  1447. type: integer
  1448. reasoning_tokens:
  1449. type: integer
  1450. request_count:
  1451. type: integer
  1452. retry_count:
  1453. type: integer
  1454. rpm:
  1455. type: integer
  1456. status_4xx_count:
  1457. type: integer
  1458. status_500_count:
  1459. type: integer
  1460. status_5xx_count:
  1461. type: integer
  1462. status_400_count:
  1463. type: integer
  1464. status_429_count:
  1465. type: integer
  1466. token_names:
  1467. items:
  1468. type: string
  1469. type: array
  1470. total_count:
  1471. description: use Count.RequestCount instead
  1472. type: integer
  1473. total_time_milliseconds:
  1474. type: integer
  1475. total_tokens:
  1476. type: integer
  1477. total_ttfb_milliseconds:
  1478. type: integer
  1479. tpm:
  1480. type: integer
  1481. used_amount:
  1482. type: number
  1483. web_search_count:
  1484. type: integer
  1485. type: object
  1486. model.GroupMCP:
  1487. properties:
  1488. created_at:
  1489. type: string
  1490. description:
  1491. type: string
  1492. group_id:
  1493. type: string
  1494. id:
  1495. type: string
  1496. name:
  1497. type: string
  1498. openapi_config:
  1499. $ref: '#/definitions/model.MCPOpenAPIConfig'
  1500. proxy_config:
  1501. $ref: '#/definitions/model.GroupMCPProxyConfig'
  1502. status:
  1503. $ref: '#/definitions/model.GroupMCPStatus'
  1504. type:
  1505. $ref: '#/definitions/model.GroupMCPType'
  1506. update_at:
  1507. type: string
  1508. type: object
  1509. model.GroupMCPProxyConfig:
  1510. properties:
  1511. headers:
  1512. additionalProperties:
  1513. type: string
  1514. type: object
  1515. querys:
  1516. additionalProperties:
  1517. type: string
  1518. type: object
  1519. url:
  1520. type: string
  1521. type: object
  1522. model.GroupMCPStatus:
  1523. enum:
  1524. - 1
  1525. - 2
  1526. type: integer
  1527. x-enum-varnames:
  1528. - GroupMCPStatusEnabled
  1529. - GroupMCPStatusDisabled
  1530. model.GroupMCPType:
  1531. enum:
  1532. - mcp_proxy_sse
  1533. - mcp_proxy_streamable
  1534. - mcp_openapi
  1535. type: string
  1536. x-enum-varnames:
  1537. - GroupMCPTypeProxySSE
  1538. - GroupMCPTypeProxyStreamable
  1539. - GroupMCPTypeOpenAPI
  1540. model.GroupModelConfig:
  1541. properties:
  1542. force_save_detail:
  1543. type: boolean
  1544. group_id:
  1545. type: string
  1546. image_prices:
  1547. additionalProperties:
  1548. format: float64
  1549. type: number
  1550. type: object
  1551. model:
  1552. type: string
  1553. override_force_save_detail:
  1554. type: boolean
  1555. override_limit:
  1556. type: boolean
  1557. override_price:
  1558. type: boolean
  1559. override_retry_times:
  1560. type: boolean
  1561. price:
  1562. $ref: '#/definitions/model.Price'
  1563. retry_times:
  1564. type: integer
  1565. rpm:
  1566. type: integer
  1567. tpm:
  1568. type: integer
  1569. type: object
  1570. model.ImageData:
  1571. properties:
  1572. b64_json:
  1573. type: string
  1574. revised_prompt:
  1575. type: string
  1576. url:
  1577. type: string
  1578. type: object
  1579. model.ImageInputTokensDetails:
  1580. properties:
  1581. image_tokens:
  1582. description: The number of image tokens in the input prompt.
  1583. type: integer
  1584. text_tokens:
  1585. description: The number of text tokens in the input prompt.
  1586. type: integer
  1587. type: object
  1588. model.ImageRequest:
  1589. properties:
  1590. background:
  1591. type: string
  1592. model:
  1593. type: string
  1594. moderation:
  1595. type: string
  1596. "n":
  1597. type: integer
  1598. output_compression:
  1599. type: integer
  1600. output_format:
  1601. description: png, jpeg, webp
  1602. type: string
  1603. prompt:
  1604. type: string
  1605. quality:
  1606. description: auto, high, medium, low, hd, standard
  1607. type: string
  1608. response_format:
  1609. description: url, b64_json
  1610. type: string
  1611. size:
  1612. description: 1024x1024, 1536x1024, 1024x1536, auto, 256x256, 512x512, 1792x1024,
  1613. 1024x1792
  1614. type: string
  1615. style:
  1616. description: vivid, natural
  1617. type: string
  1618. user:
  1619. type: string
  1620. type: object
  1621. model.ImageResponse:
  1622. properties:
  1623. created:
  1624. type: integer
  1625. data:
  1626. items:
  1627. $ref: '#/definitions/model.ImageData'
  1628. type: array
  1629. usage:
  1630. allOf:
  1631. - $ref: '#/definitions/model.ImageUsage'
  1632. description: For gpt-image-1 only, the token usage information for the image
  1633. generation.
  1634. type: object
  1635. model.ImageUsage:
  1636. properties:
  1637. input_tokens:
  1638. description: The number of tokens (images and text) in the input prompt.
  1639. type: integer
  1640. input_tokens_details:
  1641. allOf:
  1642. - $ref: '#/definitions/model.ImageInputTokensDetails'
  1643. description: The input tokens detailed information for the image generation.
  1644. output_tokens:
  1645. description: The number of image tokens in the output image.
  1646. type: integer
  1647. total_tokens:
  1648. description: The total number of tokens (images and text) used for the image
  1649. generation.
  1650. type: integer
  1651. type: object
  1652. model.IncompleteDetails:
  1653. properties:
  1654. reason:
  1655. type: string
  1656. type: object
  1657. model.InputContent:
  1658. properties:
  1659. text:
  1660. type: string
  1661. type:
  1662. type: string
  1663. type: object
  1664. model.InputItem:
  1665. properties:
  1666. content:
  1667. items:
  1668. $ref: '#/definitions/model.InputContent'
  1669. type: array
  1670. id:
  1671. type: string
  1672. role:
  1673. type: string
  1674. type:
  1675. type: string
  1676. type: object
  1677. model.InputItemList:
  1678. properties:
  1679. data:
  1680. items:
  1681. $ref: '#/definitions/model.InputItem'
  1682. type: array
  1683. first_id:
  1684. type: string
  1685. has_more:
  1686. type: boolean
  1687. last_id:
  1688. type: string
  1689. object:
  1690. type: string
  1691. type: object
  1692. model.JSONSchema:
  1693. properties:
  1694. description:
  1695. type: string
  1696. name:
  1697. type: string
  1698. schema:
  1699. additionalProperties: {}
  1700. type: object
  1701. strict:
  1702. type: boolean
  1703. type: object
  1704. model.Log:
  1705. properties:
  1706. channel:
  1707. type: integer
  1708. code:
  1709. type: integer
  1710. content:
  1711. type: string
  1712. created_at:
  1713. type: string
  1714. endpoint:
  1715. type: string
  1716. group:
  1717. type: string
  1718. id:
  1719. type: integer
  1720. ip:
  1721. type: string
  1722. metadata:
  1723. additionalProperties:
  1724. type: string
  1725. type: object
  1726. mode:
  1727. type: integer
  1728. model:
  1729. type: string
  1730. price:
  1731. $ref: '#/definitions/model.Price'
  1732. request_at:
  1733. type: string
  1734. request_detail:
  1735. $ref: '#/definitions/model.RequestDetail'
  1736. request_id:
  1737. type: string
  1738. retry_at:
  1739. type: string
  1740. retry_times:
  1741. type: integer
  1742. token_id:
  1743. type: integer
  1744. token_name:
  1745. type: string
  1746. ttfb_milliseconds:
  1747. type: integer
  1748. usage:
  1749. $ref: '#/definitions/model.Usage'
  1750. used_amount:
  1751. type: number
  1752. user:
  1753. description: https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids
  1754. type: string
  1755. type: object
  1756. model.MCPEmbeddingConfig:
  1757. properties:
  1758. init:
  1759. additionalProperties:
  1760. type: string
  1761. type: object
  1762. reusing:
  1763. additionalProperties:
  1764. $ref: '#/definitions/model.ReusingParam'
  1765. type: object
  1766. type: object
  1767. model.MCPOpenAPIConfig:
  1768. properties:
  1769. authorization:
  1770. type: string
  1771. openapi_content:
  1772. type: string
  1773. openapi_spec:
  1774. type: string
  1775. server_addr:
  1776. type: string
  1777. v2:
  1778. type: boolean
  1779. type: object
  1780. model.MCPPrice:
  1781. properties:
  1782. default_tools_call_price:
  1783. type: number
  1784. tools_call_prices:
  1785. additionalProperties:
  1786. format: float64
  1787. type: number
  1788. type: object
  1789. type: object
  1790. model.Message:
  1791. properties:
  1792. content: {}
  1793. name:
  1794. type: string
  1795. reasoning_content:
  1796. type: string
  1797. role:
  1798. type: string
  1799. tool_call_id:
  1800. type: string
  1801. tool_calls:
  1802. items:
  1803. $ref: '#/definitions/model.ToolCall'
  1804. type: array
  1805. type: object
  1806. model.ModelConfig:
  1807. properties:
  1808. config:
  1809. additionalProperties: {}
  1810. type: object
  1811. created_at:
  1812. type: string
  1813. exclude_from_tests:
  1814. type: boolean
  1815. force_save_detail:
  1816. type: boolean
  1817. image_prices:
  1818. additionalProperties:
  1819. format: float64
  1820. type: number
  1821. description: map[size]price_per_image
  1822. type: object
  1823. image_quality_prices:
  1824. additionalProperties:
  1825. additionalProperties:
  1826. format: float64
  1827. type: number
  1828. type: object
  1829. description: map[size]map[quality]price_per_image
  1830. type: object
  1831. max_error_rate:
  1832. type: number
  1833. model:
  1834. type: string
  1835. owner:
  1836. $ref: '#/definitions/model.ModelOwner'
  1837. plugin:
  1838. additionalProperties:
  1839. items:
  1840. type: integer
  1841. type: array
  1842. type: object
  1843. price:
  1844. $ref: '#/definitions/model.Price'
  1845. retry_times:
  1846. type: integer
  1847. rpm:
  1848. type: integer
  1849. timeout_config:
  1850. $ref: '#/definitions/model.TimeoutConfig'
  1851. tpm:
  1852. type: integer
  1853. type:
  1854. $ref: '#/definitions/mode.Mode'
  1855. updated_at:
  1856. type: string
  1857. warn_error_rate:
  1858. type: number
  1859. type: object
  1860. model.ModelOwner:
  1861. enum:
  1862. - openai
  1863. - alibaba
  1864. - tencent
  1865. - xunfei
  1866. - deepseek
  1867. - moonshot
  1868. - minimax
  1869. - baidu
  1870. - google
  1871. - baai
  1872. - funaudiollm
  1873. - doubao
  1874. - fishaudio
  1875. - chatglm
  1876. - stabilityai
  1877. - netease
  1878. - ai360
  1879. - anthropic
  1880. - meta
  1881. - baichuan
  1882. - mistral
  1883. - openchat
  1884. - microsoft
  1885. - defog
  1886. - nexusflow
  1887. - cohere
  1888. - huggingface
  1889. - lingyiwanwu
  1890. - stepfun
  1891. - xai
  1892. - doc2x
  1893. - jina
  1894. type: string
  1895. x-enum-varnames:
  1896. - ModelOwnerOpenAI
  1897. - ModelOwnerAlibaba
  1898. - ModelOwnerTencent
  1899. - ModelOwnerXunfei
  1900. - ModelOwnerDeepSeek
  1901. - ModelOwnerMoonshot
  1902. - ModelOwnerMiniMax
  1903. - ModelOwnerBaidu
  1904. - ModelOwnerGoogle
  1905. - ModelOwnerBAAI
  1906. - ModelOwnerFunAudioLLM
  1907. - ModelOwnerDoubao
  1908. - ModelOwnerFishAudio
  1909. - ModelOwnerChatGLM
  1910. - ModelOwnerStabilityAI
  1911. - ModelOwnerNetease
  1912. - ModelOwnerAI360
  1913. - ModelOwnerAnthropic
  1914. - ModelOwnerMeta
  1915. - ModelOwnerBaichuan
  1916. - ModelOwnerMistral
  1917. - ModelOwnerOpenChat
  1918. - ModelOwnerMicrosoft
  1919. - ModelOwnerDefog
  1920. - ModelOwnerNexusFlow
  1921. - ModelOwnerCohere
  1922. - ModelOwnerHuggingFace
  1923. - ModelOwnerLingyiWanwu
  1924. - ModelOwnerStepFun
  1925. - ModelOwnerXAI
  1926. - ModelOwnerDoc2x
  1927. - ModelOwnerJina
  1928. model.Option:
  1929. properties:
  1930. key:
  1931. type: string
  1932. value:
  1933. type: string
  1934. type: object
  1935. model.OutputContent:
  1936. properties:
  1937. annotations:
  1938. items: {}
  1939. type: array
  1940. text:
  1941. type: string
  1942. type:
  1943. type: string
  1944. type: object
  1945. model.OutputItem:
  1946. properties:
  1947. content:
  1948. items:
  1949. $ref: '#/definitions/model.OutputContent'
  1950. type: array
  1951. id:
  1952. type: string
  1953. role:
  1954. type: string
  1955. status:
  1956. $ref: '#/definitions/model.ResponseStatus'
  1957. type:
  1958. type: string
  1959. type: object
  1960. model.Params:
  1961. additionalProperties:
  1962. type: string
  1963. type: object
  1964. model.ParsePdfResponse:
  1965. properties:
  1966. markdown:
  1967. type: string
  1968. pages:
  1969. type: integer
  1970. type: object
  1971. model.Price:
  1972. properties:
  1973. audio_input_price:
  1974. type: number
  1975. audio_input_price_unit:
  1976. type: integer
  1977. cache_creation_price:
  1978. type: number
  1979. cache_creation_price_unit:
  1980. type: integer
  1981. cached_price:
  1982. type: number
  1983. cached_price_unit:
  1984. type: integer
  1985. conditional_prices:
  1986. items:
  1987. $ref: '#/definitions/model.ConditionalPrice'
  1988. type: array
  1989. image_input_price:
  1990. type: number
  1991. image_input_price_unit:
  1992. type: integer
  1993. input_price:
  1994. type: number
  1995. input_price_unit:
  1996. type: integer
  1997. output_price:
  1998. type: number
  1999. output_price_unit:
  2000. type: integer
  2001. per_request_price:
  2002. type: number
  2003. thinking_mode_output_price:
  2004. description: |-
  2005. when ThinkingModeOutputPrice and ReasoningTokens are not 0, OutputPrice and OutputPriceUnit
  2006. will be overwritten
  2007. type: number
  2008. thinking_mode_output_price_unit:
  2009. type: integer
  2010. web_search_price:
  2011. type: number
  2012. web_search_price_unit:
  2013. type: integer
  2014. type: object
  2015. model.PriceCondition:
  2016. properties:
  2017. input_token_max:
  2018. type: integer
  2019. input_token_min:
  2020. type: integer
  2021. output_token_max:
  2022. type: integer
  2023. output_token_min:
  2024. type: integer
  2025. type: object
  2026. model.PromptTokensDetails:
  2027. properties:
  2028. audio_tokens:
  2029. type: integer
  2030. cache_creation_tokens:
  2031. type: integer
  2032. cached_tokens:
  2033. type: integer
  2034. type: object
  2035. model.ProxyParamType:
  2036. enum:
  2037. - url
  2038. - header
  2039. - query
  2040. type: string
  2041. x-enum-varnames:
  2042. - ParamTypeURL
  2043. - ParamTypeHeader
  2044. - ParamTypeQuery
  2045. model.PublicMCP:
  2046. properties:
  2047. created_at:
  2048. type: string
  2049. description:
  2050. type: string
  2051. description_cn:
  2052. type: string
  2053. embed_config:
  2054. $ref: '#/definitions/model.MCPEmbeddingConfig'
  2055. github_url:
  2056. type: string
  2057. id:
  2058. type: string
  2059. logo_url:
  2060. type: string
  2061. name:
  2062. type: string
  2063. name_cn:
  2064. type: string
  2065. openapi_config:
  2066. $ref: '#/definitions/model.MCPOpenAPIConfig'
  2067. price:
  2068. $ref: '#/definitions/model.MCPPrice'
  2069. proxy_config:
  2070. $ref: '#/definitions/model.PublicMCPProxyConfig'
  2071. readme:
  2072. type: string
  2073. readme_cn:
  2074. type: string
  2075. readme_cn_url:
  2076. type: string
  2077. readme_url:
  2078. type: string
  2079. status:
  2080. $ref: '#/definitions/model.PublicMCPStatus'
  2081. tags:
  2082. items:
  2083. type: string
  2084. type: array
  2085. test_config:
  2086. allOf:
  2087. - $ref: '#/definitions/model.TestConfig'
  2088. description: only used by list tools
  2089. type:
  2090. $ref: '#/definitions/model.PublicMCPType'
  2091. update_at:
  2092. type: string
  2093. type: object
  2094. model.PublicMCPProxyConfig:
  2095. properties:
  2096. headers:
  2097. additionalProperties:
  2098. type: string
  2099. type: object
  2100. querys:
  2101. additionalProperties:
  2102. type: string
  2103. type: object
  2104. reusing:
  2105. additionalProperties:
  2106. $ref: '#/definitions/model.PublicMCPProxyReusingParam'
  2107. type: object
  2108. url:
  2109. type: string
  2110. type: object
  2111. model.PublicMCPProxyReusingParam:
  2112. properties:
  2113. description:
  2114. type: string
  2115. name:
  2116. type: string
  2117. required:
  2118. type: boolean
  2119. type:
  2120. $ref: '#/definitions/model.ProxyParamType'
  2121. type: object
  2122. model.PublicMCPReusingParam:
  2123. properties:
  2124. created_at:
  2125. type: string
  2126. group_id:
  2127. type: string
  2128. mcp_id:
  2129. type: string
  2130. params:
  2131. $ref: '#/definitions/model.Params'
  2132. update_at:
  2133. type: string
  2134. type: object
  2135. model.PublicMCPStatus:
  2136. enum:
  2137. - 1
  2138. - 2
  2139. type: integer
  2140. x-enum-varnames:
  2141. - PublicMCPStatusEnabled
  2142. - PublicMCPStatusDisabled
  2143. model.PublicMCPType:
  2144. enum:
  2145. - mcp_proxy_sse
  2146. - mcp_proxy_streamable
  2147. - mcp_docs
  2148. - mcp_openapi
  2149. - mcp_embed
  2150. type: string
  2151. x-enum-comments:
  2152. PublicMCPTypeDocs: read only
  2153. x-enum-descriptions:
  2154. - ""
  2155. - ""
  2156. - read only
  2157. - ""
  2158. - ""
  2159. x-enum-varnames:
  2160. - PublicMCPTypeProxySSE
  2161. - PublicMCPTypeProxyStreamable
  2162. - PublicMCPTypeDocs
  2163. - PublicMCPTypeOpenAPI
  2164. - PublicMCPTypeEmbed
  2165. model.RequestDetail:
  2166. properties:
  2167. id:
  2168. type: integer
  2169. log_id:
  2170. type: integer
  2171. request_body:
  2172. type: string
  2173. request_body_truncated:
  2174. type: boolean
  2175. response_body:
  2176. type: string
  2177. response_body_truncated:
  2178. type: boolean
  2179. type: object
  2180. model.RerankMeta:
  2181. properties:
  2182. model:
  2183. type: string
  2184. tokens:
  2185. $ref: '#/definitions/model.RerankMetaTokens'
  2186. type: object
  2187. model.RerankMetaTokens:
  2188. properties:
  2189. input_tokens:
  2190. type: integer
  2191. output_tokens:
  2192. type: integer
  2193. type: object
  2194. model.RerankRequest:
  2195. properties:
  2196. documents:
  2197. items:
  2198. type: string
  2199. type: array
  2200. max_chunks_per_doc:
  2201. type: integer
  2202. model:
  2203. type: string
  2204. overlap_tokens:
  2205. type: integer
  2206. query:
  2207. type: string
  2208. return_documents:
  2209. type: boolean
  2210. top_n:
  2211. type: integer
  2212. type: object
  2213. model.RerankResponse:
  2214. properties:
  2215. id:
  2216. type: string
  2217. meta:
  2218. $ref: '#/definitions/model.RerankMeta'
  2219. results:
  2220. items:
  2221. $ref: '#/definitions/model.RerankResult'
  2222. type: array
  2223. type: object
  2224. model.RerankResult:
  2225. properties:
  2226. document:
  2227. $ref: '#/definitions/model.Document'
  2228. index:
  2229. type: integer
  2230. relevance_score:
  2231. type: number
  2232. type: object
  2233. model.Response:
  2234. properties:
  2235. created_at:
  2236. type: integer
  2237. error:
  2238. $ref: '#/definitions/model.ResponseError'
  2239. id:
  2240. type: string
  2241. incomplete_details:
  2242. $ref: '#/definitions/model.IncompleteDetails'
  2243. instructions:
  2244. type: string
  2245. max_output_tokens:
  2246. type: integer
  2247. metadata:
  2248. additionalProperties: {}
  2249. type: object
  2250. model:
  2251. type: string
  2252. object:
  2253. type: string
  2254. output:
  2255. items:
  2256. $ref: '#/definitions/model.OutputItem'
  2257. type: array
  2258. parallel_tool_calls:
  2259. type: boolean
  2260. previous_response_id:
  2261. type: string
  2262. reasoning:
  2263. $ref: '#/definitions/model.ResponseReasoning'
  2264. status:
  2265. $ref: '#/definitions/model.ResponseStatus'
  2266. store:
  2267. type: boolean
  2268. temperature:
  2269. type: number
  2270. text:
  2271. $ref: '#/definitions/model.ResponseText'
  2272. tool_choice: {}
  2273. tools:
  2274. items:
  2275. $ref: '#/definitions/model.Tool'
  2276. type: array
  2277. top_p:
  2278. type: number
  2279. truncation:
  2280. type: string
  2281. usage:
  2282. $ref: '#/definitions/model.ResponseUsage'
  2283. user:
  2284. type: string
  2285. type: object
  2286. model.ResponseError:
  2287. properties:
  2288. code:
  2289. type: string
  2290. message:
  2291. type: string
  2292. type: object
  2293. model.ResponseFormat:
  2294. properties:
  2295. json_schema:
  2296. $ref: '#/definitions/model.JSONSchema'
  2297. type:
  2298. type: string
  2299. type: object
  2300. model.ResponseReasoning:
  2301. properties:
  2302. effort:
  2303. type: string
  2304. summary:
  2305. type: string
  2306. type: object
  2307. model.ResponseStatus:
  2308. enum:
  2309. - in_progress
  2310. - completed
  2311. - failed
  2312. - incomplete
  2313. - cancelled
  2314. type: string
  2315. x-enum-varnames:
  2316. - ResponseStatusInProgress
  2317. - ResponseStatusCompleted
  2318. - ResponseStatusFailed
  2319. - ResponseStatusIncomplete
  2320. - ResponseStatusCancelled
  2321. model.ResponseText:
  2322. properties:
  2323. format:
  2324. $ref: '#/definitions/model.ResponseTextFormat'
  2325. type: object
  2326. model.ResponseTextFormat:
  2327. properties:
  2328. type:
  2329. type: string
  2330. type: object
  2331. model.ResponseUsage:
  2332. properties:
  2333. input_tokens:
  2334. type: integer
  2335. input_tokens_details:
  2336. $ref: '#/definitions/model.ResponseUsageDetails'
  2337. output_tokens:
  2338. type: integer
  2339. output_tokens_details:
  2340. $ref: '#/definitions/model.ResponseUsageDetails'
  2341. total_tokens:
  2342. type: integer
  2343. type: object
  2344. model.ResponseUsageDetails:
  2345. properties:
  2346. cached_tokens:
  2347. type: integer
  2348. reasoning_tokens:
  2349. type: integer
  2350. type: object
  2351. model.ReusingParam:
  2352. properties:
  2353. description:
  2354. type: string
  2355. name:
  2356. type: string
  2357. required:
  2358. type: boolean
  2359. type: object
  2360. model.StreamOptions:
  2361. properties:
  2362. include_usage:
  2363. type: boolean
  2364. type: object
  2365. model.SttJSONResponse:
  2366. properties:
  2367. text:
  2368. type: string
  2369. type: object
  2370. model.SummaryDataV2:
  2371. properties:
  2372. audio_input_tokens:
  2373. type: integer
  2374. cache_creation_tokens:
  2375. type: integer
  2376. cached_tokens:
  2377. type: integer
  2378. channel_id:
  2379. type: integer
  2380. exception_count:
  2381. type: integer
  2382. group_id:
  2383. type: string
  2384. image_input_tokens:
  2385. type: integer
  2386. input_tokens:
  2387. type: integer
  2388. max_rpm:
  2389. type: integer
  2390. max_tpm:
  2391. type: integer
  2392. model:
  2393. type: string
  2394. output_tokens:
  2395. type: integer
  2396. reasoning_tokens:
  2397. type: integer
  2398. request_count:
  2399. type: integer
  2400. retry_count:
  2401. type: integer
  2402. status_5xx_count:
  2403. type: integer
  2404. status_400_count:
  2405. type: integer
  2406. status_429_count:
  2407. type: integer
  2408. status_4xx_count:
  2409. type: integer
  2410. status_500_count:
  2411. type: integer
  2412. timestamp:
  2413. type: integer
  2414. token_name:
  2415. type: string
  2416. total_time_milliseconds:
  2417. type: integer
  2418. total_tokens:
  2419. type: integer
  2420. total_ttfb_milliseconds:
  2421. type: integer
  2422. used_amount:
  2423. type: number
  2424. web_search_count:
  2425. type: integer
  2426. type: object
  2427. model.TestConfig:
  2428. properties:
  2429. enabled:
  2430. type: boolean
  2431. params:
  2432. $ref: '#/definitions/model.Params'
  2433. type: object
  2434. model.TextResponse:
  2435. properties:
  2436. choices:
  2437. items:
  2438. $ref: '#/definitions/model.TextResponseChoice'
  2439. type: array
  2440. created:
  2441. type: integer
  2442. id:
  2443. type: string
  2444. model:
  2445. type: string
  2446. object:
  2447. type: string
  2448. usage:
  2449. $ref: '#/definitions/model.ChatUsage'
  2450. type: object
  2451. model.TextResponseChoice:
  2452. properties:
  2453. finish_reason:
  2454. $ref: '#/definitions/model.FinishReason'
  2455. index:
  2456. type: integer
  2457. message:
  2458. $ref: '#/definitions/model.Message'
  2459. text:
  2460. type: string
  2461. type: object
  2462. model.TextToSpeechRequest:
  2463. properties:
  2464. input:
  2465. type: string
  2466. model:
  2467. type: string
  2468. response_format:
  2469. type: string
  2470. speed:
  2471. type: number
  2472. stream_format:
  2473. type: string
  2474. voice:
  2475. type: string
  2476. required:
  2477. - input
  2478. - model
  2479. - voice
  2480. type: object
  2481. model.TimeSummaryDataV2:
  2482. properties:
  2483. summary:
  2484. items:
  2485. $ref: '#/definitions/model.SummaryDataV2'
  2486. type: array
  2487. timestamp:
  2488. type: integer
  2489. type: object
  2490. model.TimeoutConfig:
  2491. properties:
  2492. request_timeout:
  2493. type: integer
  2494. stream_request_timeout:
  2495. type: integer
  2496. type: object
  2497. model.Tool:
  2498. properties:
  2499. function:
  2500. $ref: '#/definitions/model.Function'
  2501. type:
  2502. type: string
  2503. type: object
  2504. model.ToolCall:
  2505. properties:
  2506. function:
  2507. $ref: '#/definitions/model.Function'
  2508. id:
  2509. type: string
  2510. index:
  2511. type: integer
  2512. type:
  2513. type: string
  2514. type: object
  2515. model.UpdateGroupRequest:
  2516. properties:
  2517. available_sets:
  2518. items:
  2519. type: string
  2520. type: array
  2521. balance_alert_enabled:
  2522. type: boolean
  2523. balance_alert_threshold:
  2524. type: number
  2525. rpm_ratio:
  2526. type: number
  2527. status:
  2528. type: integer
  2529. tpm_ratio:
  2530. type: number
  2531. type: object
  2532. model.UpdateTokenRequest:
  2533. properties:
  2534. models:
  2535. items:
  2536. type: string
  2537. type: array
  2538. name:
  2539. type: string
  2540. quota:
  2541. type: number
  2542. status:
  2543. type: integer
  2544. subnets:
  2545. items:
  2546. type: string
  2547. type: array
  2548. type: object
  2549. model.Usage:
  2550. properties:
  2551. audio_input_tokens:
  2552. type: integer
  2553. cache_creation_tokens:
  2554. type: integer
  2555. cached_tokens:
  2556. type: integer
  2557. image_input_tokens:
  2558. type: integer
  2559. input_tokens:
  2560. type: integer
  2561. output_tokens:
  2562. type: integer
  2563. reasoning_tokens:
  2564. type: integer
  2565. total_tokens:
  2566. type: integer
  2567. web_search_count:
  2568. type: integer
  2569. type: object
  2570. model.VideoGenerationJob:
  2571. properties:
  2572. created_at:
  2573. type: integer
  2574. expires_at:
  2575. type: integer
  2576. finish_reason:
  2577. type: string
  2578. finished_at:
  2579. type: integer
  2580. generations:
  2581. items:
  2582. $ref: '#/definitions/model.VideoGenerations'
  2583. type: array
  2584. height:
  2585. type: integer
  2586. id:
  2587. type: string
  2588. model:
  2589. type: string
  2590. n_seconds:
  2591. type: integer
  2592. n_variants:
  2593. type: integer
  2594. object:
  2595. type: string
  2596. prompt:
  2597. type: string
  2598. status:
  2599. $ref: '#/definitions/model.VideoGenerationJobStatus'
  2600. width:
  2601. type: integer
  2602. type: object
  2603. model.VideoGenerationJobRequest:
  2604. properties:
  2605. height:
  2606. type: integer
  2607. model:
  2608. type: string
  2609. n_seconds:
  2610. type: integer
  2611. n_variants:
  2612. type: integer
  2613. prompt:
  2614. type: string
  2615. width:
  2616. type: integer
  2617. type: object
  2618. model.VideoGenerationJobStatus:
  2619. enum:
  2620. - queued
  2621. - processing
  2622. - running
  2623. - succeeded
  2624. type: string
  2625. x-enum-varnames:
  2626. - VideoGenerationJobStatusQueued
  2627. - VideoGenerationJobStatusProcessing
  2628. - VideoGenerationJobStatusRunning
  2629. - VideoGenerationJobStatusSucceeded
  2630. model.VideoGenerations:
  2631. properties:
  2632. created_at:
  2633. type: integer
  2634. height:
  2635. type: integer
  2636. id:
  2637. type: string
  2638. job_id:
  2639. type: string
  2640. n_seconds:
  2641. type: integer
  2642. object:
  2643. type: string
  2644. prompt:
  2645. type: string
  2646. width:
  2647. type: integer
  2648. type: object
  2649. openai.SubscriptionResponse:
  2650. properties:
  2651. access_until:
  2652. type: integer
  2653. hard_limit_usd:
  2654. type: number
  2655. has_payment_method:
  2656. type: boolean
  2657. object:
  2658. type: string
  2659. soft_limit_usd:
  2660. type: number
  2661. system_hard_limit_usd:
  2662. type: number
  2663. type: object
  2664. openai.UsageResponse:
  2665. properties:
  2666. object:
  2667. type: string
  2668. total_usage:
  2669. description: DailyCosts []OpenAIUsageDailyCost `json:"daily_costs"`
  2670. type: number
  2671. type: object
  2672. info:
  2673. contact: {}
  2674. title: AI Proxy Swagger API
  2675. version: "1.0"
  2676. paths:
  2677. /api/channel/:
  2678. post:
  2679. consumes:
  2680. - application/json
  2681. description: Adds a new channel to the system
  2682. parameters:
  2683. - description: Channel information
  2684. in: body
  2685. name: channel
  2686. required: true
  2687. schema:
  2688. $ref: '#/definitions/controller.AddChannelRequest'
  2689. produces:
  2690. - application/json
  2691. responses:
  2692. "200":
  2693. description: OK
  2694. schema:
  2695. $ref: '#/definitions/middleware.APIResponse'
  2696. security:
  2697. - ApiKeyAuth: []
  2698. summary: Add a single channel
  2699. tags:
  2700. - channel
  2701. /api/channel/{id}:
  2702. delete:
  2703. description: Deletes a channel by its ID
  2704. parameters:
  2705. - description: Channel ID
  2706. in: path
  2707. name: id
  2708. required: true
  2709. type: integer
  2710. produces:
  2711. - application/json
  2712. responses:
  2713. "200":
  2714. description: OK
  2715. schema:
  2716. $ref: '#/definitions/middleware.APIResponse'
  2717. security:
  2718. - ApiKeyAuth: []
  2719. summary: Delete a channel
  2720. tags:
  2721. - channel
  2722. get:
  2723. description: Returns detailed information about a specific channel
  2724. parameters:
  2725. - description: Channel ID
  2726. in: path
  2727. name: id
  2728. required: true
  2729. type: integer
  2730. produces:
  2731. - application/json
  2732. responses:
  2733. "200":
  2734. description: OK
  2735. schema:
  2736. allOf:
  2737. - $ref: '#/definitions/middleware.APIResponse'
  2738. - properties:
  2739. data:
  2740. $ref: '#/definitions/model.Channel'
  2741. type: object
  2742. security:
  2743. - ApiKeyAuth: []
  2744. summary: Get a channel by ID
  2745. tags:
  2746. - channel
  2747. put:
  2748. consumes:
  2749. - application/json
  2750. description: Updates an existing channel by its ID
  2751. parameters:
  2752. - description: Channel ID
  2753. in: path
  2754. name: id
  2755. required: true
  2756. type: integer
  2757. - description: Updated channel information
  2758. in: body
  2759. name: channel
  2760. required: true
  2761. schema:
  2762. $ref: '#/definitions/controller.AddChannelRequest'
  2763. produces:
  2764. - application/json
  2765. responses:
  2766. "200":
  2767. description: OK
  2768. schema:
  2769. allOf:
  2770. - $ref: '#/definitions/middleware.APIResponse'
  2771. - properties:
  2772. data:
  2773. $ref: '#/definitions/model.Channel'
  2774. type: object
  2775. security:
  2776. - ApiKeyAuth: []
  2777. summary: Update a channel
  2778. tags:
  2779. - channel
  2780. /api/channel/{id}/{model}:
  2781. get:
  2782. description: Tests a single model in the channel
  2783. parameters:
  2784. - description: Channel ID
  2785. in: path
  2786. name: id
  2787. required: true
  2788. type: integer
  2789. - description: Model name
  2790. in: path
  2791. name: model
  2792. required: true
  2793. type: string
  2794. produces:
  2795. - application/json
  2796. responses:
  2797. "200":
  2798. description: OK
  2799. schema:
  2800. allOf:
  2801. - $ref: '#/definitions/middleware.APIResponse'
  2802. - properties:
  2803. data:
  2804. $ref: '#/definitions/model.ChannelTest'
  2805. type: object
  2806. security:
  2807. - ApiKeyAuth: []
  2808. summary: Test channel model
  2809. tags:
  2810. - channel
  2811. /api/channel/{id}/balance:
  2812. get:
  2813. description: Updates the balance for a single channel
  2814. parameters:
  2815. - description: Channel ID
  2816. in: path
  2817. name: id
  2818. required: true
  2819. type: integer
  2820. produces:
  2821. - application/json
  2822. responses:
  2823. "200":
  2824. description: OK
  2825. schema:
  2826. allOf:
  2827. - $ref: '#/definitions/middleware.APIResponse'
  2828. - properties:
  2829. data:
  2830. format: float64
  2831. type: number
  2832. type: object
  2833. security:
  2834. - ApiKeyAuth: []
  2835. summary: Update channel balance
  2836. tags:
  2837. - channel
  2838. /api/channel/{id}/status:
  2839. post:
  2840. consumes:
  2841. - application/json
  2842. description: Updates the status of a channel by its ID
  2843. parameters:
  2844. - description: Channel ID
  2845. in: path
  2846. name: id
  2847. required: true
  2848. type: integer
  2849. - description: Status information
  2850. in: body
  2851. name: status
  2852. required: true
  2853. schema:
  2854. $ref: '#/definitions/controller.UpdateChannelStatusRequest'
  2855. produces:
  2856. - application/json
  2857. responses:
  2858. "200":
  2859. description: OK
  2860. schema:
  2861. $ref: '#/definitions/middleware.APIResponse'
  2862. security:
  2863. - ApiKeyAuth: []
  2864. summary: Update channel status
  2865. tags:
  2866. - channel
  2867. /api/channel/{id}/test:
  2868. get:
  2869. description: Tests all models in the channel
  2870. parameters:
  2871. - description: Channel ID
  2872. in: path
  2873. name: id
  2874. required: true
  2875. type: integer
  2876. - description: Return success
  2877. in: query
  2878. name: return_success
  2879. type: boolean
  2880. - description: Success body
  2881. in: query
  2882. name: success_body
  2883. type: boolean
  2884. - description: Stream
  2885. in: query
  2886. name: stream
  2887. type: boolean
  2888. produces:
  2889. - application/json
  2890. responses:
  2891. "200":
  2892. description: OK
  2893. schema:
  2894. allOf:
  2895. - $ref: '#/definitions/middleware.APIResponse'
  2896. - properties:
  2897. data:
  2898. items:
  2899. $ref: '#/definitions/controller.TestResult'
  2900. type: array
  2901. type: object
  2902. security:
  2903. - ApiKeyAuth: []
  2904. summary: Test channel models
  2905. tags:
  2906. - channel
  2907. /api/channels/:
  2908. get:
  2909. description: Returns a paginated list of channels with optional filters
  2910. parameters:
  2911. - description: Page number
  2912. in: query
  2913. name: page
  2914. type: integer
  2915. - description: Items per page
  2916. in: query
  2917. name: per_page
  2918. type: integer
  2919. - description: Filter by id
  2920. in: query
  2921. name: id
  2922. type: integer
  2923. - description: Filter by name
  2924. in: query
  2925. name: name
  2926. type: string
  2927. - description: Filter by key
  2928. in: query
  2929. name: key
  2930. type: string
  2931. - description: Filter by channel type
  2932. in: query
  2933. name: channel_type
  2934. type: integer
  2935. - description: Filter by base URL
  2936. in: query
  2937. name: base_url
  2938. type: string
  2939. - description: Order by field
  2940. in: query
  2941. name: order
  2942. type: string
  2943. produces:
  2944. - application/json
  2945. responses:
  2946. "200":
  2947. description: OK
  2948. schema:
  2949. allOf:
  2950. - $ref: '#/definitions/middleware.APIResponse'
  2951. - properties:
  2952. data:
  2953. additionalProperties:
  2954. allOf:
  2955. - {}
  2956. - properties:
  2957. channels:
  2958. items:
  2959. $ref: '#/definitions/model.Channel'
  2960. type: array
  2961. total:
  2962. type: integer
  2963. type: object
  2964. type: object
  2965. type: object
  2966. security:
  2967. - ApiKeyAuth: []
  2968. summary: Get channels with pagination
  2969. tags:
  2970. - channels
  2971. post:
  2972. consumes:
  2973. - application/json
  2974. description: Adds multiple channels in a batch operation
  2975. parameters:
  2976. - description: Channel information
  2977. in: body
  2978. name: channels
  2979. required: true
  2980. schema:
  2981. items:
  2982. $ref: '#/definitions/controller.AddChannelRequest'
  2983. type: array
  2984. produces:
  2985. - application/json
  2986. responses:
  2987. "200":
  2988. description: OK
  2989. schema:
  2990. $ref: '#/definitions/middleware.APIResponse'
  2991. security:
  2992. - ApiKeyAuth: []
  2993. summary: Add multiple channels
  2994. tags:
  2995. - channels
  2996. /api/channels/all:
  2997. get:
  2998. description: Returns a list of all channels without pagination
  2999. produces:
  3000. - application/json
  3001. responses:
  3002. "200":
  3003. description: OK
  3004. schema:
  3005. allOf:
  3006. - $ref: '#/definitions/middleware.APIResponse'
  3007. - properties:
  3008. data:
  3009. items:
  3010. $ref: '#/definitions/model.Channel'
  3011. type: array
  3012. type: object
  3013. security:
  3014. - ApiKeyAuth: []
  3015. summary: Get all channels
  3016. tags:
  3017. - channels
  3018. /api/channels/balance:
  3019. get:
  3020. description: Updates the balance for all channels
  3021. produces:
  3022. - application/json
  3023. responses:
  3024. "200":
  3025. description: OK
  3026. schema:
  3027. $ref: '#/definitions/middleware.APIResponse'
  3028. security:
  3029. - ApiKeyAuth: []
  3030. summary: Update all channels balance
  3031. tags:
  3032. - channel
  3033. /api/channels/batch_delete:
  3034. post:
  3035. consumes:
  3036. - application/json
  3037. description: Deletes multiple channels by their IDs
  3038. parameters:
  3039. - description: Channel IDs
  3040. in: body
  3041. name: ids
  3042. required: true
  3043. schema:
  3044. items:
  3045. type: integer
  3046. type: array
  3047. produces:
  3048. - application/json
  3049. responses:
  3050. "200":
  3051. description: OK
  3052. schema:
  3053. $ref: '#/definitions/middleware.APIResponse'
  3054. security:
  3055. - ApiKeyAuth: []
  3056. summary: Delete multiple channels
  3057. tags:
  3058. - channels
  3059. /api/channels/import/oneapi:
  3060. post:
  3061. description: Imports channels from OneAPI
  3062. parameters:
  3063. - description: Import channel from OneAPI request
  3064. in: body
  3065. name: request
  3066. required: true
  3067. schema:
  3068. $ref: '#/definitions/controller.ImportChannelFromOneAPIRequest'
  3069. produces:
  3070. - application/json
  3071. responses:
  3072. "200":
  3073. description: OK
  3074. schema:
  3075. allOf:
  3076. - $ref: '#/definitions/middleware.APIResponse'
  3077. - properties:
  3078. data:
  3079. items: {}
  3080. type: array
  3081. type: object
  3082. security:
  3083. - ApiKeyAuth: []
  3084. summary: Import channel from OneAPI
  3085. tags:
  3086. - channels
  3087. /api/channels/search:
  3088. get:
  3089. description: Search channels with keyword and optional filters
  3090. parameters:
  3091. - description: Search keyword
  3092. in: query
  3093. name: keyword
  3094. required: true
  3095. type: string
  3096. - description: Page number
  3097. in: query
  3098. name: page
  3099. type: integer
  3100. - description: Items per page
  3101. in: query
  3102. name: per_page
  3103. type: integer
  3104. - description: Filter by id
  3105. in: query
  3106. name: id
  3107. type: integer
  3108. - description: Filter by name
  3109. in: query
  3110. name: name
  3111. type: string
  3112. - description: Filter by key
  3113. in: query
  3114. name: key
  3115. type: string
  3116. - description: Filter by channel type
  3117. in: query
  3118. name: channel_type
  3119. type: integer
  3120. - description: Filter by base URL
  3121. in: query
  3122. name: base_url
  3123. type: string
  3124. - description: Order by field
  3125. in: query
  3126. name: order
  3127. type: string
  3128. produces:
  3129. - application/json
  3130. responses:
  3131. "200":
  3132. description: OK
  3133. schema:
  3134. allOf:
  3135. - $ref: '#/definitions/middleware.APIResponse'
  3136. - properties:
  3137. data:
  3138. additionalProperties:
  3139. allOf:
  3140. - {}
  3141. - properties:
  3142. channels:
  3143. items:
  3144. $ref: '#/definitions/model.Channel'
  3145. type: array
  3146. total:
  3147. type: integer
  3148. type: object
  3149. type: object
  3150. type: object
  3151. security:
  3152. - ApiKeyAuth: []
  3153. summary: Search channels
  3154. tags:
  3155. - channels
  3156. /api/channels/test:
  3157. get:
  3158. description: Tests all channels
  3159. parameters:
  3160. - description: Test disabled
  3161. in: query
  3162. name: test_disabled
  3163. type: boolean
  3164. - description: Return success
  3165. in: query
  3166. name: return_success
  3167. type: boolean
  3168. - description: Success body
  3169. in: query
  3170. name: success_body
  3171. type: boolean
  3172. - description: Stream
  3173. in: query
  3174. name: stream
  3175. type: boolean
  3176. produces:
  3177. - application/json
  3178. responses:
  3179. "200":
  3180. description: OK
  3181. schema:
  3182. allOf:
  3183. - $ref: '#/definitions/middleware.APIResponse'
  3184. - properties:
  3185. data:
  3186. items:
  3187. $ref: '#/definitions/controller.TestResult'
  3188. type: array
  3189. type: object
  3190. security:
  3191. - ApiKeyAuth: []
  3192. summary: Test all channels
  3193. tags:
  3194. - channel
  3195. /api/channels/type_metas:
  3196. get:
  3197. description: Returns metadata for all channel types
  3198. produces:
  3199. - application/json
  3200. responses:
  3201. "200":
  3202. description: OK
  3203. schema:
  3204. allOf:
  3205. - $ref: '#/definitions/middleware.APIResponse'
  3206. - properties:
  3207. data:
  3208. additionalProperties:
  3209. $ref: '#/definitions/adaptors.AdaptorMeta'
  3210. type: object
  3211. type: object
  3212. security:
  3213. - ApiKeyAuth: []
  3214. summary: Get channel type metadata
  3215. tags:
  3216. - channels
  3217. /api/dashboard/:
  3218. get:
  3219. description: Returns the general dashboard data including usage statistics and
  3220. metrics
  3221. parameters:
  3222. - description: Channel ID
  3223. in: query
  3224. name: channel
  3225. type: integer
  3226. - description: Model name
  3227. in: query
  3228. name: model
  3229. type: string
  3230. - description: Start second timestamp
  3231. format: int64
  3232. in: query
  3233. name: start_timestamp
  3234. type: integer
  3235. - description: End second timestamp
  3236. format: int64
  3237. in: query
  3238. name: end_timestamp
  3239. type: integer
  3240. - description: Timezone, default is Local
  3241. in: query
  3242. name: timezone
  3243. type: string
  3244. - description: Time span type (minute, hour, day, month)
  3245. in: query
  3246. name: timespan
  3247. type: string
  3248. produces:
  3249. - application/json
  3250. responses:
  3251. "200":
  3252. description: OK
  3253. schema:
  3254. allOf:
  3255. - $ref: '#/definitions/middleware.APIResponse'
  3256. - properties:
  3257. data:
  3258. $ref: '#/definitions/model.DashboardResponse'
  3259. type: object
  3260. security:
  3261. - ApiKeyAuth: []
  3262. summary: Get dashboard data
  3263. tags:
  3264. - dashboard
  3265. /api/dashboard/{group}:
  3266. get:
  3267. description: Returns dashboard data and metrics specific to the given group
  3268. parameters:
  3269. - description: Group
  3270. in: path
  3271. name: group
  3272. required: true
  3273. type: string
  3274. - description: Token name
  3275. in: query
  3276. name: token_name
  3277. type: string
  3278. - description: Model or *
  3279. in: query
  3280. name: model
  3281. type: string
  3282. - description: Start second timestamp
  3283. format: int64
  3284. in: query
  3285. name: start_timestamp
  3286. type: integer
  3287. - description: End second timestamp
  3288. format: int64
  3289. in: query
  3290. name: end_timestamp
  3291. type: integer
  3292. - description: Timezone, default is Local
  3293. in: query
  3294. name: timezone
  3295. type: string
  3296. - description: Time span type (minute, hour, day, month)
  3297. in: query
  3298. name: timespan
  3299. type: string
  3300. produces:
  3301. - application/json
  3302. responses:
  3303. "200":
  3304. description: OK
  3305. schema:
  3306. allOf:
  3307. - $ref: '#/definitions/middleware.APIResponse'
  3308. - properties:
  3309. data:
  3310. $ref: '#/definitions/model.GroupDashboardResponse'
  3311. type: object
  3312. security:
  3313. - ApiKeyAuth: []
  3314. summary: Get dashboard data for a specific group
  3315. tags:
  3316. - dashboard
  3317. /api/dashboard/{group}/models:
  3318. get:
  3319. description: Returns model-specific metrics and usage data for the given group
  3320. parameters:
  3321. - description: Group
  3322. in: path
  3323. name: group
  3324. required: true
  3325. type: string
  3326. produces:
  3327. - application/json
  3328. responses:
  3329. "200":
  3330. description: OK
  3331. schema:
  3332. allOf:
  3333. - $ref: '#/definitions/middleware.APIResponse'
  3334. - properties:
  3335. data:
  3336. items:
  3337. $ref: '#/definitions/controller.GroupModel'
  3338. type: array
  3339. type: object
  3340. security:
  3341. - ApiKeyAuth: []
  3342. summary: Get model usage data for a specific group
  3343. tags:
  3344. - dashboard
  3345. /api/dashboardv2/:
  3346. get:
  3347. description: Returns model-specific metrics and usage data for the given channel
  3348. parameters:
  3349. - description: Channel ID
  3350. in: query
  3351. name: channel
  3352. type: integer
  3353. - description: Model name
  3354. in: query
  3355. name: model
  3356. type: string
  3357. - description: Start timestamp
  3358. format: int64
  3359. in: query
  3360. name: start_timestamp
  3361. type: integer
  3362. - description: End timestamp
  3363. format: int64
  3364. in: query
  3365. name: end_timestamp
  3366. type: integer
  3367. - description: Timezone, default is Local
  3368. in: query
  3369. name: timezone
  3370. type: string
  3371. - description: Time span type (minute, hour, day, month)
  3372. in: query
  3373. name: timespan
  3374. type: string
  3375. produces:
  3376. - application/json
  3377. responses:
  3378. "200":
  3379. description: OK
  3380. schema:
  3381. allOf:
  3382. - $ref: '#/definitions/middleware.APIResponse'
  3383. - properties:
  3384. data:
  3385. items:
  3386. $ref: '#/definitions/model.TimeSummaryDataV2'
  3387. type: array
  3388. type: object
  3389. security:
  3390. - ApiKeyAuth: []
  3391. summary: Get model usage data for a specific channel
  3392. tags:
  3393. - dashboard
  3394. /api/dashboardv2/{group}:
  3395. get:
  3396. description: Returns model-specific metrics and usage data for the given group
  3397. parameters:
  3398. - description: Group
  3399. in: path
  3400. name: group
  3401. required: true
  3402. type: string
  3403. - description: Token name
  3404. in: query
  3405. name: token_name
  3406. type: string
  3407. - description: Model name
  3408. in: query
  3409. name: model
  3410. type: string
  3411. - description: Start timestamp
  3412. format: int64
  3413. in: query
  3414. name: start_timestamp
  3415. type: integer
  3416. - description: End timestamp
  3417. format: int64
  3418. in: query
  3419. name: end_timestamp
  3420. type: integer
  3421. - description: Timezone, default is Local
  3422. in: query
  3423. name: timezone
  3424. type: string
  3425. - description: Time span type (minute, hour, day, month)
  3426. in: query
  3427. name: timespan
  3428. type: string
  3429. produces:
  3430. - application/json
  3431. responses:
  3432. "200":
  3433. description: OK
  3434. schema:
  3435. allOf:
  3436. - $ref: '#/definitions/middleware.APIResponse'
  3437. - properties:
  3438. data:
  3439. items:
  3440. $ref: '#/definitions/model.TimeSummaryDataV2'
  3441. type: array
  3442. type: object
  3443. security:
  3444. - ApiKeyAuth: []
  3445. summary: Get model usage data for a specific group
  3446. tags:
  3447. - dashboard
  3448. /api/embedmcp/:
  3449. get:
  3450. consumes:
  3451. - application/json
  3452. description: Get embed mcp
  3453. produces:
  3454. - application/json
  3455. responses:
  3456. "200":
  3457. description: OK
  3458. schema:
  3459. items:
  3460. $ref: '#/definitions/controller.EmbedMCP'
  3461. type: array
  3462. security:
  3463. - ApiKeyAuth: []
  3464. summary: Get embed mcp
  3465. tags:
  3466. - embedmcp
  3467. post:
  3468. consumes:
  3469. - application/json
  3470. description: Save embed mcp
  3471. parameters:
  3472. - description: Save embed mcp request
  3473. in: body
  3474. name: body
  3475. required: true
  3476. schema:
  3477. $ref: '#/definitions/controller.SaveEmbedMCPRequest'
  3478. produces:
  3479. - application/json
  3480. responses:
  3481. "200":
  3482. description: OK
  3483. security:
  3484. - ApiKeyAuth: []
  3485. summary: Save embed mcp
  3486. tags:
  3487. - embedmcp
  3488. /api/group/{group}:
  3489. delete:
  3490. description: Deletes a group by its name
  3491. parameters:
  3492. - description: Group name
  3493. in: path
  3494. name: group
  3495. required: true
  3496. type: string
  3497. produces:
  3498. - application/json
  3499. responses:
  3500. "200":
  3501. description: OK
  3502. schema:
  3503. $ref: '#/definitions/middleware.APIResponse'
  3504. security:
  3505. - ApiKeyAuth: []
  3506. summary: Delete a group
  3507. tags:
  3508. - group
  3509. get:
  3510. description: Returns detailed information about a specific group
  3511. parameters:
  3512. - description: Group name
  3513. in: path
  3514. name: group
  3515. required: true
  3516. type: string
  3517. produces:
  3518. - application/json
  3519. responses:
  3520. "200":
  3521. description: OK
  3522. schema:
  3523. allOf:
  3524. - $ref: '#/definitions/middleware.APIResponse'
  3525. - properties:
  3526. data:
  3527. $ref: '#/definitions/controller.GroupResponse'
  3528. type: object
  3529. security:
  3530. - ApiKeyAuth: []
  3531. summary: Get a group
  3532. tags:
  3533. - group
  3534. post:
  3535. consumes:
  3536. - application/json
  3537. description: Creates a new group with the given information
  3538. parameters:
  3539. - description: Group name
  3540. in: path
  3541. name: group
  3542. required: true
  3543. type: string
  3544. - description: Group information
  3545. in: body
  3546. name: data
  3547. required: true
  3548. schema:
  3549. $ref: '#/definitions/controller.CreateGroupRequest'
  3550. produces:
  3551. - application/json
  3552. responses:
  3553. "200":
  3554. description: OK
  3555. schema:
  3556. allOf:
  3557. - $ref: '#/definitions/middleware.APIResponse'
  3558. - properties:
  3559. data:
  3560. $ref: '#/definitions/model.Group'
  3561. type: object
  3562. security:
  3563. - ApiKeyAuth: []
  3564. summary: Create a new group
  3565. tags:
  3566. - group
  3567. put:
  3568. consumes:
  3569. - application/json
  3570. description: Updates an existing group with the given information
  3571. parameters:
  3572. - description: Group name
  3573. in: path
  3574. name: group
  3575. required: true
  3576. type: string
  3577. - description: Updated group information
  3578. in: body
  3579. name: data
  3580. required: true
  3581. schema:
  3582. $ref: '#/definitions/model.UpdateGroupRequest'
  3583. produces:
  3584. - application/json
  3585. responses:
  3586. "200":
  3587. description: OK
  3588. schema:
  3589. allOf:
  3590. - $ref: '#/definitions/middleware.APIResponse'
  3591. - properties:
  3592. data:
  3593. $ref: '#/definitions/model.Group'
  3594. type: object
  3595. security:
  3596. - ApiKeyAuth: []
  3597. summary: Update a group
  3598. tags:
  3599. - group
  3600. /api/group/{group}/mcp:
  3601. get:
  3602. description: Get MCPs by group
  3603. parameters:
  3604. - description: Group ID
  3605. in: path
  3606. name: group
  3607. required: true
  3608. type: string
  3609. - description: Page
  3610. in: query
  3611. name: page
  3612. type: integer
  3613. - description: Per Page
  3614. in: query
  3615. name: per_page
  3616. type: integer
  3617. - description: MCP ID
  3618. in: query
  3619. name: id
  3620. type: string
  3621. - description: hosted or local
  3622. in: query
  3623. name: type
  3624. type: string
  3625. - description: Keyword
  3626. in: query
  3627. name: keyword
  3628. type: string
  3629. produces:
  3630. - application/json
  3631. responses:
  3632. "200":
  3633. description: OK
  3634. schema:
  3635. allOf:
  3636. - $ref: '#/definitions/middleware.APIResponse'
  3637. - properties:
  3638. data:
  3639. items:
  3640. $ref: '#/definitions/controller.GroupPublicMCPResponse'
  3641. type: array
  3642. type: object
  3643. security:
  3644. - ApiKeyAuth: []
  3645. summary: Get MCPs by group
  3646. tags:
  3647. - mcp
  3648. - group
  3649. /api/group/{group}/mcp/{id}:
  3650. get:
  3651. description: Get a specific MCP by its ID
  3652. parameters:
  3653. - description: Group ID
  3654. in: path
  3655. name: group
  3656. required: true
  3657. type: string
  3658. - description: MCP ID
  3659. in: path
  3660. name: id
  3661. required: true
  3662. type: string
  3663. produces:
  3664. - application/json
  3665. responses:
  3666. "200":
  3667. description: OK
  3668. schema:
  3669. allOf:
  3670. - $ref: '#/definitions/middleware.APIResponse'
  3671. - properties:
  3672. data:
  3673. $ref: '#/definitions/controller.GroupPublicMCPDetailResponse'
  3674. type: object
  3675. security:
  3676. - ApiKeyAuth: []
  3677. summary: Get MCP by ID
  3678. tags:
  3679. - mcp
  3680. - group
  3681. /api/group/{group}/model_config/{model}:
  3682. delete:
  3683. description: Delete group model config
  3684. parameters:
  3685. - description: Group name
  3686. in: path
  3687. name: group
  3688. required: true
  3689. type: string
  3690. - description: Model name
  3691. in: path
  3692. name: model
  3693. required: true
  3694. type: string
  3695. produces:
  3696. - application/json
  3697. responses:
  3698. "200":
  3699. description: OK
  3700. schema:
  3701. $ref: '#/definitions/middleware.APIResponse'
  3702. security:
  3703. - ApiKeyAuth: []
  3704. summary: Delete group model config
  3705. tags:
  3706. - group
  3707. get:
  3708. description: Get group model config
  3709. parameters:
  3710. - description: Group name
  3711. in: path
  3712. name: group
  3713. required: true
  3714. type: string
  3715. - description: Model name
  3716. in: path
  3717. name: model
  3718. required: true
  3719. type: string
  3720. produces:
  3721. - application/json
  3722. responses:
  3723. "200":
  3724. description: OK
  3725. schema:
  3726. allOf:
  3727. - $ref: '#/definitions/middleware.APIResponse'
  3728. - properties:
  3729. data:
  3730. $ref: '#/definitions/model.GroupModelConfig'
  3731. type: object
  3732. security:
  3733. - ApiKeyAuth: []
  3734. summary: Get group model config
  3735. tags:
  3736. - group
  3737. post:
  3738. consumes:
  3739. - application/json
  3740. description: Save group model config
  3741. parameters:
  3742. - description: Group name
  3743. in: path
  3744. name: group
  3745. required: true
  3746. type: string
  3747. - description: Group model config information
  3748. in: body
  3749. name: data
  3750. required: true
  3751. schema:
  3752. $ref: '#/definitions/controller.SaveGroupModelConfigRequest'
  3753. produces:
  3754. - application/json
  3755. responses:
  3756. "200":
  3757. description: OK
  3758. schema:
  3759. $ref: '#/definitions/middleware.APIResponse'
  3760. security:
  3761. - ApiKeyAuth: []
  3762. summary: Save group model config
  3763. tags:
  3764. - group
  3765. put:
  3766. consumes:
  3767. - application/json
  3768. description: Update group model config
  3769. parameters:
  3770. - description: Group name
  3771. in: path
  3772. name: group
  3773. required: true
  3774. type: string
  3775. - description: Model name
  3776. in: path
  3777. name: model
  3778. required: true
  3779. type: string
  3780. - description: Group model config information
  3781. in: body
  3782. name: data
  3783. required: true
  3784. schema:
  3785. $ref: '#/definitions/controller.SaveGroupModelConfigRequest'
  3786. produces:
  3787. - application/json
  3788. responses:
  3789. "200":
  3790. description: OK
  3791. schema:
  3792. $ref: '#/definitions/middleware.APIResponse'
  3793. security:
  3794. - ApiKeyAuth: []
  3795. summary: Update group model config
  3796. tags:
  3797. - group
  3798. /api/group/{group}/model_configs/:
  3799. delete:
  3800. description: Delete group model configs
  3801. parameters:
  3802. - description: Group name
  3803. in: path
  3804. name: group
  3805. required: true
  3806. type: string
  3807. - description: Model names
  3808. in: body
  3809. name: models
  3810. required: true
  3811. schema:
  3812. items:
  3813. type: string
  3814. type: array
  3815. produces:
  3816. - application/json
  3817. responses:
  3818. "200":
  3819. description: OK
  3820. schema:
  3821. $ref: '#/definitions/middleware.APIResponse'
  3822. security:
  3823. - ApiKeyAuth: []
  3824. summary: Delete group model configs
  3825. tags:
  3826. - group
  3827. get:
  3828. description: Get group model configs
  3829. parameters:
  3830. - description: Group name
  3831. in: path
  3832. name: group
  3833. required: true
  3834. type: string
  3835. produces:
  3836. - application/json
  3837. responses:
  3838. "200":
  3839. description: OK
  3840. schema:
  3841. allOf:
  3842. - $ref: '#/definitions/middleware.APIResponse'
  3843. - properties:
  3844. data:
  3845. items:
  3846. $ref: '#/definitions/model.GroupModelConfig'
  3847. type: array
  3848. type: object
  3849. security:
  3850. - ApiKeyAuth: []
  3851. summary: Get group model configs
  3852. tags:
  3853. - group
  3854. post:
  3855. consumes:
  3856. - application/json
  3857. description: Save group model configs
  3858. parameters:
  3859. - description: Group name
  3860. in: path
  3861. name: group
  3862. required: true
  3863. type: string
  3864. - description: Group model config information
  3865. in: body
  3866. name: data
  3867. required: true
  3868. schema:
  3869. items:
  3870. $ref: '#/definitions/controller.SaveGroupModelConfigRequest'
  3871. type: array
  3872. produces:
  3873. - application/json
  3874. responses:
  3875. "200":
  3876. description: OK
  3877. schema:
  3878. $ref: '#/definitions/middleware.APIResponse'
  3879. security:
  3880. - ApiKeyAuth: []
  3881. summary: Save group model configs
  3882. tags:
  3883. - group
  3884. put:
  3885. consumes:
  3886. - application/json
  3887. description: Update group model configs
  3888. parameters:
  3889. - description: Group name
  3890. in: path
  3891. name: group
  3892. required: true
  3893. type: string
  3894. - description: Group model config information
  3895. in: body
  3896. name: data
  3897. required: true
  3898. schema:
  3899. items:
  3900. $ref: '#/definitions/controller.SaveGroupModelConfigRequest'
  3901. type: array
  3902. produces:
  3903. - application/json
  3904. responses:
  3905. "200":
  3906. description: OK
  3907. schema:
  3908. $ref: '#/definitions/middleware.APIResponse'
  3909. security:
  3910. - ApiKeyAuth: []
  3911. summary: Update group model configs
  3912. tags:
  3913. - group
  3914. /api/group/{group}/rpm_ratio:
  3915. post:
  3916. consumes:
  3917. - application/json
  3918. description: Updates the RPM (Requests Per Minute) ratio for a group
  3919. parameters:
  3920. - description: Group name
  3921. in: path
  3922. name: group
  3923. required: true
  3924. type: string
  3925. - description: RPM ratio information
  3926. in: body
  3927. name: data
  3928. required: true
  3929. schema:
  3930. $ref: '#/definitions/controller.UpdateGroupRPMRatioRequest'
  3931. produces:
  3932. - application/json
  3933. responses:
  3934. "200":
  3935. description: OK
  3936. schema:
  3937. $ref: '#/definitions/middleware.APIResponse'
  3938. security:
  3939. - ApiKeyAuth: []
  3940. summary: Update group RPM ratio
  3941. tags:
  3942. - group
  3943. /api/group/{group}/status:
  3944. post:
  3945. consumes:
  3946. - application/json
  3947. description: Updates the status of a group
  3948. parameters:
  3949. - description: Group name
  3950. in: path
  3951. name: group
  3952. required: true
  3953. type: string
  3954. - description: Status information
  3955. in: body
  3956. name: status
  3957. required: true
  3958. schema:
  3959. $ref: '#/definitions/controller.UpdateGroupStatusRequest'
  3960. produces:
  3961. - application/json
  3962. responses:
  3963. "200":
  3964. description: OK
  3965. schema:
  3966. $ref: '#/definitions/middleware.APIResponse'
  3967. security:
  3968. - ApiKeyAuth: []
  3969. summary: Update group status
  3970. tags:
  3971. - group
  3972. /api/group/{group}/tpm_ratio:
  3973. post:
  3974. consumes:
  3975. - application/json
  3976. description: Updates the TPM (Tokens Per Minute) ratio for a group
  3977. parameters:
  3978. - description: Group name
  3979. in: path
  3980. name: group
  3981. required: true
  3982. type: string
  3983. - description: TPM ratio information
  3984. in: body
  3985. name: data
  3986. required: true
  3987. schema:
  3988. $ref: '#/definitions/controller.UpdateGroupTPMRatioRequest'
  3989. produces:
  3990. - application/json
  3991. responses:
  3992. "200":
  3993. description: OK
  3994. schema:
  3995. $ref: '#/definitions/middleware.APIResponse'
  3996. security:
  3997. - ApiKeyAuth: []
  3998. summary: Update group TPM ratio
  3999. tags:
  4000. - group
  4001. /api/groups/:
  4002. get:
  4003. description: Returns a list of all groups with pagination
  4004. parameters:
  4005. - description: Page number
  4006. in: query
  4007. name: page
  4008. type: integer
  4009. - description: Items per page
  4010. in: query
  4011. name: per_page
  4012. type: integer
  4013. produces:
  4014. - application/json
  4015. responses:
  4016. "200":
  4017. description: OK
  4018. schema:
  4019. allOf:
  4020. - $ref: '#/definitions/middleware.APIResponse'
  4021. - properties:
  4022. data:
  4023. additionalProperties:
  4024. allOf:
  4025. - {}
  4026. - properties:
  4027. groups:
  4028. items:
  4029. $ref: '#/definitions/controller.GroupResponse'
  4030. type: array
  4031. total:
  4032. type: integer
  4033. type: object
  4034. type: object
  4035. type: object
  4036. security:
  4037. - ApiKeyAuth: []
  4038. summary: Get all groups
  4039. tags:
  4040. - groups
  4041. /api/groups/batch_delete:
  4042. post:
  4043. consumes:
  4044. - application/json
  4045. description: Deletes multiple groups by their IDs
  4046. parameters:
  4047. - description: Group IDs
  4048. in: body
  4049. name: ids
  4050. required: true
  4051. schema:
  4052. items:
  4053. type: string
  4054. type: array
  4055. produces:
  4056. - application/json
  4057. responses:
  4058. "200":
  4059. description: OK
  4060. schema:
  4061. $ref: '#/definitions/middleware.APIResponse'
  4062. security:
  4063. - ApiKeyAuth: []
  4064. summary: Delete multiple groups
  4065. tags:
  4066. - groups
  4067. /api/groups/batch_status:
  4068. post:
  4069. consumes:
  4070. - application/json
  4071. description: Updates the status of multiple groups
  4072. parameters:
  4073. - description: Group IDs and status
  4074. in: body
  4075. name: data
  4076. required: true
  4077. schema:
  4078. $ref: '#/definitions/controller.UpdateGroupsStatusRequest'
  4079. produces:
  4080. - application/json
  4081. responses:
  4082. "200":
  4083. description: OK
  4084. schema:
  4085. $ref: '#/definitions/middleware.APIResponse'
  4086. security:
  4087. - ApiKeyAuth: []
  4088. summary: Update multiple groups status
  4089. tags:
  4090. - groups
  4091. /api/groups/ip_groups:
  4092. get:
  4093. description: Get IP group list
  4094. parameters:
  4095. - description: Threshold
  4096. in: query
  4097. name: threshold
  4098. type: integer
  4099. - description: Start timestamp
  4100. in: query
  4101. name: start_timestamp
  4102. type: integer
  4103. - description: End timestamp
  4104. in: query
  4105. name: end_timestamp
  4106. type: integer
  4107. produces:
  4108. - application/json
  4109. responses:
  4110. "200":
  4111. description: OK
  4112. schema:
  4113. allOf:
  4114. - $ref: '#/definitions/middleware.APIResponse'
  4115. - properties:
  4116. data:
  4117. additionalProperties:
  4118. items:
  4119. type: string
  4120. type: array
  4121. type: object
  4122. type: object
  4123. security:
  4124. - ApiKeyAuth: []
  4125. summary: Get IP group list
  4126. tags:
  4127. - groups
  4128. /api/groups/search:
  4129. get:
  4130. description: Search groups with keyword and pagination
  4131. parameters:
  4132. - description: Search keyword
  4133. in: query
  4134. name: keyword
  4135. required: true
  4136. type: string
  4137. - description: Page number
  4138. in: query
  4139. name: page
  4140. type: integer
  4141. - description: Items per page
  4142. in: query
  4143. name: per_page
  4144. type: integer
  4145. - description: Status
  4146. in: query
  4147. name: status
  4148. type: integer
  4149. - description: Order
  4150. in: query
  4151. name: order
  4152. type: string
  4153. produces:
  4154. - application/json
  4155. responses:
  4156. "200":
  4157. description: OK
  4158. schema:
  4159. allOf:
  4160. - $ref: '#/definitions/middleware.APIResponse'
  4161. - properties:
  4162. data:
  4163. additionalProperties:
  4164. allOf:
  4165. - {}
  4166. - properties:
  4167. groups:
  4168. items:
  4169. $ref: '#/definitions/controller.GroupResponse'
  4170. type: array
  4171. total:
  4172. type: integer
  4173. type: object
  4174. type: object
  4175. type: object
  4176. security:
  4177. - ApiKeyAuth: []
  4178. summary: Search groups
  4179. tags:
  4180. - groups
  4181. /api/log/{group}:
  4182. get:
  4183. description: Get logs for a specific group
  4184. parameters:
  4185. - description: Group name
  4186. in: path
  4187. name: group
  4188. required: true
  4189. type: string
  4190. - description: Page number
  4191. in: query
  4192. name: page
  4193. type: integer
  4194. - description: Items per page
  4195. in: query
  4196. name: per_page
  4197. type: integer
  4198. - description: Start timestamp (milliseconds)
  4199. in: query
  4200. name: start_timestamp
  4201. type: integer
  4202. - description: End timestamp (milliseconds)
  4203. in: query
  4204. name: end_timestamp
  4205. type: integer
  4206. - description: Token name
  4207. in: query
  4208. name: token_name
  4209. type: string
  4210. - description: Model name
  4211. in: query
  4212. name: model_name
  4213. type: string
  4214. - description: Channel ID
  4215. in: query
  4216. name: channel
  4217. type: integer
  4218. - description: Token ID
  4219. in: query
  4220. name: token_id
  4221. type: integer
  4222. - description: Order
  4223. in: query
  4224. name: order
  4225. type: string
  4226. - description: Request ID
  4227. in: query
  4228. name: request_id
  4229. type: string
  4230. - description: Status code type
  4231. in: query
  4232. name: code_type
  4233. type: string
  4234. - description: Status code
  4235. in: query
  4236. name: code
  4237. type: integer
  4238. - description: With body
  4239. in: query
  4240. name: with_body
  4241. type: boolean
  4242. - description: IP
  4243. in: query
  4244. name: ip
  4245. type: string
  4246. - description: User
  4247. in: query
  4248. name: user
  4249. type: string
  4250. produces:
  4251. - application/json
  4252. responses:
  4253. "200":
  4254. description: OK
  4255. schema:
  4256. allOf:
  4257. - $ref: '#/definitions/middleware.APIResponse'
  4258. - properties:
  4259. data:
  4260. $ref: '#/definitions/model.GetGroupLogsResult'
  4261. type: object
  4262. security:
  4263. - ApiKeyAuth: []
  4264. summary: Get group logs
  4265. tags:
  4266. - log
  4267. /api/log/{group}/detail/{log_id}:
  4268. get:
  4269. description: Get detailed information about a specific log entry in a group
  4270. parameters:
  4271. - description: Group name
  4272. in: path
  4273. name: group
  4274. required: true
  4275. type: string
  4276. - description: Log ID
  4277. in: path
  4278. name: log_id
  4279. required: true
  4280. type: string
  4281. produces:
  4282. - application/json
  4283. responses:
  4284. "200":
  4285. description: OK
  4286. schema:
  4287. allOf:
  4288. - $ref: '#/definitions/middleware.APIResponse'
  4289. - properties:
  4290. data:
  4291. $ref: '#/definitions/model.RequestDetail'
  4292. type: object
  4293. security:
  4294. - ApiKeyAuth: []
  4295. summary: Get group log detail
  4296. tags:
  4297. - log
  4298. /api/log/{group}/search:
  4299. get:
  4300. description: Search logs for a specific group with filters
  4301. parameters:
  4302. - description: Group name
  4303. in: path
  4304. name: group
  4305. required: true
  4306. type: string
  4307. - description: Keyword
  4308. in: query
  4309. name: keyword
  4310. type: string
  4311. - description: Page number
  4312. in: query
  4313. name: page
  4314. type: integer
  4315. - description: Items per page
  4316. in: query
  4317. name: per_page
  4318. type: integer
  4319. - description: Start timestamp (milliseconds)
  4320. in: query
  4321. name: start_timestamp
  4322. type: integer
  4323. - description: End timestamp (milliseconds)
  4324. in: query
  4325. name: end_timestamp
  4326. type: integer
  4327. - description: Filter by token name
  4328. in: query
  4329. name: token_name
  4330. type: string
  4331. - description: Filter by model name
  4332. in: query
  4333. name: model_name
  4334. type: string
  4335. - description: Filter by token id
  4336. in: query
  4337. name: token_id
  4338. type: integer
  4339. - description: Order
  4340. in: query
  4341. name: order
  4342. type: string
  4343. - description: Request ID
  4344. in: query
  4345. name: request_id
  4346. type: string
  4347. - description: Status code type
  4348. in: query
  4349. name: code_type
  4350. type: string
  4351. - description: Status code
  4352. in: query
  4353. name: code
  4354. type: integer
  4355. - description: With body
  4356. in: query
  4357. name: with_body
  4358. type: boolean
  4359. - description: IP
  4360. in: query
  4361. name: ip
  4362. type: string
  4363. - description: User
  4364. in: query
  4365. name: user
  4366. type: string
  4367. produces:
  4368. - application/json
  4369. responses:
  4370. "200":
  4371. description: OK
  4372. schema:
  4373. allOf:
  4374. - $ref: '#/definitions/middleware.APIResponse'
  4375. - properties:
  4376. data:
  4377. $ref: '#/definitions/model.GetGroupLogsResult'
  4378. type: object
  4379. security:
  4380. - ApiKeyAuth: []
  4381. summary: Search group logs
  4382. tags:
  4383. - log
  4384. /api/logs/:
  4385. delete:
  4386. description: Deletes logs older than the specified retention period
  4387. parameters:
  4388. - description: Timestamp (milliseconds)
  4389. in: query
  4390. name: timestamp
  4391. required: true
  4392. type: integer
  4393. produces:
  4394. - application/json
  4395. responses:
  4396. "200":
  4397. description: OK
  4398. schema:
  4399. allOf:
  4400. - $ref: '#/definitions/middleware.APIResponse'
  4401. - properties:
  4402. data:
  4403. type: integer
  4404. type: object
  4405. security:
  4406. - ApiKeyAuth: []
  4407. summary: Delete historical logs
  4408. tags:
  4409. - logs
  4410. get:
  4411. description: Returns a paginated list of all logs with optional filters
  4412. parameters:
  4413. - description: Page number
  4414. in: query
  4415. name: page
  4416. type: integer
  4417. - description: Items per page
  4418. in: query
  4419. name: per_page
  4420. type: integer
  4421. - description: Start timestamp (milliseconds)
  4422. in: query
  4423. name: start_timestamp
  4424. type: integer
  4425. - description: End timestamp (milliseconds)
  4426. in: query
  4427. name: end_timestamp
  4428. type: integer
  4429. - description: Model name
  4430. in: query
  4431. name: model_name
  4432. type: string
  4433. - description: Channel ID
  4434. in: query
  4435. name: channel
  4436. type: integer
  4437. - description: Order
  4438. in: query
  4439. name: order
  4440. type: string
  4441. - description: Request ID
  4442. in: query
  4443. name: request_id
  4444. type: string
  4445. - description: Status code type
  4446. in: query
  4447. name: code_type
  4448. type: string
  4449. - description: Status code
  4450. in: query
  4451. name: code
  4452. type: integer
  4453. - description: With body
  4454. in: query
  4455. name: with_body
  4456. type: boolean
  4457. - description: IP
  4458. in: query
  4459. name: ip
  4460. type: string
  4461. - description: User
  4462. in: query
  4463. name: user
  4464. type: string
  4465. produces:
  4466. - application/json
  4467. responses:
  4468. "200":
  4469. description: OK
  4470. schema:
  4471. allOf:
  4472. - $ref: '#/definitions/middleware.APIResponse'
  4473. - properties:
  4474. data:
  4475. $ref: '#/definitions/model.GetLogsResult'
  4476. type: object
  4477. security:
  4478. - ApiKeyAuth: []
  4479. summary: Get all logs
  4480. tags:
  4481. - logs
  4482. /api/logs/consume_error:
  4483. get:
  4484. description: Search for logs with consumption errors
  4485. parameters:
  4486. - description: Page number
  4487. in: query
  4488. name: page
  4489. type: integer
  4490. - description: Items per page
  4491. in: query
  4492. name: per_page
  4493. type: integer
  4494. - description: Start timestamp (milliseconds)
  4495. in: query
  4496. name: start_timestamp
  4497. type: integer
  4498. - description: End timestamp (milliseconds)
  4499. in: query
  4500. name: end_timestamp
  4501. type: integer
  4502. - description: Keyword
  4503. in: query
  4504. name: keyword
  4505. type: string
  4506. - description: Group
  4507. in: query
  4508. name: group
  4509. type: string
  4510. - description: Token name
  4511. in: query
  4512. name: token_name
  4513. type: string
  4514. - description: Model name
  4515. in: query
  4516. name: model_name
  4517. type: string
  4518. - description: Content
  4519. in: query
  4520. name: content
  4521. type: string
  4522. - description: Token ID
  4523. in: query
  4524. name: token_id
  4525. type: integer
  4526. - description: Order
  4527. in: query
  4528. name: order
  4529. type: string
  4530. - description: Request ID
  4531. in: query
  4532. name: request_id
  4533. type: string
  4534. produces:
  4535. - application/json
  4536. responses:
  4537. "200":
  4538. description: OK
  4539. schema:
  4540. allOf:
  4541. - $ref: '#/definitions/middleware.APIResponse'
  4542. - properties:
  4543. data:
  4544. additionalProperties:
  4545. allOf:
  4546. - {}
  4547. - properties:
  4548. logs:
  4549. items:
  4550. $ref: '#/definitions/model.RequestDetail'
  4551. type: array
  4552. total:
  4553. type: integer
  4554. type: object
  4555. type: object
  4556. type: object
  4557. security:
  4558. - ApiKeyAuth: []
  4559. summary: Search consumption errors
  4560. tags:
  4561. - logs
  4562. /api/logs/detail/{log_id}:
  4563. get:
  4564. description: Get detailed information about a specific log entry
  4565. parameters:
  4566. - description: Log ID
  4567. in: path
  4568. name: log_id
  4569. required: true
  4570. type: string
  4571. produces:
  4572. - application/json
  4573. responses:
  4574. "200":
  4575. description: OK
  4576. schema:
  4577. allOf:
  4578. - $ref: '#/definitions/middleware.APIResponse'
  4579. - properties:
  4580. data:
  4581. $ref: '#/definitions/model.RequestDetail'
  4582. type: object
  4583. security:
  4584. - ApiKeyAuth: []
  4585. summary: Get log detail
  4586. tags:
  4587. - logs
  4588. /api/logs/search:
  4589. get:
  4590. description: Search logs with various filters
  4591. parameters:
  4592. - description: Keyword
  4593. in: query
  4594. name: keyword
  4595. type: string
  4596. - description: Page number
  4597. in: query
  4598. name: page
  4599. type: integer
  4600. - description: Items per page
  4601. in: query
  4602. name: per_page
  4603. type: integer
  4604. - description: Start timestamp (milliseconds)
  4605. in: query
  4606. name: start_timestamp
  4607. type: integer
  4608. - description: End timestamp (milliseconds)
  4609. in: query
  4610. name: end_timestamp
  4611. type: integer
  4612. - description: Filter by model name
  4613. in: query
  4614. name: model_name
  4615. type: string
  4616. - description: Filter by channel
  4617. in: query
  4618. name: channel
  4619. type: integer
  4620. - description: Filter by token id
  4621. in: query
  4622. name: token_id
  4623. type: integer
  4624. - description: Order
  4625. in: query
  4626. name: order
  4627. type: string
  4628. - description: Request ID
  4629. in: query
  4630. name: request_id
  4631. type: string
  4632. - description: Status code type
  4633. in: query
  4634. name: code_type
  4635. type: string
  4636. - description: Status code
  4637. in: query
  4638. name: code
  4639. type: integer
  4640. - description: With body
  4641. in: query
  4642. name: with_body
  4643. type: boolean
  4644. - description: IP
  4645. in: query
  4646. name: ip
  4647. type: string
  4648. - description: User
  4649. in: query
  4650. name: user
  4651. type: string
  4652. produces:
  4653. - application/json
  4654. responses:
  4655. "200":
  4656. description: OK
  4657. schema:
  4658. allOf:
  4659. - $ref: '#/definitions/middleware.APIResponse'
  4660. - properties:
  4661. data:
  4662. $ref: '#/definitions/model.GetLogsResult'
  4663. type: object
  4664. security:
  4665. - ApiKeyAuth: []
  4666. summary: Search logs
  4667. tags:
  4668. - logs
  4669. /api/mcp/group/{group}:
  4670. get:
  4671. description: Get a list of Group MCPs with pagination and filtering
  4672. parameters:
  4673. - description: Group ID
  4674. in: path
  4675. name: group
  4676. required: true
  4677. type: string
  4678. - description: Page number
  4679. in: query
  4680. name: page
  4681. type: integer
  4682. - description: Items per page
  4683. in: query
  4684. name: per_page
  4685. type: integer
  4686. - description: MCP id
  4687. in: query
  4688. name: id
  4689. type: string
  4690. - description: MCP type, mcp_proxy_sse, mcp_proxy_streamable, mcp_openapi
  4691. in: query
  4692. name: type
  4693. type: string
  4694. - description: Search keyword
  4695. in: query
  4696. name: keyword
  4697. type: string
  4698. - description: MCP status
  4699. in: query
  4700. name: status
  4701. type: integer
  4702. produces:
  4703. - application/json
  4704. responses:
  4705. "200":
  4706. description: OK
  4707. schema:
  4708. allOf:
  4709. - $ref: '#/definitions/middleware.APIResponse'
  4710. - properties:
  4711. data:
  4712. items:
  4713. $ref: '#/definitions/controller.GroupMCPResponse'
  4714. type: array
  4715. type: object
  4716. security:
  4717. - ApiKeyAuth: []
  4718. summary: Get Group MCPs
  4719. tags:
  4720. - mcp
  4721. post:
  4722. consumes:
  4723. - application/json
  4724. description: Create a new Group MCP
  4725. parameters:
  4726. - description: Group ID
  4727. in: path
  4728. name: group
  4729. required: true
  4730. type: string
  4731. - description: Group MCP object
  4732. in: body
  4733. name: mcp
  4734. required: true
  4735. schema:
  4736. $ref: '#/definitions/model.GroupMCP'
  4737. produces:
  4738. - application/json
  4739. responses:
  4740. "200":
  4741. description: OK
  4742. schema:
  4743. allOf:
  4744. - $ref: '#/definitions/middleware.APIResponse'
  4745. - properties:
  4746. data:
  4747. $ref: '#/definitions/controller.GroupMCPResponse'
  4748. type: object
  4749. security:
  4750. - ApiKeyAuth: []
  4751. summary: Create Group MCP
  4752. tags:
  4753. - mcp
  4754. /api/mcp/group/{group}/{id}:
  4755. delete:
  4756. description: Delete a Group MCP by ID and Group ID
  4757. parameters:
  4758. - description: MCP ID
  4759. in: path
  4760. name: id
  4761. required: true
  4762. type: string
  4763. - description: Group ID
  4764. in: path
  4765. name: group
  4766. required: true
  4767. type: string
  4768. produces:
  4769. - application/json
  4770. responses:
  4771. "200":
  4772. description: OK
  4773. schema:
  4774. $ref: '#/definitions/middleware.APIResponse'
  4775. security:
  4776. - ApiKeyAuth: []
  4777. summary: Delete Group MCP
  4778. tags:
  4779. - mcp
  4780. get:
  4781. description: Get a specific Group MCP by its ID and Group ID
  4782. parameters:
  4783. - description: MCP ID
  4784. in: path
  4785. name: id
  4786. required: true
  4787. type: string
  4788. - description: Group ID
  4789. in: path
  4790. name: group
  4791. required: true
  4792. type: string
  4793. produces:
  4794. - application/json
  4795. responses:
  4796. "200":
  4797. description: OK
  4798. schema:
  4799. allOf:
  4800. - $ref: '#/definitions/middleware.APIResponse'
  4801. - properties:
  4802. data:
  4803. $ref: '#/definitions/controller.GroupMCPResponse'
  4804. type: object
  4805. security:
  4806. - ApiKeyAuth: []
  4807. summary: Get Group MCP by ID
  4808. tags:
  4809. - mcp
  4810. put:
  4811. consumes:
  4812. - application/json
  4813. description: Update an existing Group MCP
  4814. parameters:
  4815. - description: MCP ID
  4816. in: path
  4817. name: id
  4818. required: true
  4819. type: string
  4820. - description: Group ID
  4821. in: path
  4822. name: group
  4823. required: true
  4824. type: string
  4825. - description: Group MCP object
  4826. in: body
  4827. name: mcp
  4828. required: true
  4829. schema:
  4830. $ref: '#/definitions/model.GroupMCP'
  4831. produces:
  4832. - application/json
  4833. responses:
  4834. "200":
  4835. description: OK
  4836. schema:
  4837. allOf:
  4838. - $ref: '#/definitions/middleware.APIResponse'
  4839. - properties:
  4840. data:
  4841. $ref: '#/definitions/controller.GroupMCPResponse'
  4842. type: object
  4843. security:
  4844. - ApiKeyAuth: []
  4845. summary: Update Group MCP
  4846. tags:
  4847. - mcp
  4848. /api/mcp/group/{group}/{id}/status:
  4849. post:
  4850. consumes:
  4851. - application/json
  4852. description: Update the status of a Group MCP
  4853. parameters:
  4854. - description: MCP ID
  4855. in: path
  4856. name: id
  4857. required: true
  4858. type: string
  4859. - description: Group ID
  4860. in: path
  4861. name: group
  4862. required: true
  4863. type: string
  4864. - description: MCP status
  4865. in: body
  4866. name: status
  4867. required: true
  4868. schema:
  4869. $ref: '#/definitions/controller.UpdateGroupMCPStatusRequest'
  4870. produces:
  4871. - application/json
  4872. responses:
  4873. "200":
  4874. description: OK
  4875. schema:
  4876. $ref: '#/definitions/middleware.APIResponse'
  4877. security:
  4878. - ApiKeyAuth: []
  4879. summary: Update Group MCP status
  4880. tags:
  4881. - mcp
  4882. /api/mcp/group/all:
  4883. get:
  4884. description: Get all Group MCPs with filtering
  4885. parameters:
  4886. - description: MCP status
  4887. in: query
  4888. name: status
  4889. type: integer
  4890. produces:
  4891. - application/json
  4892. responses:
  4893. "200":
  4894. description: OK
  4895. schema:
  4896. allOf:
  4897. - $ref: '#/definitions/middleware.APIResponse'
  4898. - properties:
  4899. data:
  4900. items:
  4901. $ref: '#/definitions/controller.GroupMCPResponse'
  4902. type: array
  4903. type: object
  4904. security:
  4905. - ApiKeyAuth: []
  4906. summary: Get all Group MCPs
  4907. tags:
  4908. - mcp
  4909. /api/mcp/public/:
  4910. post:
  4911. consumes:
  4912. - application/json
  4913. description: Create a new MCP
  4914. parameters:
  4915. - description: MCP object
  4916. in: body
  4917. name: mcp
  4918. required: true
  4919. schema:
  4920. $ref: '#/definitions/model.PublicMCP'
  4921. produces:
  4922. - application/json
  4923. responses:
  4924. "200":
  4925. description: OK
  4926. schema:
  4927. allOf:
  4928. - $ref: '#/definitions/middleware.APIResponse'
  4929. - properties:
  4930. data:
  4931. $ref: '#/definitions/controller.PublicMCPResponse'
  4932. type: object
  4933. security:
  4934. - ApiKeyAuth: []
  4935. summary: Create MCP
  4936. tags:
  4937. - mcp
  4938. /api/mcp/public/{id}:
  4939. delete:
  4940. description: Delete an MCP by ID
  4941. parameters:
  4942. - description: MCP ID
  4943. in: path
  4944. name: id
  4945. required: true
  4946. type: string
  4947. produces:
  4948. - application/json
  4949. responses:
  4950. "200":
  4951. description: OK
  4952. schema:
  4953. $ref: '#/definitions/middleware.APIResponse'
  4954. security:
  4955. - ApiKeyAuth: []
  4956. summary: Delete MCP
  4957. tags:
  4958. - mcp
  4959. get:
  4960. description: Get a specific MCP by its ID
  4961. parameters:
  4962. - description: MCP ID
  4963. in: path
  4964. name: id
  4965. required: true
  4966. type: string
  4967. produces:
  4968. - application/json
  4969. responses:
  4970. "200":
  4971. description: OK
  4972. schema:
  4973. allOf:
  4974. - $ref: '#/definitions/middleware.APIResponse'
  4975. - properties:
  4976. data:
  4977. $ref: '#/definitions/controller.PublicMCPResponse'
  4978. type: object
  4979. security:
  4980. - ApiKeyAuth: []
  4981. summary: Get MCP by ID
  4982. tags:
  4983. - mcp
  4984. post:
  4985. consumes:
  4986. - application/json
  4987. description: Update an existing MCP
  4988. parameters:
  4989. - description: MCP ID
  4990. in: path
  4991. name: id
  4992. required: true
  4993. type: string
  4994. - description: MCP object
  4995. in: body
  4996. name: mcp
  4997. required: true
  4998. schema:
  4999. $ref: '#/definitions/model.PublicMCP'
  5000. produces:
  5001. - application/json
  5002. responses:
  5003. "200":
  5004. description: OK
  5005. schema:
  5006. allOf:
  5007. - $ref: '#/definitions/middleware.APIResponse'
  5008. - properties:
  5009. data:
  5010. $ref: '#/definitions/controller.PublicMCPResponse'
  5011. type: object
  5012. security:
  5013. - ApiKeyAuth: []
  5014. summary: Update MCP
  5015. tags:
  5016. - mcp
  5017. put:
  5018. consumes:
  5019. - application/json
  5020. description: Save a MCP
  5021. parameters:
  5022. - description: MCP ID
  5023. in: path
  5024. name: id
  5025. required: true
  5026. type: string
  5027. - description: MCP object
  5028. in: body
  5029. name: mcp
  5030. required: true
  5031. schema:
  5032. $ref: '#/definitions/model.PublicMCP'
  5033. produces:
  5034. - application/json
  5035. responses:
  5036. "200":
  5037. description: OK
  5038. schema:
  5039. allOf:
  5040. - $ref: '#/definitions/middleware.APIResponse'
  5041. - properties:
  5042. data:
  5043. $ref: '#/definitions/controller.PublicMCPResponse'
  5044. type: object
  5045. security:
  5046. - ApiKeyAuth: []
  5047. summary: Save MCP
  5048. tags:
  5049. - mcp
  5050. /api/mcp/public/{id}/group/{group}/params:
  5051. get:
  5052. description: Get reusing parameters for a specific group and MCP
  5053. parameters:
  5054. - description: MCP ID
  5055. in: path
  5056. name: id
  5057. required: true
  5058. type: string
  5059. - description: Group ID
  5060. in: path
  5061. name: group
  5062. required: true
  5063. type: string
  5064. produces:
  5065. - application/json
  5066. responses:
  5067. "200":
  5068. description: OK
  5069. schema:
  5070. allOf:
  5071. - $ref: '#/definitions/middleware.APIResponse'
  5072. - properties:
  5073. data:
  5074. $ref: '#/definitions/model.PublicMCPReusingParam'
  5075. type: object
  5076. security:
  5077. - ApiKeyAuth: []
  5078. summary: Get group MCP reusing parameters
  5079. tags:
  5080. - mcp
  5081. post:
  5082. consumes:
  5083. - application/json
  5084. description: Create or update reusing parameters for a specific group and MCP
  5085. parameters:
  5086. - description: MCP ID
  5087. in: path
  5088. name: id
  5089. required: true
  5090. type: string
  5091. - description: Group ID
  5092. in: path
  5093. name: group
  5094. required: true
  5095. type: string
  5096. - description: Reusing parameters
  5097. in: body
  5098. name: params
  5099. required: true
  5100. schema:
  5101. $ref: '#/definitions/model.PublicMCPReusingParam'
  5102. produces:
  5103. - application/json
  5104. responses:
  5105. "200":
  5106. description: OK
  5107. schema:
  5108. $ref: '#/definitions/middleware.APIResponse'
  5109. security:
  5110. - ApiKeyAuth: []
  5111. summary: Create or update group MCP reusing parameters
  5112. tags:
  5113. - mcp
  5114. /api/mcp/public/{id}/status:
  5115. post:
  5116. consumes:
  5117. - application/json
  5118. description: Update the status of an MCP
  5119. parameters:
  5120. - description: MCP ID
  5121. in: path
  5122. name: id
  5123. required: true
  5124. type: string
  5125. - description: MCP status
  5126. in: body
  5127. name: status
  5128. required: true
  5129. schema:
  5130. $ref: '#/definitions/controller.UpdatePublicMCPStatusRequest'
  5131. produces:
  5132. - application/json
  5133. responses:
  5134. "200":
  5135. description: OK
  5136. schema:
  5137. $ref: '#/definitions/middleware.APIResponse'
  5138. security:
  5139. - ApiKeyAuth: []
  5140. summary: Update MCP status
  5141. tags:
  5142. - mcp
  5143. /api/mcp/publics/:
  5144. get:
  5145. description: Get a list of MCPs with pagination and filtering
  5146. parameters:
  5147. - description: Page number
  5148. in: query
  5149. name: page
  5150. type: integer
  5151. - description: Items per page
  5152. in: query
  5153. name: per_page
  5154. type: integer
  5155. - description: hosted or local
  5156. in: query
  5157. name: type
  5158. type: string
  5159. - description: MCP id
  5160. in: query
  5161. name: id
  5162. type: string
  5163. - description: Search keyword
  5164. in: query
  5165. name: keyword
  5166. type: string
  5167. - description: MCP status
  5168. in: query
  5169. name: status
  5170. type: integer
  5171. produces:
  5172. - application/json
  5173. responses:
  5174. "200":
  5175. description: OK
  5176. schema:
  5177. allOf:
  5178. - $ref: '#/definitions/middleware.APIResponse'
  5179. - properties:
  5180. data:
  5181. items:
  5182. $ref: '#/definitions/controller.PublicMCPResponse'
  5183. type: array
  5184. type: object
  5185. security:
  5186. - ApiKeyAuth: []
  5187. summary: Get MCPs
  5188. tags:
  5189. - mcp
  5190. post:
  5191. consumes:
  5192. - application/json
  5193. description: Save a list of MCPs
  5194. parameters:
  5195. - description: MCP object
  5196. in: body
  5197. name: mcp
  5198. required: true
  5199. schema:
  5200. items:
  5201. $ref: '#/definitions/model.PublicMCP'
  5202. type: array
  5203. produces:
  5204. - application/json
  5205. responses:
  5206. "200":
  5207. description: OK
  5208. schema:
  5209. $ref: '#/definitions/middleware.APIResponse'
  5210. security:
  5211. - ApiKeyAuth: []
  5212. summary: Save MCPs
  5213. tags:
  5214. - mcp
  5215. /api/mcp/publics/all:
  5216. get:
  5217. description: Get all MCPs with filtering
  5218. parameters:
  5219. - description: MCP status
  5220. in: query
  5221. name: status
  5222. type: integer
  5223. produces:
  5224. - application/json
  5225. responses:
  5226. "200":
  5227. description: OK
  5228. schema:
  5229. allOf:
  5230. - $ref: '#/definitions/middleware.APIResponse'
  5231. - properties:
  5232. data:
  5233. items:
  5234. $ref: '#/definitions/controller.PublicMCPResponse'
  5235. type: array
  5236. type: object
  5237. security:
  5238. - ApiKeyAuth: []
  5239. summary: Get all MCPs
  5240. tags:
  5241. - mcp
  5242. /api/model_config/{model}:
  5243. delete:
  5244. description: Deletes a model config
  5245. parameters:
  5246. - description: Model name
  5247. in: path
  5248. name: model
  5249. required: true
  5250. type: string
  5251. produces:
  5252. - application/json
  5253. responses:
  5254. "200":
  5255. description: OK
  5256. schema:
  5257. $ref: '#/definitions/middleware.APIResponse'
  5258. security:
  5259. - ApiKeyAuth: []
  5260. summary: Delete model config
  5261. tags:
  5262. - modelconfig
  5263. get:
  5264. description: Returns a model config
  5265. parameters:
  5266. - description: Model name
  5267. in: path
  5268. name: model
  5269. required: true
  5270. type: string
  5271. produces:
  5272. - application/json
  5273. responses:
  5274. "200":
  5275. description: OK
  5276. schema:
  5277. allOf:
  5278. - $ref: '#/definitions/middleware.APIResponse'
  5279. - properties:
  5280. data:
  5281. $ref: '#/definitions/model.ModelConfig'
  5282. type: object
  5283. security:
  5284. - ApiKeyAuth: []
  5285. summary: Get model config
  5286. tags:
  5287. - modelconfig
  5288. post:
  5289. description: Saves a model config
  5290. parameters:
  5291. - description: Model config
  5292. in: body
  5293. name: config
  5294. required: true
  5295. schema:
  5296. $ref: '#/definitions/controller.SaveModelConfigsRequest'
  5297. produces:
  5298. - application/json
  5299. responses:
  5300. "200":
  5301. description: OK
  5302. schema:
  5303. $ref: '#/definitions/middleware.APIResponse'
  5304. security:
  5305. - ApiKeyAuth: []
  5306. summary: Save model config
  5307. tags:
  5308. - modelconfig
  5309. /api/model_configs/:
  5310. get:
  5311. description: Returns a list of model configs with pagination
  5312. parameters:
  5313. - description: Model name
  5314. in: query
  5315. name: model
  5316. type: string
  5317. produces:
  5318. - application/json
  5319. responses:
  5320. "200":
  5321. description: OK
  5322. schema:
  5323. allOf:
  5324. - $ref: '#/definitions/middleware.APIResponse'
  5325. - properties:
  5326. data:
  5327. additionalProperties:
  5328. allOf:
  5329. - {}
  5330. - properties:
  5331. configs:
  5332. items:
  5333. $ref: '#/definitions/model.ModelConfig'
  5334. type: array
  5335. total:
  5336. type: integer
  5337. type: object
  5338. type: object
  5339. type: object
  5340. security:
  5341. - ApiKeyAuth: []
  5342. summary: Get model configs
  5343. tags:
  5344. - modelconfig
  5345. post:
  5346. description: Saves a list of model configs
  5347. parameters:
  5348. - description: Model configs
  5349. in: body
  5350. name: configs
  5351. required: true
  5352. schema:
  5353. items:
  5354. $ref: '#/definitions/controller.SaveModelConfigsRequest'
  5355. type: array
  5356. produces:
  5357. - application/json
  5358. responses:
  5359. "200":
  5360. description: OK
  5361. schema:
  5362. $ref: '#/definitions/middleware.APIResponse'
  5363. security:
  5364. - ApiKeyAuth: []
  5365. summary: Save model configs
  5366. tags:
  5367. - modelconfig
  5368. /api/model_configs/all:
  5369. get:
  5370. description: Returns a list of all model configs
  5371. produces:
  5372. - application/json
  5373. responses:
  5374. "200":
  5375. description: OK
  5376. schema:
  5377. allOf:
  5378. - $ref: '#/definitions/middleware.APIResponse'
  5379. - properties:
  5380. data:
  5381. items:
  5382. $ref: '#/definitions/model.ModelConfig'
  5383. type: array
  5384. type: object
  5385. security:
  5386. - ApiKeyAuth: []
  5387. summary: Get all model configs
  5388. tags:
  5389. - modelconfig
  5390. /api/model_configs/batch_delete:
  5391. post:
  5392. description: Deletes a list of model configs
  5393. parameters:
  5394. - description: Model names
  5395. in: body
  5396. name: models
  5397. required: true
  5398. schema:
  5399. items:
  5400. type: string
  5401. type: array
  5402. produces:
  5403. - application/json
  5404. responses:
  5405. "200":
  5406. description: OK
  5407. schema:
  5408. $ref: '#/definitions/middleware.APIResponse'
  5409. security:
  5410. - ApiKeyAuth: []
  5411. summary: Delete model configs
  5412. tags:
  5413. - modelconfig
  5414. /api/model_configs/contains:
  5415. post:
  5416. description: Returns a list of model configs by models contains
  5417. parameters:
  5418. - description: Models
  5419. in: body
  5420. name: models
  5421. required: true
  5422. schema:
  5423. $ref: '#/definitions/controller.GetModelConfigsByModelsContainsRequest'
  5424. produces:
  5425. - application/json
  5426. responses:
  5427. "200":
  5428. description: OK
  5429. schema:
  5430. allOf:
  5431. - $ref: '#/definitions/middleware.APIResponse'
  5432. - properties:
  5433. data:
  5434. items:
  5435. $ref: '#/definitions/model.ModelConfig'
  5436. type: array
  5437. type: object
  5438. security:
  5439. - ApiKeyAuth: []
  5440. summary: Get model configs by models contains
  5441. tags:
  5442. - modelconfig
  5443. /api/model_configs/search:
  5444. get:
  5445. description: Returns a list of model configs by keyword
  5446. parameters:
  5447. - description: Keyword
  5448. in: query
  5449. name: keyword
  5450. type: string
  5451. - description: Model name
  5452. in: query
  5453. name: model
  5454. type: string
  5455. - description: Owner
  5456. in: query
  5457. name: owner
  5458. type: string
  5459. - description: Page
  5460. in: query
  5461. name: page
  5462. type: integer
  5463. - description: Per page
  5464. in: query
  5465. name: per_page
  5466. type: integer
  5467. produces:
  5468. - application/json
  5469. responses:
  5470. "200":
  5471. description: OK
  5472. schema:
  5473. allOf:
  5474. - $ref: '#/definitions/middleware.APIResponse'
  5475. - properties:
  5476. data:
  5477. additionalProperties:
  5478. allOf:
  5479. - {}
  5480. - properties:
  5481. configs:
  5482. items:
  5483. $ref: '#/definitions/model.ModelConfig'
  5484. type: array
  5485. total:
  5486. type: integer
  5487. type: object
  5488. type: object
  5489. type: object
  5490. security:
  5491. - ApiKeyAuth: []
  5492. summary: Search model configs
  5493. tags:
  5494. - modelconfig
  5495. /api/models/builtin:
  5496. get:
  5497. description: Returns a list of builtin models
  5498. produces:
  5499. - application/json
  5500. responses:
  5501. "200":
  5502. description: OK
  5503. schema:
  5504. allOf:
  5505. - $ref: '#/definitions/middleware.APIResponse'
  5506. - properties:
  5507. data:
  5508. items:
  5509. $ref: '#/definitions/controller.BuiltinModelConfig'
  5510. type: array
  5511. type: object
  5512. security:
  5513. - ApiKeyAuth: []
  5514. summary: Get builtin models
  5515. tags:
  5516. - model
  5517. /api/models/builtin/channel:
  5518. get:
  5519. description: Returns a list of channel builtin models
  5520. produces:
  5521. - application/json
  5522. responses:
  5523. "200":
  5524. description: OK
  5525. schema:
  5526. allOf:
  5527. - $ref: '#/definitions/middleware.APIResponse'
  5528. - properties:
  5529. data:
  5530. additionalProperties:
  5531. items:
  5532. $ref: '#/definitions/controller.BuiltinModelConfig'
  5533. type: array
  5534. type: object
  5535. type: object
  5536. security:
  5537. - ApiKeyAuth: []
  5538. summary: Get channel builtin models
  5539. tags:
  5540. - model
  5541. /api/models/builtin/channel/{type}:
  5542. get:
  5543. description: Returns a list of channel builtin models by type
  5544. parameters:
  5545. - description: Channel type
  5546. enum:
  5547. - 1
  5548. - 3
  5549. - 4
  5550. - 12
  5551. - 13
  5552. - 14
  5553. - 15
  5554. - 16
  5555. - 17
  5556. - 18
  5557. - 19
  5558. - 20
  5559. - 23
  5560. - 24
  5561. - 25
  5562. - 26
  5563. - 27
  5564. - 28
  5565. - 29
  5566. - 30
  5567. - 31
  5568. - 32
  5569. - 33
  5570. - 34
  5571. - 35
  5572. - 36
  5573. - 37
  5574. - 40
  5575. - 41
  5576. - 42
  5577. - 43
  5578. - 44
  5579. - 45
  5580. - 46
  5581. - 47
  5582. - 48
  5583. - 49
  5584. in: path
  5585. name: type
  5586. required: true
  5587. type: integer
  5588. produces:
  5589. - application/json
  5590. responses:
  5591. "200":
  5592. description: OK
  5593. schema:
  5594. allOf:
  5595. - $ref: '#/definitions/middleware.APIResponse'
  5596. - properties:
  5597. data:
  5598. items:
  5599. $ref: '#/definitions/controller.BuiltinModelConfig'
  5600. type: array
  5601. type: object
  5602. security:
  5603. - ApiKeyAuth: []
  5604. summary: Get channel builtin models by type
  5605. tags:
  5606. - model
  5607. /api/models/default:
  5608. get:
  5609. description: Returns a list of channel default models and mapping
  5610. produces:
  5611. - application/json
  5612. responses:
  5613. "200":
  5614. description: OK
  5615. schema:
  5616. allOf:
  5617. - $ref: '#/definitions/middleware.APIResponse'
  5618. - properties:
  5619. data:
  5620. additionalProperties:
  5621. allOf:
  5622. - {}
  5623. - properties:
  5624. mapping:
  5625. additionalProperties:
  5626. type: string
  5627. type: object
  5628. models:
  5629. items:
  5630. type: string
  5631. type: array
  5632. type: object
  5633. type: object
  5634. type: object
  5635. security:
  5636. - ApiKeyAuth: []
  5637. summary: Get channel default models and mapping
  5638. tags:
  5639. - model
  5640. /api/models/default/{type}:
  5641. get:
  5642. description: Returns a list of channel default models and mapping by type
  5643. parameters:
  5644. - description: Channel type
  5645. in: path
  5646. name: type
  5647. required: true
  5648. type: string
  5649. produces:
  5650. - application/json
  5651. responses:
  5652. "200":
  5653. description: OK
  5654. schema:
  5655. allOf:
  5656. - $ref: '#/definitions/middleware.APIResponse'
  5657. - properties:
  5658. data:
  5659. additionalProperties:
  5660. allOf:
  5661. - {}
  5662. - properties:
  5663. mapping:
  5664. additionalProperties:
  5665. type: string
  5666. type: object
  5667. models:
  5668. items:
  5669. type: string
  5670. type: array
  5671. type: object
  5672. type: object
  5673. type: object
  5674. security:
  5675. - ApiKeyAuth: []
  5676. summary: Get channel default models and mapping by type
  5677. tags:
  5678. - model
  5679. /api/models/enabled:
  5680. get:
  5681. description: Returns a list of enabled models
  5682. produces:
  5683. - application/json
  5684. responses:
  5685. "200":
  5686. description: OK
  5687. schema:
  5688. allOf:
  5689. - $ref: '#/definitions/middleware.APIResponse'
  5690. - properties:
  5691. data:
  5692. additionalProperties:
  5693. items:
  5694. $ref: '#/definitions/model.ModelConfig'
  5695. type: array
  5696. type: object
  5697. type: object
  5698. security:
  5699. - ApiKeyAuth: []
  5700. summary: Get enabled models
  5701. tags:
  5702. - model
  5703. /api/models/enabled/{set}:
  5704. get:
  5705. description: Returns a list of enabled models by set
  5706. parameters:
  5707. - description: Models set
  5708. in: path
  5709. name: set
  5710. required: true
  5711. type: string
  5712. produces:
  5713. - application/json
  5714. responses:
  5715. "200":
  5716. description: OK
  5717. schema:
  5718. allOf:
  5719. - $ref: '#/definitions/middleware.APIResponse'
  5720. - properties:
  5721. data:
  5722. items:
  5723. $ref: '#/definitions/model.ModelConfig'
  5724. type: array
  5725. type: object
  5726. security:
  5727. - ApiKeyAuth: []
  5728. summary: Get enabled models by set
  5729. tags:
  5730. - model
  5731. /api/models/sets:
  5732. get:
  5733. description: Returns a list of enabled models and channels sets
  5734. produces:
  5735. - application/json
  5736. responses:
  5737. "200":
  5738. description: OK
  5739. schema:
  5740. allOf:
  5741. - $ref: '#/definitions/middleware.APIResponse'
  5742. - properties:
  5743. data:
  5744. additionalProperties:
  5745. additionalProperties:
  5746. items:
  5747. $ref: '#/definitions/controller.EnabledModelChannel'
  5748. type: array
  5749. type: object
  5750. type: object
  5751. type: object
  5752. security:
  5753. - ApiKeyAuth: []
  5754. summary: Get enabled models and channels sets
  5755. tags:
  5756. - model
  5757. /api/monitor/:
  5758. delete:
  5759. description: Clears all model errors
  5760. produces:
  5761. - application/json
  5762. responses:
  5763. "200":
  5764. description: OK
  5765. schema:
  5766. $ref: '#/definitions/middleware.APIResponse'
  5767. security:
  5768. - ApiKeyAuth: []
  5769. summary: Clear all model errors
  5770. tags:
  5771. - monitor
  5772. get:
  5773. description: Returns a list of all channel model error rates
  5774. produces:
  5775. - application/json
  5776. responses:
  5777. "200":
  5778. description: OK
  5779. schema:
  5780. allOf:
  5781. - $ref: '#/definitions/middleware.APIResponse'
  5782. - properties:
  5783. data:
  5784. additionalProperties:
  5785. additionalProperties:
  5786. format: float64
  5787. type: number
  5788. type: object
  5789. type: object
  5790. type: object
  5791. security:
  5792. - ApiKeyAuth: []
  5793. summary: Get all channel model error rates
  5794. tags:
  5795. - monitor
  5796. /api/monitor/{id}:
  5797. delete:
  5798. description: Clears all model errors for a specific channel
  5799. parameters:
  5800. - description: Channel ID
  5801. in: path
  5802. name: id
  5803. required: true
  5804. type: integer
  5805. produces:
  5806. - application/json
  5807. responses:
  5808. "200":
  5809. description: OK
  5810. schema:
  5811. $ref: '#/definitions/middleware.APIResponse'
  5812. security:
  5813. - ApiKeyAuth: []
  5814. summary: Clear channel all model errors
  5815. tags:
  5816. - monitor
  5817. get:
  5818. description: Returns a list of channel model error rates
  5819. parameters:
  5820. - description: Channel ID
  5821. in: path
  5822. name: id
  5823. required: true
  5824. type: integer
  5825. produces:
  5826. - application/json
  5827. responses:
  5828. "200":
  5829. description: OK
  5830. schema:
  5831. allOf:
  5832. - $ref: '#/definitions/middleware.APIResponse'
  5833. - properties:
  5834. data:
  5835. items:
  5836. additionalProperties:
  5837. format: float64
  5838. type: number
  5839. type: object
  5840. type: array
  5841. type: object
  5842. security:
  5843. - ApiKeyAuth: []
  5844. summary: Get channel model error rates
  5845. tags:
  5846. - monitor
  5847. /api/monitor/{id}/{model}:
  5848. delete:
  5849. description: Clears model errors for a specific channel and model
  5850. parameters:
  5851. - description: Channel ID
  5852. in: path
  5853. name: id
  5854. required: true
  5855. type: integer
  5856. - description: Model name
  5857. in: path
  5858. name: model
  5859. required: true
  5860. type: string
  5861. produces:
  5862. - application/json
  5863. responses:
  5864. "200":
  5865. description: OK
  5866. schema:
  5867. $ref: '#/definitions/middleware.APIResponse'
  5868. security:
  5869. - ApiKeyAuth: []
  5870. summary: Clear channel model errors
  5871. tags:
  5872. - monitor
  5873. /api/monitor/banned_channels:
  5874. get:
  5875. description: Returns a list of all banned model channels
  5876. produces:
  5877. - application/json
  5878. responses:
  5879. "200":
  5880. description: OK
  5881. schema:
  5882. allOf:
  5883. - $ref: '#/definitions/middleware.APIResponse'
  5884. - properties:
  5885. data:
  5886. additionalProperties:
  5887. items:
  5888. format: int64
  5889. type: integer
  5890. type: array
  5891. type: object
  5892. type: object
  5893. security:
  5894. - ApiKeyAuth: []
  5895. summary: Get all banned model channels
  5896. tags:
  5897. - monitor
  5898. /api/monitor/models:
  5899. get:
  5900. description: Returns a list of models error rate
  5901. produces:
  5902. - application/json
  5903. responses:
  5904. "200":
  5905. description: OK
  5906. schema:
  5907. allOf:
  5908. - $ref: '#/definitions/middleware.APIResponse'
  5909. - properties:
  5910. data:
  5911. additionalProperties:
  5912. format: float64
  5913. type: number
  5914. type: object
  5915. type: object
  5916. security:
  5917. - ApiKeyAuth: []
  5918. summary: Get models error rate
  5919. tags:
  5920. - monitor
  5921. /api/option/:
  5922. get:
  5923. description: Returns a list of options
  5924. produces:
  5925. - application/json
  5926. responses:
  5927. "200":
  5928. description: OK
  5929. schema:
  5930. allOf:
  5931. - $ref: '#/definitions/middleware.APIResponse'
  5932. - properties:
  5933. data:
  5934. additionalProperties:
  5935. type: string
  5936. type: object
  5937. type: object
  5938. security:
  5939. - ApiKeyAuth: []
  5940. summary: Get options
  5941. tags:
  5942. - option
  5943. post:
  5944. description: Updates a single option
  5945. parameters:
  5946. - description: Option value
  5947. in: body
  5948. name: value
  5949. required: true
  5950. schema:
  5951. $ref: '#/definitions/model.Option'
  5952. produces:
  5953. - application/json
  5954. responses:
  5955. "200":
  5956. description: OK
  5957. schema:
  5958. $ref: '#/definitions/middleware.APIResponse'
  5959. security:
  5960. - ApiKeyAuth: []
  5961. summary: Update option
  5962. tags:
  5963. - option
  5964. put:
  5965. description: Updates a single option
  5966. parameters:
  5967. - description: Option value
  5968. in: body
  5969. name: value
  5970. required: true
  5971. schema:
  5972. $ref: '#/definitions/model.Option'
  5973. produces:
  5974. - application/json
  5975. responses:
  5976. "200":
  5977. description: OK
  5978. schema:
  5979. $ref: '#/definitions/middleware.APIResponse'
  5980. security:
  5981. - ApiKeyAuth: []
  5982. summary: Update option
  5983. tags:
  5984. - option
  5985. /api/option/{key}:
  5986. get:
  5987. description: Returns a single option
  5988. parameters:
  5989. - description: Option key
  5990. in: path
  5991. name: key
  5992. required: true
  5993. type: string
  5994. produces:
  5995. - application/json
  5996. responses:
  5997. "200":
  5998. description: OK
  5999. schema:
  6000. allOf:
  6001. - $ref: '#/definitions/middleware.APIResponse'
  6002. - properties:
  6003. data:
  6004. $ref: '#/definitions/model.Option'
  6005. type: object
  6006. security:
  6007. - ApiKeyAuth: []
  6008. summary: Get option
  6009. tags:
  6010. - option
  6011. put:
  6012. description: Updates a single option by key
  6013. parameters:
  6014. - description: Option key
  6015. in: path
  6016. name: key
  6017. required: true
  6018. type: string
  6019. - description: Option value
  6020. in: body
  6021. name: value
  6022. required: true
  6023. schema:
  6024. type: string
  6025. produces:
  6026. - application/json
  6027. responses:
  6028. "200":
  6029. description: OK
  6030. schema:
  6031. $ref: '#/definitions/middleware.APIResponse'
  6032. security:
  6033. - ApiKeyAuth: []
  6034. summary: Update option by key
  6035. tags:
  6036. - option
  6037. /api/option/batch:
  6038. post:
  6039. description: Updates multiple options
  6040. parameters:
  6041. - description: Options
  6042. in: body
  6043. name: options
  6044. required: true
  6045. schema:
  6046. additionalProperties:
  6047. type: string
  6048. type: object
  6049. produces:
  6050. - application/json
  6051. responses:
  6052. "200":
  6053. description: OK
  6054. schema:
  6055. $ref: '#/definitions/middleware.APIResponse'
  6056. security:
  6057. - ApiKeyAuth: []
  6058. summary: Update options
  6059. tags:
  6060. - option
  6061. /api/status:
  6062. get:
  6063. description: Returns the status of the server
  6064. produces:
  6065. - application/json
  6066. responses:
  6067. "200":
  6068. description: OK
  6069. schema:
  6070. allOf:
  6071. - $ref: '#/definitions/middleware.APIResponse'
  6072. - properties:
  6073. data:
  6074. $ref: '#/definitions/controller.StatusData'
  6075. type: object
  6076. summary: Get status
  6077. tags:
  6078. - misc
  6079. /api/test-embedmcp/{id}:
  6080. delete:
  6081. consumes:
  6082. - application/json
  6083. description: Test Embed MCP Streamable Server with various HTTP methods
  6084. parameters:
  6085. - description: MCP ID
  6086. in: path
  6087. name: id
  6088. required: true
  6089. type: string
  6090. - description: Initial configuration parameters (e.g. config[host]=http://localhost:3000)
  6091. in: query
  6092. name: config[key]
  6093. type: string
  6094. - description: Reusing configuration parameters (e.g., reusing[authorization]=apikey)
  6095. in: query
  6096. name: reusing[key]
  6097. type: string
  6098. produces:
  6099. - application/json
  6100. responses:
  6101. "200":
  6102. description: OK
  6103. "400":
  6104. description: Bad Request
  6105. security:
  6106. - ApiKeyAuth: []
  6107. summary: Test Embed MCP Streamable Server
  6108. tags:
  6109. - embedmcp
  6110. get:
  6111. consumes:
  6112. - application/json
  6113. description: Test Embed MCP Streamable Server with various HTTP methods
  6114. parameters:
  6115. - description: MCP ID
  6116. in: path
  6117. name: id
  6118. required: true
  6119. type: string
  6120. - description: Initial configuration parameters (e.g. config[host]=http://localhost:3000)
  6121. in: query
  6122. name: config[key]
  6123. type: string
  6124. - description: Reusing configuration parameters (e.g., reusing[authorization]=apikey)
  6125. in: query
  6126. name: reusing[key]
  6127. type: string
  6128. produces:
  6129. - application/json
  6130. responses:
  6131. "200":
  6132. description: OK
  6133. "400":
  6134. description: Bad Request
  6135. security:
  6136. - ApiKeyAuth: []
  6137. summary: Test Embed MCP Streamable Server
  6138. tags:
  6139. - embedmcp
  6140. post:
  6141. consumes:
  6142. - application/json
  6143. description: Test Embed MCP Streamable Server with various HTTP methods
  6144. parameters:
  6145. - description: MCP ID
  6146. in: path
  6147. name: id
  6148. required: true
  6149. type: string
  6150. - description: Initial configuration parameters (e.g. config[host]=http://localhost:3000)
  6151. in: query
  6152. name: config[key]
  6153. type: string
  6154. - description: Reusing configuration parameters (e.g., reusing[authorization]=apikey)
  6155. in: query
  6156. name: reusing[key]
  6157. type: string
  6158. produces:
  6159. - application/json
  6160. responses:
  6161. "200":
  6162. description: OK
  6163. "400":
  6164. description: Bad Request
  6165. security:
  6166. - ApiKeyAuth: []
  6167. summary: Test Embed MCP Streamable Server
  6168. tags:
  6169. - embedmcp
  6170. /api/test-embedmcp/{id}/sse:
  6171. get:
  6172. description: Test Embed MCP SSE Server
  6173. parameters:
  6174. - description: MCP ID
  6175. in: path
  6176. name: id
  6177. required: true
  6178. type: string
  6179. - description: Initial configuration parameters (e.g. config[host]=http://localhost:3000)
  6180. in: query
  6181. name: config[key]
  6182. type: string
  6183. - description: Reusing configuration parameters (e.g. reusing[authorization]=apikey)
  6184. in: query
  6185. name: reusing[key]
  6186. type: string
  6187. responses:
  6188. "200":
  6189. description: OK
  6190. "400":
  6191. description: Bad Request
  6192. security:
  6193. - ApiKeyAuth: []
  6194. summary: Test Embed MCP SSE Server
  6195. tags:
  6196. - embedmcp
  6197. /api/test-publicmcp/{group}/{id}/sse:
  6198. get:
  6199. parameters:
  6200. - description: Group ID
  6201. in: path
  6202. name: group
  6203. required: true
  6204. type: string
  6205. - description: MCP ID
  6206. in: path
  6207. name: id
  6208. required: true
  6209. type: string
  6210. responses: {}
  6211. security:
  6212. - ApiKeyAuth: []
  6213. summary: Test Public MCP SSE Server
  6214. /api/token/{group}:
  6215. post:
  6216. consumes:
  6217. - application/json
  6218. description: Adds a new token to a specific group
  6219. parameters:
  6220. - description: Group name
  6221. in: path
  6222. name: group
  6223. required: true
  6224. type: string
  6225. - description: Auto create group
  6226. in: query
  6227. name: auto_create_group
  6228. type: boolean
  6229. - description: Ignore exist
  6230. in: query
  6231. name: ignore_exist
  6232. type: boolean
  6233. - description: Token information
  6234. in: body
  6235. name: token
  6236. required: true
  6237. schema:
  6238. $ref: '#/definitions/controller.AddTokenRequest'
  6239. produces:
  6240. - application/json
  6241. responses:
  6242. "200":
  6243. description: OK
  6244. schema:
  6245. allOf:
  6246. - $ref: '#/definitions/middleware.APIResponse'
  6247. - properties:
  6248. data:
  6249. $ref: '#/definitions/controller.TokenResponse'
  6250. type: object
  6251. security:
  6252. - ApiKeyAuth: []
  6253. summary: Add group token
  6254. tags:
  6255. - token
  6256. /api/token/{group}/{id}:
  6257. delete:
  6258. description: Deletes a specific token from a group
  6259. parameters:
  6260. - description: Group name
  6261. in: path
  6262. name: group
  6263. required: true
  6264. type: string
  6265. - description: Token ID
  6266. in: path
  6267. name: id
  6268. required: true
  6269. type: integer
  6270. produces:
  6271. - application/json
  6272. responses:
  6273. "200":
  6274. description: OK
  6275. schema:
  6276. $ref: '#/definitions/middleware.APIResponse'
  6277. security:
  6278. - ApiKeyAuth: []
  6279. summary: Delete group token
  6280. tags:
  6281. - token
  6282. get:
  6283. description: Returns detailed information about a specific token for a specific
  6284. group
  6285. parameters:
  6286. - description: Group name
  6287. in: path
  6288. name: group
  6289. required: true
  6290. type: string
  6291. - description: Token ID
  6292. in: path
  6293. name: id
  6294. required: true
  6295. type: integer
  6296. produces:
  6297. - application/json
  6298. responses:
  6299. "200":
  6300. description: OK
  6301. schema:
  6302. allOf:
  6303. - $ref: '#/definitions/middleware.APIResponse'
  6304. - properties:
  6305. data:
  6306. $ref: '#/definitions/controller.TokenResponse'
  6307. type: object
  6308. security:
  6309. - ApiKeyAuth: []
  6310. summary: Get token by ID for a specific group
  6311. tags:
  6312. - token
  6313. put:
  6314. consumes:
  6315. - application/json
  6316. description: Updates an existing token in a specific group
  6317. parameters:
  6318. - description: Group name
  6319. in: path
  6320. name: group
  6321. required: true
  6322. type: string
  6323. - description: Token ID
  6324. in: path
  6325. name: id
  6326. required: true
  6327. type: integer
  6328. - description: Updated token information
  6329. in: body
  6330. name: token
  6331. required: true
  6332. schema:
  6333. $ref: '#/definitions/model.UpdateTokenRequest'
  6334. produces:
  6335. - application/json
  6336. responses:
  6337. "200":
  6338. description: OK
  6339. schema:
  6340. allOf:
  6341. - $ref: '#/definitions/middleware.APIResponse'
  6342. - properties:
  6343. data:
  6344. $ref: '#/definitions/controller.TokenResponse'
  6345. type: object
  6346. security:
  6347. - ApiKeyAuth: []
  6348. summary: Update group token
  6349. tags:
  6350. - token
  6351. /api/token/{group}/{id}/name:
  6352. post:
  6353. consumes:
  6354. - application/json
  6355. description: Updates the name of a token in a specific group
  6356. parameters:
  6357. - description: Group name
  6358. in: path
  6359. name: group
  6360. required: true
  6361. type: string
  6362. - description: Token ID
  6363. in: path
  6364. name: id
  6365. required: true
  6366. type: integer
  6367. - description: Name information
  6368. in: body
  6369. name: name
  6370. required: true
  6371. schema:
  6372. $ref: '#/definitions/controller.UpdateTokenNameRequest'
  6373. produces:
  6374. - application/json
  6375. responses:
  6376. "200":
  6377. description: OK
  6378. schema:
  6379. $ref: '#/definitions/middleware.APIResponse'
  6380. security:
  6381. - ApiKeyAuth: []
  6382. summary: Update group token name
  6383. tags:
  6384. - token
  6385. /api/token/{group}/{id}/status:
  6386. post:
  6387. consumes:
  6388. - application/json
  6389. description: Updates the status of a token in a specific group
  6390. parameters:
  6391. - description: Group name
  6392. in: path
  6393. name: group
  6394. required: true
  6395. type: string
  6396. - description: Token ID
  6397. in: path
  6398. name: id
  6399. required: true
  6400. type: integer
  6401. - description: Status information
  6402. in: body
  6403. name: status
  6404. required: true
  6405. schema:
  6406. $ref: '#/definitions/controller.UpdateTokenStatusRequest'
  6407. produces:
  6408. - application/json
  6409. responses:
  6410. "200":
  6411. description: OK
  6412. schema:
  6413. $ref: '#/definitions/middleware.APIResponse'
  6414. security:
  6415. - ApiKeyAuth: []
  6416. summary: Update group token status
  6417. tags:
  6418. - token
  6419. /api/token/{group}/batch_delete:
  6420. post:
  6421. description: Deletes multiple tokens from a specific group
  6422. parameters:
  6423. - description: Group name
  6424. in: path
  6425. name: group
  6426. required: true
  6427. type: string
  6428. - description: Token IDs
  6429. in: body
  6430. name: ids
  6431. required: true
  6432. schema:
  6433. items:
  6434. type: integer
  6435. type: array
  6436. produces:
  6437. - application/json
  6438. responses:
  6439. "200":
  6440. description: OK
  6441. schema:
  6442. $ref: '#/definitions/middleware.APIResponse'
  6443. security:
  6444. - ApiKeyAuth: []
  6445. summary: Delete group tokens
  6446. tags:
  6447. - token
  6448. /api/token/{group}/search:
  6449. get:
  6450. description: Returns a paginated list of tokens for a specific group based on
  6451. search criteria
  6452. parameters:
  6453. - description: Group name
  6454. in: path
  6455. name: group
  6456. required: true
  6457. type: string
  6458. - description: Keyword
  6459. in: query
  6460. name: keyword
  6461. type: string
  6462. - description: Page number
  6463. in: query
  6464. name: page
  6465. type: integer
  6466. - description: Items per page
  6467. in: query
  6468. name: per_page
  6469. type: integer
  6470. - description: Order
  6471. in: query
  6472. name: order
  6473. type: string
  6474. - description: Name
  6475. in: query
  6476. name: name
  6477. type: string
  6478. - description: Key
  6479. in: query
  6480. name: key
  6481. type: string
  6482. - description: Status
  6483. in: query
  6484. name: status
  6485. type: integer
  6486. produces:
  6487. - application/json
  6488. responses:
  6489. "200":
  6490. description: OK
  6491. schema:
  6492. allOf:
  6493. - $ref: '#/definitions/middleware.APIResponse'
  6494. - properties:
  6495. data:
  6496. additionalProperties:
  6497. allOf:
  6498. - {}
  6499. - properties:
  6500. tokens:
  6501. items:
  6502. $ref: '#/definitions/controller.TokenResponse'
  6503. type: array
  6504. total:
  6505. type: integer
  6506. type: object
  6507. type: object
  6508. type: object
  6509. security:
  6510. - ApiKeyAuth: []
  6511. summary: Search tokens for a specific group
  6512. tags:
  6513. - token
  6514. /api/tokens/:
  6515. get:
  6516. description: Returns a paginated list of all tokens
  6517. parameters:
  6518. - description: Page number
  6519. in: query
  6520. name: page
  6521. type: integer
  6522. - description: Items per page
  6523. in: query
  6524. name: per_page
  6525. type: integer
  6526. - description: Group name
  6527. in: query
  6528. name: group
  6529. type: string
  6530. - description: Order
  6531. in: query
  6532. name: order
  6533. type: string
  6534. - description: Status
  6535. in: query
  6536. name: status
  6537. type: integer
  6538. produces:
  6539. - application/json
  6540. responses:
  6541. "200":
  6542. description: OK
  6543. schema:
  6544. allOf:
  6545. - $ref: '#/definitions/middleware.APIResponse'
  6546. - properties:
  6547. data:
  6548. additionalProperties:
  6549. allOf:
  6550. - {}
  6551. - properties:
  6552. tokens:
  6553. items:
  6554. $ref: '#/definitions/controller.TokenResponse'
  6555. type: array
  6556. total:
  6557. type: integer
  6558. type: object
  6559. type: object
  6560. type: object
  6561. security:
  6562. - ApiKeyAuth: []
  6563. summary: Get all tokens
  6564. tags:
  6565. - tokens
  6566. /api/tokens/{group}:
  6567. get:
  6568. description: Returns a paginated list of all tokens for a specific group
  6569. parameters:
  6570. - description: Group name
  6571. in: path
  6572. name: group
  6573. required: true
  6574. type: string
  6575. - description: Page number
  6576. in: query
  6577. name: page
  6578. type: integer
  6579. - description: Items per page
  6580. in: query
  6581. name: per_page
  6582. type: integer
  6583. - description: Order
  6584. in: query
  6585. name: order
  6586. type: string
  6587. - description: Status
  6588. in: query
  6589. name: status
  6590. type: integer
  6591. produces:
  6592. - application/json
  6593. responses:
  6594. "200":
  6595. description: OK
  6596. schema:
  6597. allOf:
  6598. - $ref: '#/definitions/middleware.APIResponse'
  6599. - properties:
  6600. data:
  6601. additionalProperties:
  6602. allOf:
  6603. - {}
  6604. - properties:
  6605. tokens:
  6606. items:
  6607. $ref: '#/definitions/controller.TokenResponse'
  6608. type: array
  6609. total:
  6610. type: integer
  6611. type: object
  6612. type: object
  6613. type: object
  6614. security:
  6615. - ApiKeyAuth: []
  6616. summary: Get all tokens for a specific group
  6617. tags:
  6618. - tokens
  6619. /api/tokens/{id}:
  6620. delete:
  6621. description: Deletes a specific token by ID
  6622. parameters:
  6623. - description: Token ID
  6624. in: path
  6625. name: id
  6626. required: true
  6627. type: integer
  6628. produces:
  6629. - application/json
  6630. responses:
  6631. "200":
  6632. description: OK
  6633. schema:
  6634. $ref: '#/definitions/middleware.APIResponse'
  6635. security:
  6636. - ApiKeyAuth: []
  6637. summary: Delete token
  6638. tags:
  6639. - tokens
  6640. get:
  6641. description: Returns detailed information about a specific token
  6642. parameters:
  6643. - description: Token ID
  6644. in: path
  6645. name: id
  6646. required: true
  6647. type: integer
  6648. produces:
  6649. - application/json
  6650. responses:
  6651. "200":
  6652. description: OK
  6653. schema:
  6654. allOf:
  6655. - $ref: '#/definitions/middleware.APIResponse'
  6656. - properties:
  6657. data:
  6658. $ref: '#/definitions/controller.TokenResponse'
  6659. type: object
  6660. security:
  6661. - ApiKeyAuth: []
  6662. summary: Get token by ID
  6663. tags:
  6664. - tokens
  6665. put:
  6666. consumes:
  6667. - application/json
  6668. description: Updates an existing token's information
  6669. parameters:
  6670. - description: Token ID
  6671. in: path
  6672. name: id
  6673. required: true
  6674. type: integer
  6675. - description: Updated token information
  6676. in: body
  6677. name: token
  6678. required: true
  6679. schema:
  6680. $ref: '#/definitions/model.UpdateTokenRequest'
  6681. produces:
  6682. - application/json
  6683. responses:
  6684. "200":
  6685. description: OK
  6686. schema:
  6687. allOf:
  6688. - $ref: '#/definitions/middleware.APIResponse'
  6689. - properties:
  6690. data:
  6691. $ref: '#/definitions/controller.TokenResponse'
  6692. type: object
  6693. security:
  6694. - ApiKeyAuth: []
  6695. summary: Update token
  6696. tags:
  6697. - tokens
  6698. /api/tokens/{id}/name:
  6699. post:
  6700. consumes:
  6701. - application/json
  6702. description: Updates the name of a specific token
  6703. parameters:
  6704. - description: Token ID
  6705. in: path
  6706. name: id
  6707. required: true
  6708. type: integer
  6709. - description: Name information
  6710. in: body
  6711. name: name
  6712. required: true
  6713. schema:
  6714. $ref: '#/definitions/controller.UpdateTokenNameRequest'
  6715. produces:
  6716. - application/json
  6717. responses:
  6718. "200":
  6719. description: OK
  6720. schema:
  6721. $ref: '#/definitions/middleware.APIResponse'
  6722. security:
  6723. - ApiKeyAuth: []
  6724. summary: Update token name
  6725. tags:
  6726. - tokens
  6727. /api/tokens/{id}/status:
  6728. post:
  6729. consumes:
  6730. - application/json
  6731. description: Updates the status of a specific token
  6732. parameters:
  6733. - description: Token ID
  6734. in: path
  6735. name: id
  6736. required: true
  6737. type: integer
  6738. - description: Status information
  6739. in: body
  6740. name: status
  6741. required: true
  6742. schema:
  6743. $ref: '#/definitions/controller.UpdateTokenStatusRequest'
  6744. produces:
  6745. - application/json
  6746. responses:
  6747. "200":
  6748. description: OK
  6749. schema:
  6750. $ref: '#/definitions/middleware.APIResponse'
  6751. security:
  6752. - ApiKeyAuth: []
  6753. summary: Update token status
  6754. tags:
  6755. - tokens
  6756. /api/tokens/batch_delete:
  6757. post:
  6758. consumes:
  6759. - application/json
  6760. description: Deletes multiple tokens by their IDs
  6761. parameters:
  6762. - description: Token IDs
  6763. in: body
  6764. name: ids
  6765. required: true
  6766. schema:
  6767. items:
  6768. type: integer
  6769. type: array
  6770. produces:
  6771. - application/json
  6772. responses:
  6773. "200":
  6774. description: OK
  6775. schema:
  6776. $ref: '#/definitions/middleware.APIResponse'
  6777. security:
  6778. - ApiKeyAuth: []
  6779. summary: Delete multiple tokens
  6780. tags:
  6781. - tokens
  6782. /api/tokens/search:
  6783. get:
  6784. description: Returns a paginated list of tokens based on search criteria
  6785. parameters:
  6786. - description: Keyword
  6787. in: query
  6788. name: keyword
  6789. type: string
  6790. - description: Page number
  6791. in: query
  6792. name: page
  6793. type: integer
  6794. - description: Items per page
  6795. in: query
  6796. name: per_page
  6797. type: integer
  6798. - description: Order
  6799. in: query
  6800. name: order
  6801. type: string
  6802. - description: Name
  6803. in: query
  6804. name: name
  6805. type: string
  6806. - description: Key
  6807. in: query
  6808. name: key
  6809. type: string
  6810. - description: Status
  6811. in: query
  6812. name: status
  6813. type: integer
  6814. - description: Group
  6815. in: query
  6816. name: group
  6817. type: string
  6818. produces:
  6819. - application/json
  6820. responses:
  6821. "200":
  6822. description: OK
  6823. schema:
  6824. allOf:
  6825. - $ref: '#/definitions/middleware.APIResponse'
  6826. - properties:
  6827. data:
  6828. additionalProperties:
  6829. allOf:
  6830. - {}
  6831. - properties:
  6832. tokens:
  6833. items:
  6834. $ref: '#/definitions/controller.TokenResponse'
  6835. type: array
  6836. total:
  6837. type: integer
  6838. type: object
  6839. type: object
  6840. type: object
  6841. security:
  6842. - ApiKeyAuth: []
  6843. summary: Search tokens
  6844. tags:
  6845. - tokens
  6846. /mcp:
  6847. delete:
  6848. responses: {}
  6849. security:
  6850. - ApiKeyAuth: []
  6851. summary: Host MCP Streamable Server
  6852. get:
  6853. responses: {}
  6854. security:
  6855. - ApiKeyAuth: []
  6856. summary: Host MCP Streamable Server
  6857. post:
  6858. responses: {}
  6859. security:
  6860. - ApiKeyAuth: []
  6861. summary: Host MCP Streamable Server
  6862. /mcp/group/{id}:
  6863. delete:
  6864. responses: {}
  6865. security:
  6866. - ApiKeyAuth: []
  6867. summary: Group MCP Streamable Server
  6868. get:
  6869. responses: {}
  6870. security:
  6871. - ApiKeyAuth: []
  6872. summary: Group MCP Streamable Server
  6873. post:
  6874. responses: {}
  6875. security:
  6876. - ApiKeyAuth: []
  6877. summary: Group MCP Streamable Server
  6878. /mcp/group/{id}/sse:
  6879. get:
  6880. responses: {}
  6881. security:
  6882. - ApiKeyAuth: []
  6883. summary: Group MCP SSE Server
  6884. /mcp/public/{id}:
  6885. delete:
  6886. responses: {}
  6887. security:
  6888. - ApiKeyAuth: []
  6889. summary: Public MCP Streamable Server
  6890. get:
  6891. responses: {}
  6892. security:
  6893. - ApiKeyAuth: []
  6894. summary: Public MCP Streamable Server
  6895. post:
  6896. responses: {}
  6897. security:
  6898. - ApiKeyAuth: []
  6899. summary: Public MCP Streamable Server
  6900. /mcp/public/{id}/sse:
  6901. get:
  6902. responses: {}
  6903. security:
  6904. - ApiKeyAuth: []
  6905. summary: Public MCP SSE Server
  6906. /message:
  6907. post:
  6908. responses: {}
  6909. summary: MCP SSE Message
  6910. /sse:
  6911. get:
  6912. responses: {}
  6913. security:
  6914. - ApiKeyAuth: []
  6915. summary: Public MCP SSE Server
  6916. /v1/audio/speech:
  6917. post:
  6918. description: AudioSpeech
  6919. parameters:
  6920. - description: Request
  6921. in: body
  6922. name: request
  6923. required: true
  6924. schema:
  6925. $ref: '#/definitions/model.TextToSpeechRequest'
  6926. - description: Optional Aiproxy-Channel header
  6927. in: header
  6928. name: Aiproxy-Channel
  6929. type: string
  6930. produces:
  6931. - application/json
  6932. responses:
  6933. "200":
  6934. description: audio binary
  6935. headers:
  6936. X-RateLimit-Limit-Requests:
  6937. description: X-RateLimit-Limit-Requests
  6938. type: integer
  6939. X-RateLimit-Limit-Tokens:
  6940. description: X-RateLimit-Limit-Tokens
  6941. type: integer
  6942. X-RateLimit-Remaining-Requests:
  6943. description: X-RateLimit-Remaining-Requests
  6944. type: integer
  6945. X-RateLimit-Remaining-Tokens:
  6946. description: X-RateLimit-Remaining-Tokens
  6947. type: integer
  6948. X-RateLimit-Reset-Requests:
  6949. description: X-RateLimit-Reset-Requests
  6950. type: string
  6951. X-RateLimit-Reset-Tokens:
  6952. description: X-RateLimit-Reset-Tokens
  6953. type: string
  6954. schema:
  6955. type: file
  6956. security:
  6957. - ApiKeyAuth: []
  6958. summary: AudioSpeech
  6959. tags:
  6960. - relay
  6961. /v1/audio/transcriptions:
  6962. post:
  6963. description: AudioTranscription
  6964. parameters:
  6965. - description: Model
  6966. in: formData
  6967. name: model
  6968. required: true
  6969. type: string
  6970. - description: File
  6971. in: formData
  6972. name: file
  6973. required: true
  6974. type: file
  6975. - description: Optional Aiproxy-Channel header
  6976. in: header
  6977. name: Aiproxy-Channel
  6978. type: string
  6979. produces:
  6980. - application/json
  6981. responses:
  6982. "200":
  6983. description: OK
  6984. headers:
  6985. X-RateLimit-Limit-Requests:
  6986. description: X-RateLimit-Limit-Requests
  6987. type: integer
  6988. X-RateLimit-Limit-Tokens:
  6989. description: X-RateLimit-Limit-Tokens
  6990. type: integer
  6991. X-RateLimit-Remaining-Requests:
  6992. description: X-RateLimit-Remaining-Requests
  6993. type: integer
  6994. X-RateLimit-Remaining-Tokens:
  6995. description: X-RateLimit-Remaining-Tokens
  6996. type: integer
  6997. X-RateLimit-Reset-Requests:
  6998. description: X-RateLimit-Reset-Requests
  6999. type: string
  7000. X-RateLimit-Reset-Tokens:
  7001. description: X-RateLimit-Reset-Tokens
  7002. type: string
  7003. schema:
  7004. $ref: '#/definitions/model.SttJSONResponse'
  7005. security:
  7006. - ApiKeyAuth: []
  7007. summary: AudioTranscription
  7008. tags:
  7009. - relay
  7010. /v1/audio/translations:
  7011. post:
  7012. description: AudioTranslation
  7013. parameters:
  7014. - description: Model
  7015. in: formData
  7016. name: model
  7017. required: true
  7018. type: string
  7019. - description: File
  7020. in: formData
  7021. name: file
  7022. required: true
  7023. type: file
  7024. - description: Optional Aiproxy-Channel header
  7025. in: header
  7026. name: Aiproxy-Channel
  7027. type: string
  7028. produces:
  7029. - application/json
  7030. responses:
  7031. "200":
  7032. description: OK
  7033. headers:
  7034. X-RateLimit-Limit-Requests:
  7035. description: X-RateLimit-Limit-Requests
  7036. type: integer
  7037. X-RateLimit-Limit-Tokens:
  7038. description: X-RateLimit-Limit-Tokens
  7039. type: integer
  7040. X-RateLimit-Remaining-Requests:
  7041. description: X-RateLimit-Remaining-Requests
  7042. type: integer
  7043. X-RateLimit-Remaining-Tokens:
  7044. description: X-RateLimit-Remaining-Tokens
  7045. type: integer
  7046. X-RateLimit-Reset-Requests:
  7047. description: X-RateLimit-Reset-Requests
  7048. type: string
  7049. X-RateLimit-Reset-Tokens:
  7050. description: X-RateLimit-Reset-Tokens
  7051. type: string
  7052. schema:
  7053. $ref: '#/definitions/model.SttJSONResponse'
  7054. security:
  7055. - ApiKeyAuth: []
  7056. summary: AudioTranslation
  7057. tags:
  7058. - relay
  7059. /v1/chat/completions:
  7060. post:
  7061. description: ChatCompletions
  7062. parameters:
  7063. - description: Request
  7064. in: body
  7065. name: request
  7066. required: true
  7067. schema:
  7068. $ref: '#/definitions/model.GeneralOpenAIRequest'
  7069. - description: Optional Aiproxy-Channel header
  7070. in: header
  7071. name: Aiproxy-Channel
  7072. type: string
  7073. produces:
  7074. - application/json
  7075. responses:
  7076. "200":
  7077. description: OK
  7078. headers:
  7079. X-RateLimit-Limit-Requests:
  7080. description: X-RateLimit-Limit-Requests
  7081. type: integer
  7082. X-RateLimit-Limit-Tokens:
  7083. description: X-RateLimit-Limit-Tokens
  7084. type: integer
  7085. X-RateLimit-Remaining-Requests:
  7086. description: X-RateLimit-Remaining-Requests
  7087. type: integer
  7088. X-RateLimit-Remaining-Tokens:
  7089. description: X-RateLimit-Remaining-Tokens
  7090. type: integer
  7091. X-RateLimit-Reset-Requests:
  7092. description: X-RateLimit-Reset-Requests
  7093. type: string
  7094. X-RateLimit-Reset-Tokens:
  7095. description: X-RateLimit-Reset-Tokens
  7096. type: string
  7097. schema:
  7098. $ref: '#/definitions/model.TextResponse'
  7099. security:
  7100. - ApiKeyAuth: []
  7101. summary: ChatCompletions
  7102. tags:
  7103. - relay
  7104. /v1/completions:
  7105. post:
  7106. description: Completions
  7107. parameters:
  7108. - description: Request
  7109. in: body
  7110. name: request
  7111. required: true
  7112. schema:
  7113. $ref: '#/definitions/model.GeneralOpenAIRequest'
  7114. - description: Optional Aiproxy-Channel header
  7115. in: header
  7116. name: Aiproxy-Channel
  7117. type: string
  7118. produces:
  7119. - application/json
  7120. responses:
  7121. "200":
  7122. description: OK
  7123. headers:
  7124. X-RateLimit-Limit-Requests:
  7125. description: X-RateLimit-Limit-Requests
  7126. type: integer
  7127. X-RateLimit-Limit-Tokens:
  7128. description: X-RateLimit-Limit-Tokens
  7129. type: integer
  7130. X-RateLimit-Remaining-Requests:
  7131. description: X-RateLimit-Remaining-Requests
  7132. type: integer
  7133. X-RateLimit-Remaining-Tokens:
  7134. description: X-RateLimit-Remaining-Tokens
  7135. type: integer
  7136. X-RateLimit-Reset-Requests:
  7137. description: X-RateLimit-Reset-Requests
  7138. type: string
  7139. X-RateLimit-Reset-Tokens:
  7140. description: X-RateLimit-Reset-Tokens
  7141. type: string
  7142. schema:
  7143. $ref: '#/definitions/model.TextResponse'
  7144. security:
  7145. - ApiKeyAuth: []
  7146. summary: Completions
  7147. tags:
  7148. - relay
  7149. /v1/dashboard/billing/subscription:
  7150. get:
  7151. description: Get subscription
  7152. produces:
  7153. - application/json
  7154. responses:
  7155. "200":
  7156. description: OK
  7157. schema:
  7158. $ref: '#/definitions/openai.SubscriptionResponse'
  7159. security:
  7160. - ApiKeyAuth: []
  7161. summary: Get subscription
  7162. tags:
  7163. - relay
  7164. /v1/dashboard/billing/usage:
  7165. get:
  7166. description: Get usage
  7167. produces:
  7168. - application/json
  7169. responses:
  7170. "200":
  7171. description: OK
  7172. schema:
  7173. $ref: '#/definitions/openai.UsageResponse'
  7174. security:
  7175. - ApiKeyAuth: []
  7176. summary: Get usage
  7177. tags:
  7178. - relay
  7179. /v1/embeddings:
  7180. post:
  7181. description: Embeddings
  7182. parameters:
  7183. - description: Request
  7184. in: body
  7185. name: request
  7186. required: true
  7187. schema:
  7188. $ref: '#/definitions/model.EmbeddingRequest'
  7189. - description: Optional Aiproxy-Channel header
  7190. in: header
  7191. name: Aiproxy-Channel
  7192. type: string
  7193. produces:
  7194. - application/json
  7195. responses:
  7196. "200":
  7197. description: OK
  7198. headers:
  7199. X-RateLimit-Limit-Requests:
  7200. description: X-RateLimit-Limit-Requests
  7201. type: integer
  7202. X-RateLimit-Limit-Tokens:
  7203. description: X-RateLimit-Limit-Tokens
  7204. type: integer
  7205. X-RateLimit-Remaining-Requests:
  7206. description: X-RateLimit-Remaining-Requests
  7207. type: integer
  7208. X-RateLimit-Remaining-Tokens:
  7209. description: X-RateLimit-Remaining-Tokens
  7210. type: integer
  7211. X-RateLimit-Reset-Requests:
  7212. description: X-RateLimit-Reset-Requests
  7213. type: string
  7214. X-RateLimit-Reset-Tokens:
  7215. description: X-RateLimit-Reset-Tokens
  7216. type: string
  7217. schema:
  7218. $ref: '#/definitions/model.EmbeddingResponse'
  7219. security:
  7220. - ApiKeyAuth: []
  7221. summary: Embeddings
  7222. tags:
  7223. - relay
  7224. /v1/images/edits:
  7225. post:
  7226. description: ImagesEdits
  7227. parameters:
  7228. - description: Prompt
  7229. in: formData
  7230. name: prompt
  7231. required: true
  7232. type: string
  7233. - description: Model
  7234. in: formData
  7235. name: model
  7236. required: true
  7237. type: string
  7238. - description: Images
  7239. in: formData
  7240. name: image
  7241. required: true
  7242. type: file
  7243. - description: Optional Aiproxy-Channel header
  7244. in: header
  7245. name: Aiproxy-Channel
  7246. type: string
  7247. produces:
  7248. - application/json
  7249. responses:
  7250. "200":
  7251. description: OK
  7252. headers:
  7253. X-RateLimit-Limit-Requests:
  7254. description: X-RateLimit-Limit-Requests
  7255. type: integer
  7256. X-RateLimit-Limit-Tokens:
  7257. description: X-RateLimit-Limit-Tokens
  7258. type: integer
  7259. X-RateLimit-Remaining-Requests:
  7260. description: X-RateLimit-Remaining-Requests
  7261. type: integer
  7262. X-RateLimit-Remaining-Tokens:
  7263. description: X-RateLimit-Remaining-Tokens
  7264. type: integer
  7265. X-RateLimit-Reset-Requests:
  7266. description: X-RateLimit-Reset-Requests
  7267. type: string
  7268. X-RateLimit-Reset-Tokens:
  7269. description: X-RateLimit-Reset-Tokens
  7270. type: string
  7271. schema:
  7272. $ref: '#/definitions/model.SttJSONResponse'
  7273. security:
  7274. - ApiKeyAuth: []
  7275. summary: ImagesEdits
  7276. tags:
  7277. - relay
  7278. /v1/images/generations:
  7279. post:
  7280. description: ImagesGenerations
  7281. parameters:
  7282. - description: Request
  7283. in: body
  7284. name: request
  7285. required: true
  7286. schema:
  7287. $ref: '#/definitions/model.ImageRequest'
  7288. - description: Optional Aiproxy-Channel header
  7289. in: header
  7290. name: Aiproxy-Channel
  7291. type: string
  7292. produces:
  7293. - application/json
  7294. responses:
  7295. "200":
  7296. description: OK
  7297. headers:
  7298. X-RateLimit-Limit-Requests:
  7299. description: X-RateLimit-Limit-Requests
  7300. type: integer
  7301. X-RateLimit-Limit-Tokens:
  7302. description: X-RateLimit-Limit-Tokens
  7303. type: integer
  7304. X-RateLimit-Remaining-Requests:
  7305. description: X-RateLimit-Remaining-Requests
  7306. type: integer
  7307. X-RateLimit-Remaining-Tokens:
  7308. description: X-RateLimit-Remaining-Tokens
  7309. type: integer
  7310. X-RateLimit-Reset-Requests:
  7311. description: X-RateLimit-Reset-Requests
  7312. type: string
  7313. X-RateLimit-Reset-Tokens:
  7314. description: X-RateLimit-Reset-Tokens
  7315. type: string
  7316. schema:
  7317. $ref: '#/definitions/model.ImageResponse'
  7318. security:
  7319. - ApiKeyAuth: []
  7320. summary: ImagesGenerations
  7321. tags:
  7322. - relay
  7323. /v1/messages:
  7324. post:
  7325. description: Anthropic
  7326. parameters:
  7327. - description: Request
  7328. in: body
  7329. name: request
  7330. required: true
  7331. schema:
  7332. $ref: '#/definitions/model.AnthropicMessageRequest'
  7333. - description: Optional Aiproxy-Channel header
  7334. in: header
  7335. name: Aiproxy-Channel
  7336. type: string
  7337. produces:
  7338. - application/json
  7339. responses:
  7340. "200":
  7341. description: OK
  7342. headers:
  7343. X-RateLimit-Limit-Requests:
  7344. description: X-RateLimit-Limit-Requests
  7345. type: integer
  7346. X-RateLimit-Limit-Tokens:
  7347. description: X-RateLimit-Limit-Tokens
  7348. type: integer
  7349. X-RateLimit-Remaining-Requests:
  7350. description: X-RateLimit-Remaining-Requests
  7351. type: integer
  7352. X-RateLimit-Remaining-Tokens:
  7353. description: X-RateLimit-Remaining-Tokens
  7354. type: integer
  7355. X-RateLimit-Reset-Requests:
  7356. description: X-RateLimit-Reset-Requests
  7357. type: string
  7358. X-RateLimit-Reset-Tokens:
  7359. description: X-RateLimit-Reset-Tokens
  7360. type: string
  7361. schema:
  7362. $ref: '#/definitions/model.TextResponse'
  7363. security:
  7364. - ApiKeyAuth: []
  7365. summary: Anthropic
  7366. tags:
  7367. - relay
  7368. /v1/models:
  7369. get:
  7370. description: List all models
  7371. produces:
  7372. - application/json
  7373. responses:
  7374. "200":
  7375. description: OK
  7376. schema:
  7377. properties:
  7378. data:
  7379. items:
  7380. $ref: '#/definitions/controller.OpenAIModels'
  7381. type: array
  7382. object:
  7383. type: string
  7384. type: object
  7385. security:
  7386. - ApiKeyAuth: []
  7387. summary: List models
  7388. tags:
  7389. - relay
  7390. /v1/models/{model}:
  7391. get:
  7392. description: Retrieve a model
  7393. produces:
  7394. - application/json
  7395. responses:
  7396. "200":
  7397. description: OK
  7398. schema:
  7399. $ref: '#/definitions/controller.OpenAIModels'
  7400. security:
  7401. - ApiKeyAuth: []
  7402. summary: Retrieve model
  7403. tags:
  7404. - relay
  7405. /v1/parse/pdf:
  7406. post:
  7407. description: ParsePdf
  7408. parameters:
  7409. - description: Model
  7410. in: formData
  7411. name: model
  7412. required: true
  7413. type: string
  7414. - description: File
  7415. in: formData
  7416. name: file
  7417. required: true
  7418. type: file
  7419. - description: Optional Aiproxy-Channel header
  7420. in: header
  7421. name: Aiproxy-Channel
  7422. type: string
  7423. produces:
  7424. - application/json
  7425. responses:
  7426. "200":
  7427. description: OK
  7428. headers:
  7429. X-RateLimit-Limit-Requests:
  7430. description: X-RateLimit-Limit-Requests
  7431. type: integer
  7432. X-RateLimit-Limit-Tokens:
  7433. description: X-RateLimit-Limit-Tokens
  7434. type: integer
  7435. X-RateLimit-Remaining-Requests:
  7436. description: X-RateLimit-Remaining-Requests
  7437. type: integer
  7438. X-RateLimit-Remaining-Tokens:
  7439. description: X-RateLimit-Remaining-Tokens
  7440. type: integer
  7441. X-RateLimit-Reset-Requests:
  7442. description: X-RateLimit-Reset-Requests
  7443. type: string
  7444. X-RateLimit-Reset-Tokens:
  7445. description: X-RateLimit-Reset-Tokens
  7446. type: string
  7447. schema:
  7448. $ref: '#/definitions/model.ParsePdfResponse'
  7449. security:
  7450. - ApiKeyAuth: []
  7451. summary: ParsePdf
  7452. tags:
  7453. - relay
  7454. /v1/rerank:
  7455. post:
  7456. description: Rerank
  7457. parameters:
  7458. - description: Request
  7459. in: body
  7460. name: request
  7461. required: true
  7462. schema:
  7463. $ref: '#/definitions/model.RerankRequest'
  7464. - description: Optional Aiproxy-Channel header
  7465. in: header
  7466. name: Aiproxy-Channel
  7467. type: string
  7468. produces:
  7469. - application/json
  7470. responses:
  7471. "200":
  7472. description: OK
  7473. headers:
  7474. X-RateLimit-Limit-Requests:
  7475. description: X-RateLimit-Limit-Requests
  7476. type: integer
  7477. X-RateLimit-Limit-Tokens:
  7478. description: X-RateLimit-Limit-Tokens
  7479. type: integer
  7480. X-RateLimit-Remaining-Requests:
  7481. description: X-RateLimit-Remaining-Requests
  7482. type: integer
  7483. X-RateLimit-Remaining-Tokens:
  7484. description: X-RateLimit-Remaining-Tokens
  7485. type: integer
  7486. X-RateLimit-Reset-Requests:
  7487. description: X-RateLimit-Reset-Requests
  7488. type: string
  7489. X-RateLimit-Reset-Tokens:
  7490. description: X-RateLimit-Reset-Tokens
  7491. type: string
  7492. schema:
  7493. $ref: '#/definitions/model.RerankResponse'
  7494. security:
  7495. - ApiKeyAuth: []
  7496. summary: Rerank
  7497. tags:
  7498. - relay
  7499. /v1/responses:
  7500. post:
  7501. description: Create a new response
  7502. parameters:
  7503. - description: Request
  7504. in: body
  7505. name: request
  7506. required: true
  7507. schema:
  7508. $ref: '#/definitions/model.CreateResponseRequest'
  7509. - description: Optional Aiproxy-Channel header
  7510. in: header
  7511. name: Aiproxy-Channel
  7512. type: string
  7513. produces:
  7514. - application/json
  7515. responses:
  7516. "200":
  7517. description: OK
  7518. headers:
  7519. X-RateLimit-Limit-Requests:
  7520. description: X-RateLimit-Limit-Requests
  7521. type: integer
  7522. X-RateLimit-Limit-Tokens:
  7523. description: X-RateLimit-Limit-Tokens
  7524. type: integer
  7525. X-RateLimit-Remaining-Requests:
  7526. description: X-RateLimit-Remaining-Requests
  7527. type: integer
  7528. X-RateLimit-Remaining-Tokens:
  7529. description: X-RateLimit-Remaining-Tokens
  7530. type: integer
  7531. X-RateLimit-Reset-Requests:
  7532. description: X-RateLimit-Reset-Requests
  7533. type: string
  7534. X-RateLimit-Reset-Tokens:
  7535. description: X-RateLimit-Reset-Tokens
  7536. type: string
  7537. schema:
  7538. $ref: '#/definitions/model.Response'
  7539. security:
  7540. - ApiKeyAuth: []
  7541. summary: Create response
  7542. tags:
  7543. - relay
  7544. /v1/responses/{response_id}:
  7545. delete:
  7546. description: Delete a response by ID
  7547. parameters:
  7548. - description: Response ID
  7549. in: path
  7550. name: response_id
  7551. required: true
  7552. type: string
  7553. - description: Optional Aiproxy-Channel header
  7554. in: header
  7555. name: Aiproxy-Channel
  7556. type: string
  7557. produces:
  7558. - application/json
  7559. responses:
  7560. "204":
  7561. description: No Content
  7562. security:
  7563. - ApiKeyAuth: []
  7564. summary: Delete response
  7565. tags:
  7566. - relay
  7567. get:
  7568. description: Get a response by ID
  7569. parameters:
  7570. - description: Response ID
  7571. in: path
  7572. name: response_id
  7573. required: true
  7574. type: string
  7575. - description: Optional Aiproxy-Channel header
  7576. in: header
  7577. name: Aiproxy-Channel
  7578. type: string
  7579. produces:
  7580. - application/json
  7581. responses:
  7582. "200":
  7583. description: OK
  7584. schema:
  7585. $ref: '#/definitions/model.Response'
  7586. security:
  7587. - ApiKeyAuth: []
  7588. summary: Get response
  7589. tags:
  7590. - relay
  7591. /v1/responses/{response_id}/cancel:
  7592. post:
  7593. description: Cancel a response by ID
  7594. parameters:
  7595. - description: Response ID
  7596. in: path
  7597. name: response_id
  7598. required: true
  7599. type: string
  7600. - description: Optional Aiproxy-Channel header
  7601. in: header
  7602. name: Aiproxy-Channel
  7603. type: string
  7604. produces:
  7605. - application/json
  7606. responses:
  7607. "200":
  7608. description: OK
  7609. schema:
  7610. $ref: '#/definitions/model.Response'
  7611. security:
  7612. - ApiKeyAuth: []
  7613. summary: Cancel response
  7614. tags:
  7615. - relay
  7616. /v1/responses/{response_id}/input_items:
  7617. get:
  7618. description: Get input items for a response
  7619. parameters:
  7620. - description: Response ID
  7621. in: path
  7622. name: response_id
  7623. required: true
  7624. type: string
  7625. - description: Optional Aiproxy-Channel header
  7626. in: header
  7627. name: Aiproxy-Channel
  7628. type: string
  7629. produces:
  7630. - application/json
  7631. responses:
  7632. "200":
  7633. description: OK
  7634. schema:
  7635. $ref: '#/definitions/model.InputItemList'
  7636. security:
  7637. - ApiKeyAuth: []
  7638. summary: Get response input items
  7639. tags:
  7640. - relay
  7641. /v1/video/generations/{id}/content/video:
  7642. get:
  7643. description: VideoGenerationsContent
  7644. parameters:
  7645. - description: Request
  7646. in: body
  7647. name: request
  7648. required: true
  7649. schema:
  7650. $ref: '#/definitions/model.VideoGenerationJobRequest'
  7651. - description: Optional Aiproxy-Channel header
  7652. in: header
  7653. name: Aiproxy-Channel
  7654. type: string
  7655. produces:
  7656. - application/json
  7657. responses:
  7658. "200":
  7659. description: video binary
  7660. headers:
  7661. X-RateLimit-Limit-Requests:
  7662. description: X-RateLimit-Limit-Requests
  7663. type: integer
  7664. X-RateLimit-Limit-Tokens:
  7665. description: X-RateLimit-Limit-Tokens
  7666. type: integer
  7667. X-RateLimit-Remaining-Requests:
  7668. description: X-RateLimit-Remaining-Requests
  7669. type: integer
  7670. X-RateLimit-Remaining-Tokens:
  7671. description: X-RateLimit-Remaining-Tokens
  7672. type: integer
  7673. X-RateLimit-Reset-Requests:
  7674. description: X-RateLimit-Reset-Requests
  7675. type: string
  7676. X-RateLimit-Reset-Tokens:
  7677. description: X-RateLimit-Reset-Tokens
  7678. type: string
  7679. schema:
  7680. type: file
  7681. security:
  7682. - ApiKeyAuth: []
  7683. summary: VideoGenerationsContent
  7684. tags:
  7685. - relay
  7686. /v1/video/generations/jobs:
  7687. post:
  7688. description: VideoGenerationsJobs
  7689. parameters:
  7690. - description: Request
  7691. in: body
  7692. name: request
  7693. required: true
  7694. schema:
  7695. $ref: '#/definitions/model.VideoGenerationJobRequest'
  7696. - description: Optional Aiproxy-Channel header
  7697. in: header
  7698. name: Aiproxy-Channel
  7699. type: string
  7700. produces:
  7701. - application/json
  7702. responses:
  7703. "200":
  7704. description: OK
  7705. headers:
  7706. X-RateLimit-Limit-Requests:
  7707. description: X-RateLimit-Limit-Requests
  7708. type: integer
  7709. X-RateLimit-Limit-Tokens:
  7710. description: X-RateLimit-Limit-Tokens
  7711. type: integer
  7712. X-RateLimit-Remaining-Requests:
  7713. description: X-RateLimit-Remaining-Requests
  7714. type: integer
  7715. X-RateLimit-Remaining-Tokens:
  7716. description: X-RateLimit-Remaining-Tokens
  7717. type: integer
  7718. X-RateLimit-Reset-Requests:
  7719. description: X-RateLimit-Reset-Requests
  7720. type: string
  7721. X-RateLimit-Reset-Tokens:
  7722. description: X-RateLimit-Reset-Tokens
  7723. type: string
  7724. schema:
  7725. $ref: '#/definitions/model.VideoGenerationJob'
  7726. security:
  7727. - ApiKeyAuth: []
  7728. summary: VideoGenerationsJobs
  7729. tags:
  7730. - relay
  7731. /v1/video/generations/jobs/{id}:
  7732. get:
  7733. description: VideoGenerationsGetJobs
  7734. parameters:
  7735. - description: Request
  7736. in: body
  7737. name: request
  7738. required: true
  7739. schema:
  7740. $ref: '#/definitions/model.VideoGenerationJobRequest'
  7741. - description: Optional Aiproxy-Channel header
  7742. in: header
  7743. name: Aiproxy-Channel
  7744. type: string
  7745. produces:
  7746. - application/json
  7747. responses:
  7748. "200":
  7749. description: OK
  7750. headers:
  7751. X-RateLimit-Limit-Requests:
  7752. description: X-RateLimit-Limit-Requests
  7753. type: integer
  7754. X-RateLimit-Limit-Tokens:
  7755. description: X-RateLimit-Limit-Tokens
  7756. type: integer
  7757. X-RateLimit-Remaining-Requests:
  7758. description: X-RateLimit-Remaining-Requests
  7759. type: integer
  7760. X-RateLimit-Remaining-Tokens:
  7761. description: X-RateLimit-Remaining-Tokens
  7762. type: integer
  7763. X-RateLimit-Reset-Requests:
  7764. description: X-RateLimit-Reset-Requests
  7765. type: string
  7766. X-RateLimit-Reset-Tokens:
  7767. description: X-RateLimit-Reset-Tokens
  7768. type: string
  7769. schema:
  7770. $ref: '#/definitions/model.VideoGenerationJob'
  7771. security:
  7772. - ApiKeyAuth: []
  7773. summary: VideoGenerationsGetJobs
  7774. tags:
  7775. - relay
  7776. securityDefinitions:
  7777. ApiKeyAuth:
  7778. in: header
  7779. name: Authorization
  7780. type: apiKey
  7781. swagger: "2.0"