swagger.yaml 188 KB

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