openapi.json 502 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453
  1. {
  2. "openapi": "3.1.0",
  3. "info": {
  4. "title": "opencode",
  5. "version": "1.0.0",
  6. "description": "opencode api"
  7. },
  8. "paths": {
  9. "/auth/{providerID}": {
  10. "put": {
  11. "tags": ["control"],
  12. "operationId": "auth.set",
  13. "parameters": [
  14. {
  15. "name": "providerID",
  16. "in": "path",
  17. "schema": {
  18. "type": "string"
  19. },
  20. "required": true
  21. }
  22. ],
  23. "responses": {
  24. "200": {
  25. "description": "Successfully set authentication credentials",
  26. "content": {
  27. "application/json": {
  28. "schema": {
  29. "type": "boolean",
  30. "description": "Successfully set authentication credentials"
  31. }
  32. }
  33. }
  34. },
  35. "400": {
  36. "description": "Bad request",
  37. "content": {
  38. "application/json": {
  39. "schema": {
  40. "$ref": "#/components/schemas/BadRequestError"
  41. }
  42. }
  43. }
  44. }
  45. },
  46. "description": "Set authentication credentials",
  47. "summary": "Set auth credentials",
  48. "requestBody": {
  49. "content": {
  50. "application/json": {
  51. "schema": {
  52. "$ref": "#/components/schemas/Auth"
  53. }
  54. }
  55. }
  56. },
  57. "x-codeSamples": [
  58. {
  59. "lang": "js",
  60. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.auth.set({\n ...\n})"
  61. }
  62. ]
  63. },
  64. "delete": {
  65. "tags": ["control"],
  66. "operationId": "auth.remove",
  67. "parameters": [
  68. {
  69. "name": "providerID",
  70. "in": "path",
  71. "schema": {
  72. "type": "string"
  73. },
  74. "required": true
  75. }
  76. ],
  77. "responses": {
  78. "200": {
  79. "description": "Successfully removed authentication credentials",
  80. "content": {
  81. "application/json": {
  82. "schema": {
  83. "type": "boolean",
  84. "description": "Successfully removed authentication credentials"
  85. }
  86. }
  87. }
  88. },
  89. "400": {
  90. "description": "Bad request",
  91. "content": {
  92. "application/json": {
  93. "schema": {
  94. "$ref": "#/components/schemas/BadRequestError"
  95. }
  96. }
  97. }
  98. }
  99. },
  100. "description": "Remove authentication credentials",
  101. "summary": "Remove auth credentials",
  102. "x-codeSamples": [
  103. {
  104. "lang": "js",
  105. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.auth.remove({\n ...\n})"
  106. }
  107. ]
  108. }
  109. },
  110. "/log": {
  111. "post": {
  112. "tags": ["control"],
  113. "operationId": "app.log",
  114. "parameters": [
  115. {
  116. "name": "directory",
  117. "in": "query",
  118. "schema": {
  119. "type": "string"
  120. },
  121. "required": false
  122. },
  123. {
  124. "name": "workspace",
  125. "in": "query",
  126. "schema": {
  127. "type": "string"
  128. },
  129. "required": false
  130. }
  131. ],
  132. "responses": {
  133. "200": {
  134. "description": "Log entry written successfully",
  135. "content": {
  136. "application/json": {
  137. "schema": {
  138. "type": "boolean",
  139. "description": "Log entry written successfully"
  140. }
  141. }
  142. }
  143. },
  144. "400": {
  145. "description": "Bad request",
  146. "content": {
  147. "application/json": {
  148. "schema": {
  149. "$ref": "#/components/schemas/BadRequestError"
  150. }
  151. }
  152. }
  153. }
  154. },
  155. "description": "Write a log entry to the server logs with specified level and metadata.",
  156. "summary": "Write log",
  157. "requestBody": {
  158. "content": {
  159. "application/json": {
  160. "schema": {
  161. "type": "object",
  162. "properties": {
  163. "service": {
  164. "type": "string",
  165. "description": "Service name for the log entry"
  166. },
  167. "level": {
  168. "type": "string",
  169. "enum": ["debug", "info", "error", "warn"],
  170. "description": "Log level"
  171. },
  172. "message": {
  173. "type": "string",
  174. "description": "Log message"
  175. },
  176. "extra": {
  177. "type": "object"
  178. }
  179. },
  180. "required": ["service", "level", "message"],
  181. "additionalProperties": false
  182. }
  183. }
  184. }
  185. },
  186. "x-codeSamples": [
  187. {
  188. "lang": "js",
  189. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.app.log({\n ...\n})"
  190. }
  191. ]
  192. }
  193. },
  194. "/global/health": {
  195. "get": {
  196. "tags": ["global"],
  197. "operationId": "global.health",
  198. "parameters": [],
  199. "responses": {
  200. "200": {
  201. "description": "Health information",
  202. "content": {
  203. "application/json": {
  204. "schema": {
  205. "type": "object",
  206. "properties": {
  207. "healthy": {
  208. "type": "boolean",
  209. "enum": [true]
  210. },
  211. "version": {
  212. "type": "string"
  213. }
  214. },
  215. "required": ["healthy", "version"],
  216. "additionalProperties": false,
  217. "description": "Health information"
  218. }
  219. }
  220. }
  221. }
  222. },
  223. "description": "Get health information about the OpenCode server.",
  224. "summary": "Get health",
  225. "x-codeSamples": [
  226. {
  227. "lang": "js",
  228. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.global.health({\n ...\n})"
  229. }
  230. ]
  231. }
  232. },
  233. "/global/event": {
  234. "get": {
  235. "tags": ["global"],
  236. "operationId": "global.event",
  237. "parameters": [],
  238. "responses": {
  239. "200": {
  240. "description": "Event stream",
  241. "content": {
  242. "text/event-stream": {
  243. "schema": {
  244. "$ref": "#/components/schemas/GlobalEvent"
  245. }
  246. }
  247. }
  248. }
  249. },
  250. "description": "Subscribe to global events from the OpenCode system using server-sent events.",
  251. "summary": "Get global events",
  252. "x-codeSamples": [
  253. {
  254. "lang": "js",
  255. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.global.event({\n ...\n})"
  256. }
  257. ]
  258. }
  259. },
  260. "/global/config": {
  261. "get": {
  262. "tags": ["global"],
  263. "operationId": "global.config.get",
  264. "parameters": [],
  265. "responses": {
  266. "200": {
  267. "description": "Get global config info",
  268. "content": {
  269. "application/json": {
  270. "schema": {
  271. "$ref": "#/components/schemas/Config"
  272. }
  273. }
  274. }
  275. }
  276. },
  277. "description": "Retrieve the current global OpenCode configuration settings and preferences.",
  278. "summary": "Get global configuration",
  279. "x-codeSamples": [
  280. {
  281. "lang": "js",
  282. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.global.config.get({\n ...\n})"
  283. }
  284. ]
  285. },
  286. "patch": {
  287. "tags": ["global"],
  288. "operationId": "global.config.update",
  289. "parameters": [],
  290. "responses": {
  291. "200": {
  292. "description": "Successfully updated global config",
  293. "content": {
  294. "application/json": {
  295. "schema": {
  296. "$ref": "#/components/schemas/Config"
  297. }
  298. }
  299. }
  300. },
  301. "400": {
  302. "description": "Bad request",
  303. "content": {
  304. "application/json": {
  305. "schema": {
  306. "$ref": "#/components/schemas/BadRequestError"
  307. }
  308. }
  309. }
  310. }
  311. },
  312. "description": "Update global OpenCode configuration settings and preferences.",
  313. "summary": "Update global configuration",
  314. "requestBody": {
  315. "content": {
  316. "application/json": {
  317. "schema": {
  318. "$ref": "#/components/schemas/Config"
  319. }
  320. }
  321. }
  322. },
  323. "x-codeSamples": [
  324. {
  325. "lang": "js",
  326. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.global.config.update({\n ...\n})"
  327. }
  328. ]
  329. }
  330. },
  331. "/global/dispose": {
  332. "post": {
  333. "tags": ["global"],
  334. "operationId": "global.dispose",
  335. "parameters": [],
  336. "responses": {
  337. "200": {
  338. "description": "Global disposed",
  339. "content": {
  340. "application/json": {
  341. "schema": {
  342. "type": "boolean",
  343. "description": "Global disposed"
  344. }
  345. }
  346. }
  347. }
  348. },
  349. "description": "Clean up and dispose all OpenCode instances, releasing all resources.",
  350. "summary": "Dispose instance",
  351. "x-codeSamples": [
  352. {
  353. "lang": "js",
  354. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.global.dispose({\n ...\n})"
  355. }
  356. ]
  357. }
  358. },
  359. "/global/upgrade": {
  360. "post": {
  361. "tags": ["global"],
  362. "operationId": "global.upgrade",
  363. "parameters": [],
  364. "responses": {
  365. "200": {
  366. "description": "Upgrade result",
  367. "content": {
  368. "application/json": {
  369. "schema": {
  370. "anyOf": [
  371. {
  372. "type": "object",
  373. "properties": {
  374. "success": {
  375. "type": "boolean",
  376. "enum": [true]
  377. },
  378. "version": {
  379. "type": "string"
  380. }
  381. },
  382. "required": ["success", "version"],
  383. "additionalProperties": false
  384. },
  385. {
  386. "type": "object",
  387. "properties": {
  388. "success": {
  389. "type": "boolean",
  390. "enum": [false]
  391. },
  392. "error": {
  393. "type": "string"
  394. }
  395. },
  396. "required": ["success", "error"],
  397. "additionalProperties": false
  398. }
  399. ],
  400. "description": "Upgrade result"
  401. }
  402. }
  403. }
  404. },
  405. "400": {
  406. "description": "Bad request",
  407. "content": {
  408. "application/json": {
  409. "schema": {
  410. "$ref": "#/components/schemas/BadRequestError"
  411. }
  412. }
  413. }
  414. }
  415. },
  416. "description": "Upgrade opencode to the specified version or latest if not specified.",
  417. "summary": "Upgrade opencode",
  418. "requestBody": {
  419. "content": {
  420. "application/json": {
  421. "schema": {
  422. "type": "object",
  423. "properties": {
  424. "target": {
  425. "type": "string"
  426. }
  427. },
  428. "additionalProperties": false
  429. }
  430. }
  431. }
  432. },
  433. "x-codeSamples": [
  434. {
  435. "lang": "js",
  436. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.global.upgrade({\n ...\n})"
  437. }
  438. ]
  439. }
  440. },
  441. "/event": {
  442. "get": {
  443. "tags": ["event"],
  444. "operationId": "event.subscribe",
  445. "parameters": [
  446. {
  447. "name": "directory",
  448. "in": "query",
  449. "schema": {
  450. "type": "string"
  451. },
  452. "required": false
  453. },
  454. {
  455. "name": "workspace",
  456. "in": "query",
  457. "schema": {
  458. "type": "string"
  459. },
  460. "required": false
  461. }
  462. ],
  463. "responses": {
  464. "200": {
  465. "description": "Event stream",
  466. "content": {
  467. "text/event-stream": {
  468. "schema": {
  469. "$ref": "#/components/schemas/Event"
  470. }
  471. }
  472. }
  473. }
  474. },
  475. "description": "Get events",
  476. "summary": "Subscribe to events",
  477. "x-codeSamples": [
  478. {
  479. "lang": "js",
  480. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.event.subscribe({\n ...\n})"
  481. }
  482. ]
  483. }
  484. },
  485. "/config": {
  486. "get": {
  487. "tags": ["config"],
  488. "operationId": "config.get",
  489. "parameters": [
  490. {
  491. "name": "directory",
  492. "in": "query",
  493. "schema": {
  494. "type": "string"
  495. },
  496. "required": false
  497. },
  498. {
  499. "name": "workspace",
  500. "in": "query",
  501. "schema": {
  502. "type": "string"
  503. },
  504. "required": false
  505. }
  506. ],
  507. "responses": {
  508. "200": {
  509. "description": "Get config info",
  510. "content": {
  511. "application/json": {
  512. "schema": {
  513. "$ref": "#/components/schemas/Config"
  514. }
  515. }
  516. }
  517. }
  518. },
  519. "description": "Retrieve the current OpenCode configuration settings and preferences.",
  520. "summary": "Get configuration",
  521. "x-codeSamples": [
  522. {
  523. "lang": "js",
  524. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.config.get({\n ...\n})"
  525. }
  526. ]
  527. },
  528. "patch": {
  529. "tags": ["config"],
  530. "operationId": "config.update",
  531. "parameters": [
  532. {
  533. "name": "directory",
  534. "in": "query",
  535. "schema": {
  536. "type": "string"
  537. },
  538. "required": false
  539. },
  540. {
  541. "name": "workspace",
  542. "in": "query",
  543. "schema": {
  544. "type": "string"
  545. },
  546. "required": false
  547. }
  548. ],
  549. "responses": {
  550. "200": {
  551. "description": "Successfully updated config",
  552. "content": {
  553. "application/json": {
  554. "schema": {
  555. "$ref": "#/components/schemas/Config"
  556. }
  557. }
  558. }
  559. },
  560. "400": {
  561. "description": "Bad request",
  562. "content": {
  563. "application/json": {
  564. "schema": {
  565. "$ref": "#/components/schemas/BadRequestError"
  566. }
  567. }
  568. }
  569. }
  570. },
  571. "description": "Update OpenCode configuration settings and preferences.",
  572. "summary": "Update configuration",
  573. "requestBody": {
  574. "content": {
  575. "application/json": {
  576. "schema": {
  577. "$ref": "#/components/schemas/Config"
  578. }
  579. }
  580. }
  581. },
  582. "x-codeSamples": [
  583. {
  584. "lang": "js",
  585. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.config.update({\n ...\n})"
  586. }
  587. ]
  588. }
  589. },
  590. "/config/providers": {
  591. "get": {
  592. "tags": ["config"],
  593. "operationId": "config.providers",
  594. "parameters": [
  595. {
  596. "name": "directory",
  597. "in": "query",
  598. "schema": {
  599. "type": "string"
  600. },
  601. "required": false
  602. },
  603. {
  604. "name": "workspace",
  605. "in": "query",
  606. "schema": {
  607. "type": "string"
  608. },
  609. "required": false
  610. }
  611. ],
  612. "responses": {
  613. "200": {
  614. "description": "List of providers",
  615. "content": {
  616. "application/json": {
  617. "schema": {
  618. "type": "object",
  619. "properties": {
  620. "providers": {
  621. "type": "array",
  622. "items": {
  623. "$ref": "#/components/schemas/Provider"
  624. }
  625. },
  626. "default": {
  627. "type": "object",
  628. "additionalProperties": {
  629. "type": "string"
  630. }
  631. }
  632. },
  633. "required": ["providers", "default"],
  634. "additionalProperties": false,
  635. "description": "List of providers"
  636. }
  637. }
  638. }
  639. }
  640. },
  641. "description": "Get a list of all configured AI providers and their default models.",
  642. "summary": "List config providers",
  643. "x-codeSamples": [
  644. {
  645. "lang": "js",
  646. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.config.providers({\n ...\n})"
  647. }
  648. ]
  649. }
  650. },
  651. "/experimental/console": {
  652. "get": {
  653. "tags": ["experimental"],
  654. "operationId": "experimental.console.get",
  655. "parameters": [
  656. {
  657. "name": "directory",
  658. "in": "query",
  659. "schema": {
  660. "type": "string"
  661. },
  662. "required": false
  663. },
  664. {
  665. "name": "workspace",
  666. "in": "query",
  667. "schema": {
  668. "type": "string"
  669. },
  670. "required": false
  671. }
  672. ],
  673. "responses": {
  674. "200": {
  675. "description": "Active Console provider metadata",
  676. "content": {
  677. "application/json": {
  678. "schema": {
  679. "$ref": "#/components/schemas/ConsoleState"
  680. }
  681. }
  682. }
  683. },
  684. "500": {
  685. "description": "InternalServerError",
  686. "content": {
  687. "application/json": {
  688. "schema": {
  689. "$ref": "#/components/schemas/effect_HttpApiError_InternalServerError"
  690. }
  691. }
  692. }
  693. }
  694. },
  695. "description": "Get the active Console org name and the set of provider IDs managed by that Console org.",
  696. "summary": "Get active Console provider metadata",
  697. "x-codeSamples": [
  698. {
  699. "lang": "js",
  700. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.console.get({\n ...\n})"
  701. }
  702. ]
  703. }
  704. },
  705. "/experimental/console/orgs": {
  706. "get": {
  707. "tags": ["experimental"],
  708. "operationId": "experimental.console.listOrgs",
  709. "parameters": [
  710. {
  711. "name": "directory",
  712. "in": "query",
  713. "schema": {
  714. "type": "string"
  715. },
  716. "required": false
  717. },
  718. {
  719. "name": "workspace",
  720. "in": "query",
  721. "schema": {
  722. "type": "string"
  723. },
  724. "required": false
  725. }
  726. ],
  727. "responses": {
  728. "200": {
  729. "description": "Switchable Console orgs",
  730. "content": {
  731. "application/json": {
  732. "schema": {
  733. "type": "object",
  734. "properties": {
  735. "orgs": {
  736. "type": "array",
  737. "items": {
  738. "type": "object",
  739. "properties": {
  740. "accountID": {
  741. "type": "string"
  742. },
  743. "accountEmail": {
  744. "type": "string"
  745. },
  746. "accountUrl": {
  747. "type": "string"
  748. },
  749. "orgID": {
  750. "type": "string"
  751. },
  752. "orgName": {
  753. "type": "string"
  754. },
  755. "active": {
  756. "type": "boolean"
  757. }
  758. },
  759. "required": ["accountID", "accountEmail", "accountUrl", "orgID", "orgName", "active"],
  760. "additionalProperties": false
  761. }
  762. }
  763. },
  764. "required": ["orgs"],
  765. "additionalProperties": false,
  766. "description": "Switchable Console orgs"
  767. }
  768. }
  769. }
  770. },
  771. "500": {
  772. "description": "InternalServerError",
  773. "content": {
  774. "application/json": {
  775. "schema": {
  776. "$ref": "#/components/schemas/effect_HttpApiError_InternalServerError"
  777. }
  778. }
  779. }
  780. }
  781. },
  782. "description": "Get the available Console orgs across logged-in accounts, including the current active org.",
  783. "summary": "List switchable Console orgs",
  784. "x-codeSamples": [
  785. {
  786. "lang": "js",
  787. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.console.listOrgs({\n ...\n})"
  788. }
  789. ]
  790. }
  791. },
  792. "/experimental/console/switch": {
  793. "post": {
  794. "tags": ["experimental"],
  795. "operationId": "experimental.console.switchOrg",
  796. "parameters": [
  797. {
  798. "name": "directory",
  799. "in": "query",
  800. "schema": {
  801. "type": "string"
  802. },
  803. "required": false
  804. },
  805. {
  806. "name": "workspace",
  807. "in": "query",
  808. "schema": {
  809. "type": "string"
  810. },
  811. "required": false
  812. }
  813. ],
  814. "responses": {
  815. "200": {
  816. "description": "Switch success",
  817. "content": {
  818. "application/json": {
  819. "schema": {
  820. "type": "boolean",
  821. "description": "Switch success"
  822. }
  823. }
  824. }
  825. }
  826. },
  827. "description": "Persist a new active Console account/org selection for the current local OpenCode state.",
  828. "summary": "Switch active Console org",
  829. "requestBody": {
  830. "content": {
  831. "application/json": {
  832. "schema": {
  833. "type": "object",
  834. "properties": {
  835. "accountID": {
  836. "type": "string"
  837. },
  838. "orgID": {
  839. "type": "string"
  840. }
  841. },
  842. "required": ["accountID", "orgID"],
  843. "additionalProperties": false
  844. }
  845. }
  846. }
  847. },
  848. "x-codeSamples": [
  849. {
  850. "lang": "js",
  851. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.console.switchOrg({\n ...\n})"
  852. }
  853. ]
  854. }
  855. },
  856. "/experimental/tool": {
  857. "get": {
  858. "tags": ["experimental"],
  859. "operationId": "tool.list",
  860. "parameters": [
  861. {
  862. "name": "directory",
  863. "in": "query",
  864. "schema": {
  865. "type": "string"
  866. },
  867. "required": false
  868. },
  869. {
  870. "name": "workspace",
  871. "in": "query",
  872. "schema": {
  873. "type": "string"
  874. },
  875. "required": false
  876. },
  877. {
  878. "name": "provider",
  879. "in": "query",
  880. "schema": {
  881. "type": "string"
  882. },
  883. "required": true
  884. },
  885. {
  886. "name": "model",
  887. "in": "query",
  888. "schema": {
  889. "type": "string"
  890. },
  891. "required": true
  892. }
  893. ],
  894. "responses": {
  895. "200": {
  896. "description": "Tools",
  897. "content": {
  898. "application/json": {
  899. "schema": {
  900. "$ref": "#/components/schemas/ToolList"
  901. }
  902. }
  903. }
  904. },
  905. "400": {
  906. "description": "Bad request",
  907. "content": {
  908. "application/json": {
  909. "schema": {
  910. "$ref": "#/components/schemas/BadRequestError"
  911. }
  912. }
  913. }
  914. }
  915. },
  916. "description": "Get a list of available tools with their JSON schema parameters for a specific provider and model combination.",
  917. "summary": "List tools",
  918. "x-codeSamples": [
  919. {
  920. "lang": "js",
  921. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tool.list({\n ...\n})"
  922. }
  923. ]
  924. }
  925. },
  926. "/experimental/tool/ids": {
  927. "get": {
  928. "tags": ["experimental"],
  929. "operationId": "tool.ids",
  930. "parameters": [
  931. {
  932. "name": "directory",
  933. "in": "query",
  934. "schema": {
  935. "type": "string"
  936. },
  937. "required": false
  938. },
  939. {
  940. "name": "workspace",
  941. "in": "query",
  942. "schema": {
  943. "type": "string"
  944. },
  945. "required": false
  946. }
  947. ],
  948. "responses": {
  949. "200": {
  950. "description": "Tool IDs",
  951. "content": {
  952. "application/json": {
  953. "schema": {
  954. "$ref": "#/components/schemas/ToolIDs"
  955. }
  956. }
  957. }
  958. },
  959. "400": {
  960. "description": "Bad request",
  961. "content": {
  962. "application/json": {
  963. "schema": {
  964. "$ref": "#/components/schemas/BadRequestError"
  965. }
  966. }
  967. }
  968. }
  969. },
  970. "description": "Get a list of all available tool IDs, including both built-in tools and dynamically registered tools.",
  971. "summary": "List tool IDs",
  972. "x-codeSamples": [
  973. {
  974. "lang": "js",
  975. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tool.ids({\n ...\n})"
  976. }
  977. ]
  978. }
  979. },
  980. "/experimental/worktree": {
  981. "get": {
  982. "tags": ["experimental"],
  983. "operationId": "worktree.list",
  984. "parameters": [
  985. {
  986. "name": "directory",
  987. "in": "query",
  988. "schema": {
  989. "type": "string"
  990. },
  991. "required": false
  992. },
  993. {
  994. "name": "workspace",
  995. "in": "query",
  996. "schema": {
  997. "type": "string"
  998. },
  999. "required": false
  1000. }
  1001. ],
  1002. "responses": {
  1003. "200": {
  1004. "description": "List of worktree directories",
  1005. "content": {
  1006. "application/json": {
  1007. "schema": {
  1008. "type": "array",
  1009. "items": {
  1010. "type": "string"
  1011. },
  1012. "description": "List of worktree directories"
  1013. }
  1014. }
  1015. }
  1016. },
  1017. "400": {
  1018. "description": "WorktreeError",
  1019. "content": {
  1020. "application/json": {
  1021. "schema": {
  1022. "$ref": "#/components/schemas/WorktreeError"
  1023. }
  1024. }
  1025. }
  1026. }
  1027. },
  1028. "description": "List all sandbox worktrees for the current project.",
  1029. "summary": "List worktrees",
  1030. "x-codeSamples": [
  1031. {
  1032. "lang": "js",
  1033. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.worktree.list({\n ...\n})"
  1034. }
  1035. ]
  1036. },
  1037. "post": {
  1038. "tags": ["experimental"],
  1039. "operationId": "worktree.create",
  1040. "parameters": [
  1041. {
  1042. "name": "directory",
  1043. "in": "query",
  1044. "schema": {
  1045. "type": "string"
  1046. },
  1047. "required": false
  1048. },
  1049. {
  1050. "name": "workspace",
  1051. "in": "query",
  1052. "schema": {
  1053. "type": "string"
  1054. },
  1055. "required": false
  1056. }
  1057. ],
  1058. "responses": {
  1059. "200": {
  1060. "description": "Worktree created",
  1061. "content": {
  1062. "application/json": {
  1063. "schema": {
  1064. "$ref": "#/components/schemas/Worktree"
  1065. }
  1066. }
  1067. }
  1068. },
  1069. "400": {
  1070. "description": "WorktreeError",
  1071. "content": {
  1072. "application/json": {
  1073. "schema": {
  1074. "$ref": "#/components/schemas/WorktreeError"
  1075. }
  1076. }
  1077. }
  1078. }
  1079. },
  1080. "description": "Create a new git worktree for the current project and run any configured startup scripts.",
  1081. "summary": "Create worktree",
  1082. "requestBody": {
  1083. "content": {
  1084. "application/json": {
  1085. "schema": {
  1086. "$ref": "#/components/schemas/WorktreeCreateInput"
  1087. }
  1088. }
  1089. }
  1090. },
  1091. "x-codeSamples": [
  1092. {
  1093. "lang": "js",
  1094. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.worktree.create({\n ...\n})"
  1095. }
  1096. ]
  1097. },
  1098. "delete": {
  1099. "tags": ["experimental"],
  1100. "operationId": "worktree.remove",
  1101. "parameters": [
  1102. {
  1103. "name": "directory",
  1104. "in": "query",
  1105. "schema": {
  1106. "type": "string"
  1107. },
  1108. "required": false
  1109. },
  1110. {
  1111. "name": "workspace",
  1112. "in": "query",
  1113. "schema": {
  1114. "type": "string"
  1115. },
  1116. "required": false
  1117. }
  1118. ],
  1119. "responses": {
  1120. "200": {
  1121. "description": "Worktree removed",
  1122. "content": {
  1123. "application/json": {
  1124. "schema": {
  1125. "type": "boolean",
  1126. "description": "Worktree removed"
  1127. }
  1128. }
  1129. }
  1130. },
  1131. "400": {
  1132. "description": "WorktreeError",
  1133. "content": {
  1134. "application/json": {
  1135. "schema": {
  1136. "$ref": "#/components/schemas/WorktreeError"
  1137. }
  1138. }
  1139. }
  1140. }
  1141. },
  1142. "description": "Remove a git worktree and delete its branch.",
  1143. "summary": "Remove worktree",
  1144. "requestBody": {
  1145. "content": {
  1146. "application/json": {
  1147. "schema": {
  1148. "$ref": "#/components/schemas/WorktreeRemoveInput"
  1149. }
  1150. }
  1151. }
  1152. },
  1153. "x-codeSamples": [
  1154. {
  1155. "lang": "js",
  1156. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.worktree.remove({\n ...\n})"
  1157. }
  1158. ]
  1159. }
  1160. },
  1161. "/experimental/worktree/reset": {
  1162. "post": {
  1163. "tags": ["experimental"],
  1164. "operationId": "worktree.reset",
  1165. "parameters": [
  1166. {
  1167. "name": "directory",
  1168. "in": "query",
  1169. "schema": {
  1170. "type": "string"
  1171. },
  1172. "required": false
  1173. },
  1174. {
  1175. "name": "workspace",
  1176. "in": "query",
  1177. "schema": {
  1178. "type": "string"
  1179. },
  1180. "required": false
  1181. }
  1182. ],
  1183. "responses": {
  1184. "200": {
  1185. "description": "Worktree reset",
  1186. "content": {
  1187. "application/json": {
  1188. "schema": {
  1189. "type": "boolean",
  1190. "description": "Worktree reset"
  1191. }
  1192. }
  1193. }
  1194. },
  1195. "400": {
  1196. "description": "WorktreeError",
  1197. "content": {
  1198. "application/json": {
  1199. "schema": {
  1200. "$ref": "#/components/schemas/WorktreeError"
  1201. }
  1202. }
  1203. }
  1204. }
  1205. },
  1206. "description": "Reset a worktree branch to the primary default branch.",
  1207. "summary": "Reset worktree",
  1208. "requestBody": {
  1209. "content": {
  1210. "application/json": {
  1211. "schema": {
  1212. "$ref": "#/components/schemas/WorktreeResetInput"
  1213. }
  1214. }
  1215. }
  1216. },
  1217. "x-codeSamples": [
  1218. {
  1219. "lang": "js",
  1220. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.worktree.reset({\n ...\n})"
  1221. }
  1222. ]
  1223. }
  1224. },
  1225. "/experimental/session": {
  1226. "get": {
  1227. "tags": ["experimental"],
  1228. "operationId": "experimental.session.list",
  1229. "parameters": [
  1230. {
  1231. "name": "directory",
  1232. "in": "query",
  1233. "schema": {
  1234. "type": "string"
  1235. },
  1236. "required": false
  1237. },
  1238. {
  1239. "name": "workspace",
  1240. "in": "query",
  1241. "schema": {
  1242. "type": "string"
  1243. },
  1244. "required": false
  1245. },
  1246. {
  1247. "name": "roots",
  1248. "in": "query",
  1249. "schema": {
  1250. "anyOf": [
  1251. {
  1252. "type": "boolean"
  1253. },
  1254. {
  1255. "type": "string",
  1256. "enum": ["true", "false"]
  1257. }
  1258. ]
  1259. },
  1260. "required": false
  1261. },
  1262. {
  1263. "name": "start",
  1264. "in": "query",
  1265. "schema": {
  1266. "type": "number"
  1267. },
  1268. "required": false
  1269. },
  1270. {
  1271. "name": "cursor",
  1272. "in": "query",
  1273. "schema": {
  1274. "type": "number"
  1275. },
  1276. "required": false
  1277. },
  1278. {
  1279. "name": "search",
  1280. "in": "query",
  1281. "schema": {
  1282. "type": "string"
  1283. },
  1284. "required": false
  1285. },
  1286. {
  1287. "name": "limit",
  1288. "in": "query",
  1289. "schema": {
  1290. "type": "number"
  1291. },
  1292. "required": false
  1293. },
  1294. {
  1295. "name": "archived",
  1296. "in": "query",
  1297. "schema": {
  1298. "anyOf": [
  1299. {
  1300. "type": "boolean"
  1301. },
  1302. {
  1303. "type": "string",
  1304. "enum": ["true", "false"]
  1305. }
  1306. ]
  1307. },
  1308. "required": false
  1309. }
  1310. ],
  1311. "responses": {
  1312. "200": {
  1313. "description": "List of sessions",
  1314. "content": {
  1315. "application/json": {
  1316. "schema": {
  1317. "type": "array",
  1318. "items": {
  1319. "$ref": "#/components/schemas/GlobalSession"
  1320. },
  1321. "description": "List of sessions"
  1322. }
  1323. }
  1324. }
  1325. }
  1326. },
  1327. "description": "Get a list of all OpenCode sessions across projects, sorted by most recently updated. Archived sessions are excluded by default.",
  1328. "summary": "List sessions",
  1329. "x-codeSamples": [
  1330. {
  1331. "lang": "js",
  1332. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.session.list({\n ...\n})"
  1333. }
  1334. ]
  1335. }
  1336. },
  1337. "/experimental/resource": {
  1338. "get": {
  1339. "tags": ["experimental"],
  1340. "operationId": "experimental.resource.list",
  1341. "parameters": [
  1342. {
  1343. "name": "directory",
  1344. "in": "query",
  1345. "schema": {
  1346. "type": "string"
  1347. },
  1348. "required": false
  1349. },
  1350. {
  1351. "name": "workspace",
  1352. "in": "query",
  1353. "schema": {
  1354. "type": "string"
  1355. },
  1356. "required": false
  1357. }
  1358. ],
  1359. "responses": {
  1360. "200": {
  1361. "description": "MCP resources",
  1362. "content": {
  1363. "application/json": {
  1364. "schema": {
  1365. "type": "object",
  1366. "additionalProperties": {
  1367. "$ref": "#/components/schemas/McpResource"
  1368. },
  1369. "description": "MCP resources"
  1370. }
  1371. }
  1372. }
  1373. }
  1374. },
  1375. "description": "Get all available MCP resources from connected servers. Optionally filter by name.",
  1376. "summary": "Get MCP resources",
  1377. "x-codeSamples": [
  1378. {
  1379. "lang": "js",
  1380. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.resource.list({\n ...\n})"
  1381. }
  1382. ]
  1383. }
  1384. },
  1385. "/find": {
  1386. "get": {
  1387. "tags": ["file"],
  1388. "operationId": "find.text",
  1389. "parameters": [
  1390. {
  1391. "name": "directory",
  1392. "in": "query",
  1393. "schema": {
  1394. "type": "string"
  1395. },
  1396. "required": false
  1397. },
  1398. {
  1399. "name": "workspace",
  1400. "in": "query",
  1401. "schema": {
  1402. "type": "string"
  1403. },
  1404. "required": false
  1405. },
  1406. {
  1407. "name": "pattern",
  1408. "in": "query",
  1409. "schema": {
  1410. "type": "string"
  1411. },
  1412. "required": true
  1413. }
  1414. ],
  1415. "responses": {
  1416. "200": {
  1417. "description": "Matches",
  1418. "content": {
  1419. "application/json": {
  1420. "schema": {
  1421. "type": "array",
  1422. "items": {
  1423. "type": "object",
  1424. "properties": {
  1425. "path": {
  1426. "type": "object",
  1427. "properties": {
  1428. "text": {
  1429. "type": "string"
  1430. }
  1431. },
  1432. "required": ["text"],
  1433. "additionalProperties": false
  1434. },
  1435. "lines": {
  1436. "type": "object",
  1437. "properties": {
  1438. "text": {
  1439. "type": "string"
  1440. }
  1441. },
  1442. "required": ["text"],
  1443. "additionalProperties": false
  1444. },
  1445. "line_number": {
  1446. "type": "integer",
  1447. "minimum": 0
  1448. },
  1449. "absolute_offset": {
  1450. "type": "integer",
  1451. "minimum": 0
  1452. },
  1453. "submatches": {
  1454. "type": "array",
  1455. "items": {
  1456. "type": "object",
  1457. "properties": {
  1458. "match": {
  1459. "type": "object",
  1460. "properties": {
  1461. "text": {
  1462. "type": "string"
  1463. }
  1464. },
  1465. "required": ["text"],
  1466. "additionalProperties": false
  1467. },
  1468. "start": {
  1469. "type": "integer",
  1470. "minimum": 0
  1471. },
  1472. "end": {
  1473. "type": "integer",
  1474. "minimum": 0
  1475. }
  1476. },
  1477. "required": ["match", "start", "end"],
  1478. "additionalProperties": false
  1479. }
  1480. }
  1481. },
  1482. "required": ["path", "lines", "line_number", "absolute_offset", "submatches"],
  1483. "additionalProperties": false
  1484. },
  1485. "description": "Matches"
  1486. }
  1487. }
  1488. }
  1489. }
  1490. },
  1491. "description": "Search for text patterns across files in the project using ripgrep.",
  1492. "summary": "Find text",
  1493. "x-codeSamples": [
  1494. {
  1495. "lang": "js",
  1496. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.find.text({\n ...\n})"
  1497. }
  1498. ]
  1499. }
  1500. },
  1501. "/find/file": {
  1502. "get": {
  1503. "tags": ["file"],
  1504. "operationId": "find.files",
  1505. "parameters": [
  1506. {
  1507. "name": "directory",
  1508. "in": "query",
  1509. "schema": {
  1510. "type": "string"
  1511. },
  1512. "required": false
  1513. },
  1514. {
  1515. "name": "workspace",
  1516. "in": "query",
  1517. "schema": {
  1518. "type": "string"
  1519. },
  1520. "required": false
  1521. },
  1522. {
  1523. "name": "query",
  1524. "in": "query",
  1525. "schema": {
  1526. "type": "string"
  1527. },
  1528. "required": true
  1529. },
  1530. {
  1531. "name": "dirs",
  1532. "in": "query",
  1533. "schema": {
  1534. "type": "string",
  1535. "enum": ["true", "false"]
  1536. },
  1537. "required": false
  1538. },
  1539. {
  1540. "name": "type",
  1541. "in": "query",
  1542. "schema": {
  1543. "type": "string",
  1544. "enum": ["file", "directory"]
  1545. },
  1546. "required": false
  1547. },
  1548. {
  1549. "name": "limit",
  1550. "in": "query",
  1551. "schema": {
  1552. "type": "integer",
  1553. "minimum": 1,
  1554. "maximum": 200
  1555. },
  1556. "required": false
  1557. }
  1558. ],
  1559. "responses": {
  1560. "200": {
  1561. "description": "File paths",
  1562. "content": {
  1563. "application/json": {
  1564. "schema": {
  1565. "type": "array",
  1566. "items": {
  1567. "type": "string"
  1568. },
  1569. "description": "File paths"
  1570. }
  1571. }
  1572. }
  1573. }
  1574. },
  1575. "description": "Search for files or directories by name or pattern in the project directory.",
  1576. "summary": "Find files",
  1577. "x-codeSamples": [
  1578. {
  1579. "lang": "js",
  1580. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.find.files({\n ...\n})"
  1581. }
  1582. ]
  1583. }
  1584. },
  1585. "/find/symbol": {
  1586. "get": {
  1587. "tags": ["file"],
  1588. "operationId": "find.symbols",
  1589. "parameters": [
  1590. {
  1591. "name": "directory",
  1592. "in": "query",
  1593. "schema": {
  1594. "type": "string"
  1595. },
  1596. "required": false
  1597. },
  1598. {
  1599. "name": "workspace",
  1600. "in": "query",
  1601. "schema": {
  1602. "type": "string"
  1603. },
  1604. "required": false
  1605. },
  1606. {
  1607. "name": "query",
  1608. "in": "query",
  1609. "schema": {
  1610. "type": "string"
  1611. },
  1612. "required": true
  1613. }
  1614. ],
  1615. "responses": {
  1616. "200": {
  1617. "description": "Symbols",
  1618. "content": {
  1619. "application/json": {
  1620. "schema": {
  1621. "type": "array",
  1622. "items": {
  1623. "$ref": "#/components/schemas/Symbol"
  1624. },
  1625. "description": "Symbols"
  1626. }
  1627. }
  1628. }
  1629. }
  1630. },
  1631. "description": "Search for workspace symbols like functions, classes, and variables using LSP.",
  1632. "summary": "Find symbols",
  1633. "x-codeSamples": [
  1634. {
  1635. "lang": "js",
  1636. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.find.symbols({\n ...\n})"
  1637. }
  1638. ]
  1639. }
  1640. },
  1641. "/file": {
  1642. "get": {
  1643. "tags": ["file"],
  1644. "operationId": "file.list",
  1645. "parameters": [
  1646. {
  1647. "name": "directory",
  1648. "in": "query",
  1649. "schema": {
  1650. "type": "string"
  1651. },
  1652. "required": false
  1653. },
  1654. {
  1655. "name": "workspace",
  1656. "in": "query",
  1657. "schema": {
  1658. "type": "string"
  1659. },
  1660. "required": false
  1661. },
  1662. {
  1663. "name": "path",
  1664. "in": "query",
  1665. "schema": {
  1666. "type": "string"
  1667. },
  1668. "required": true
  1669. }
  1670. ],
  1671. "responses": {
  1672. "200": {
  1673. "description": "Files and directories",
  1674. "content": {
  1675. "application/json": {
  1676. "schema": {
  1677. "type": "array",
  1678. "items": {
  1679. "$ref": "#/components/schemas/FileNode"
  1680. },
  1681. "description": "Files and directories"
  1682. }
  1683. }
  1684. }
  1685. }
  1686. },
  1687. "description": "List files and directories in a specified path.",
  1688. "summary": "List files",
  1689. "x-codeSamples": [
  1690. {
  1691. "lang": "js",
  1692. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.file.list({\n ...\n})"
  1693. }
  1694. ]
  1695. }
  1696. },
  1697. "/file/content": {
  1698. "get": {
  1699. "tags": ["file"],
  1700. "operationId": "file.read",
  1701. "parameters": [
  1702. {
  1703. "name": "directory",
  1704. "in": "query",
  1705. "schema": {
  1706. "type": "string"
  1707. },
  1708. "required": false
  1709. },
  1710. {
  1711. "name": "workspace",
  1712. "in": "query",
  1713. "schema": {
  1714. "type": "string"
  1715. },
  1716. "required": false
  1717. },
  1718. {
  1719. "name": "path",
  1720. "in": "query",
  1721. "schema": {
  1722. "type": "string"
  1723. },
  1724. "required": true
  1725. }
  1726. ],
  1727. "responses": {
  1728. "200": {
  1729. "description": "File content",
  1730. "content": {
  1731. "application/json": {
  1732. "schema": {
  1733. "$ref": "#/components/schemas/FileContent"
  1734. }
  1735. }
  1736. }
  1737. }
  1738. },
  1739. "description": "Read the content of a specified file.",
  1740. "summary": "Read file",
  1741. "x-codeSamples": [
  1742. {
  1743. "lang": "js",
  1744. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.file.read({\n ...\n})"
  1745. }
  1746. ]
  1747. }
  1748. },
  1749. "/file/status": {
  1750. "get": {
  1751. "tags": ["file"],
  1752. "operationId": "file.status",
  1753. "parameters": [
  1754. {
  1755. "name": "directory",
  1756. "in": "query",
  1757. "schema": {
  1758. "type": "string"
  1759. },
  1760. "required": false
  1761. },
  1762. {
  1763. "name": "workspace",
  1764. "in": "query",
  1765. "schema": {
  1766. "type": "string"
  1767. },
  1768. "required": false
  1769. }
  1770. ],
  1771. "responses": {
  1772. "200": {
  1773. "description": "File status",
  1774. "content": {
  1775. "application/json": {
  1776. "schema": {
  1777. "type": "array",
  1778. "items": {
  1779. "$ref": "#/components/schemas/File"
  1780. },
  1781. "description": "File status"
  1782. }
  1783. }
  1784. }
  1785. }
  1786. },
  1787. "description": "Get the git status of all files in the project.",
  1788. "summary": "Get file status",
  1789. "x-codeSamples": [
  1790. {
  1791. "lang": "js",
  1792. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.file.status({\n ...\n})"
  1793. }
  1794. ]
  1795. }
  1796. },
  1797. "/instance/dispose": {
  1798. "post": {
  1799. "tags": ["instance"],
  1800. "operationId": "instance.dispose",
  1801. "parameters": [
  1802. {
  1803. "name": "directory",
  1804. "in": "query",
  1805. "schema": {
  1806. "type": "string"
  1807. },
  1808. "required": false
  1809. },
  1810. {
  1811. "name": "workspace",
  1812. "in": "query",
  1813. "schema": {
  1814. "type": "string"
  1815. },
  1816. "required": false
  1817. }
  1818. ],
  1819. "responses": {
  1820. "200": {
  1821. "description": "Instance disposed",
  1822. "content": {
  1823. "application/json": {
  1824. "schema": {
  1825. "type": "boolean",
  1826. "description": "Instance disposed"
  1827. }
  1828. }
  1829. }
  1830. }
  1831. },
  1832. "description": "Clean up and dispose the current OpenCode instance, releasing all resources.",
  1833. "summary": "Dispose instance",
  1834. "x-codeSamples": [
  1835. {
  1836. "lang": "js",
  1837. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.instance.dispose({\n ...\n})"
  1838. }
  1839. ]
  1840. }
  1841. },
  1842. "/path": {
  1843. "get": {
  1844. "tags": ["instance"],
  1845. "operationId": "path.get",
  1846. "parameters": [
  1847. {
  1848. "name": "directory",
  1849. "in": "query",
  1850. "schema": {
  1851. "type": "string"
  1852. },
  1853. "required": false
  1854. },
  1855. {
  1856. "name": "workspace",
  1857. "in": "query",
  1858. "schema": {
  1859. "type": "string"
  1860. },
  1861. "required": false
  1862. }
  1863. ],
  1864. "responses": {
  1865. "200": {
  1866. "description": "Path",
  1867. "content": {
  1868. "application/json": {
  1869. "schema": {
  1870. "$ref": "#/components/schemas/Path"
  1871. }
  1872. }
  1873. }
  1874. }
  1875. },
  1876. "description": "Retrieve the current working directory and related path information for the OpenCode instance.",
  1877. "summary": "Get paths",
  1878. "x-codeSamples": [
  1879. {
  1880. "lang": "js",
  1881. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.path.get({\n ...\n})"
  1882. }
  1883. ]
  1884. }
  1885. },
  1886. "/vcs": {
  1887. "get": {
  1888. "tags": ["instance"],
  1889. "operationId": "vcs.get",
  1890. "parameters": [
  1891. {
  1892. "name": "directory",
  1893. "in": "query",
  1894. "schema": {
  1895. "type": "string"
  1896. },
  1897. "required": false
  1898. },
  1899. {
  1900. "name": "workspace",
  1901. "in": "query",
  1902. "schema": {
  1903. "type": "string"
  1904. },
  1905. "required": false
  1906. }
  1907. ],
  1908. "responses": {
  1909. "200": {
  1910. "description": "VCS info",
  1911. "content": {
  1912. "application/json": {
  1913. "schema": {
  1914. "$ref": "#/components/schemas/VcsInfo"
  1915. }
  1916. }
  1917. }
  1918. }
  1919. },
  1920. "description": "Retrieve version control system (VCS) information for the current project, such as git branch.",
  1921. "summary": "Get VCS info",
  1922. "x-codeSamples": [
  1923. {
  1924. "lang": "js",
  1925. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.vcs.get({\n ...\n})"
  1926. }
  1927. ]
  1928. }
  1929. },
  1930. "/vcs/status": {
  1931. "get": {
  1932. "tags": ["instance"],
  1933. "operationId": "vcs.status",
  1934. "parameters": [
  1935. {
  1936. "name": "directory",
  1937. "in": "query",
  1938. "schema": {
  1939. "type": "string"
  1940. },
  1941. "required": false
  1942. },
  1943. {
  1944. "name": "workspace",
  1945. "in": "query",
  1946. "schema": {
  1947. "type": "string"
  1948. },
  1949. "required": false
  1950. }
  1951. ],
  1952. "responses": {
  1953. "200": {
  1954. "description": "VCS status",
  1955. "content": {
  1956. "application/json": {
  1957. "schema": {
  1958. "type": "array",
  1959. "items": {
  1960. "$ref": "#/components/schemas/VcsFileStatus"
  1961. },
  1962. "description": "VCS status"
  1963. }
  1964. }
  1965. }
  1966. }
  1967. },
  1968. "description": "Retrieve changed files in the current working tree without patches.",
  1969. "summary": "Get VCS status",
  1970. "x-codeSamples": [
  1971. {
  1972. "lang": "js",
  1973. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.vcs.status({\n ...\n})"
  1974. }
  1975. ]
  1976. }
  1977. },
  1978. "/vcs/diff": {
  1979. "get": {
  1980. "tags": ["instance"],
  1981. "operationId": "vcs.diff",
  1982. "parameters": [
  1983. {
  1984. "name": "directory",
  1985. "in": "query",
  1986. "schema": {
  1987. "type": "string"
  1988. },
  1989. "required": false
  1990. },
  1991. {
  1992. "name": "workspace",
  1993. "in": "query",
  1994. "schema": {
  1995. "type": "string"
  1996. },
  1997. "required": false
  1998. },
  1999. {
  2000. "name": "mode",
  2001. "in": "query",
  2002. "schema": {
  2003. "type": "string",
  2004. "enum": ["git", "branch"]
  2005. },
  2006. "required": true
  2007. }
  2008. ],
  2009. "responses": {
  2010. "200": {
  2011. "description": "VCS diff",
  2012. "content": {
  2013. "application/json": {
  2014. "schema": {
  2015. "type": "array",
  2016. "items": {
  2017. "$ref": "#/components/schemas/VcsFileDiff"
  2018. },
  2019. "description": "VCS diff"
  2020. }
  2021. }
  2022. }
  2023. }
  2024. },
  2025. "description": "Retrieve the current git diff for the working tree or against the default branch.",
  2026. "summary": "Get VCS diff",
  2027. "x-codeSamples": [
  2028. {
  2029. "lang": "js",
  2030. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.vcs.diff({\n ...\n})"
  2031. }
  2032. ]
  2033. }
  2034. },
  2035. "/vcs/diff/raw": {
  2036. "get": {
  2037. "tags": ["instance"],
  2038. "operationId": "vcs.diff.raw",
  2039. "parameters": [
  2040. {
  2041. "name": "directory",
  2042. "in": "query",
  2043. "schema": {
  2044. "type": "string"
  2045. },
  2046. "required": false
  2047. },
  2048. {
  2049. "name": "workspace",
  2050. "in": "query",
  2051. "schema": {
  2052. "type": "string"
  2053. },
  2054. "required": false
  2055. }
  2056. ],
  2057. "responses": {
  2058. "200": {
  2059. "description": "Raw VCS diff",
  2060. "content": {
  2061. "text/x-diff; charset=utf-8": {
  2062. "schema": {
  2063. "type": "string"
  2064. }
  2065. }
  2066. }
  2067. }
  2068. },
  2069. "description": "Retrieve a raw patch for current uncommitted changes.",
  2070. "summary": "Get raw VCS diff",
  2071. "x-codeSamples": [
  2072. {
  2073. "lang": "js",
  2074. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.vcs.diff.raw({\n ...\n})"
  2075. }
  2076. ]
  2077. }
  2078. },
  2079. "/vcs/apply": {
  2080. "post": {
  2081. "tags": ["instance"],
  2082. "operationId": "vcs.apply",
  2083. "parameters": [
  2084. {
  2085. "name": "directory",
  2086. "in": "query",
  2087. "schema": {
  2088. "type": "string"
  2089. },
  2090. "required": false
  2091. },
  2092. {
  2093. "name": "workspace",
  2094. "in": "query",
  2095. "schema": {
  2096. "type": "string"
  2097. },
  2098. "required": false
  2099. }
  2100. ],
  2101. "responses": {
  2102. "200": {
  2103. "description": "VCS patch applied",
  2104. "content": {
  2105. "application/json": {
  2106. "schema": {
  2107. "type": "object",
  2108. "properties": {
  2109. "applied": {
  2110. "type": "boolean"
  2111. }
  2112. },
  2113. "required": ["applied"],
  2114. "additionalProperties": false,
  2115. "description": "VCS patch applied"
  2116. }
  2117. }
  2118. }
  2119. },
  2120. "400": {
  2121. "description": "VcsApplyError",
  2122. "content": {
  2123. "application/json": {
  2124. "schema": {
  2125. "$ref": "#/components/schemas/VcsApplyError"
  2126. }
  2127. }
  2128. }
  2129. }
  2130. },
  2131. "description": "Apply a raw patch to the current working tree.",
  2132. "summary": "Apply VCS patch",
  2133. "requestBody": {
  2134. "content": {
  2135. "application/json": {
  2136. "schema": {
  2137. "type": "object",
  2138. "properties": {
  2139. "patch": {
  2140. "type": "string"
  2141. }
  2142. },
  2143. "required": ["patch"],
  2144. "additionalProperties": false
  2145. }
  2146. }
  2147. }
  2148. },
  2149. "x-codeSamples": [
  2150. {
  2151. "lang": "js",
  2152. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.vcs.apply({\n ...\n})"
  2153. }
  2154. ]
  2155. }
  2156. },
  2157. "/command": {
  2158. "get": {
  2159. "tags": ["instance"],
  2160. "operationId": "command.list",
  2161. "parameters": [
  2162. {
  2163. "name": "directory",
  2164. "in": "query",
  2165. "schema": {
  2166. "type": "string"
  2167. },
  2168. "required": false
  2169. },
  2170. {
  2171. "name": "workspace",
  2172. "in": "query",
  2173. "schema": {
  2174. "type": "string"
  2175. },
  2176. "required": false
  2177. }
  2178. ],
  2179. "responses": {
  2180. "200": {
  2181. "description": "List of commands",
  2182. "content": {
  2183. "application/json": {
  2184. "schema": {
  2185. "type": "array",
  2186. "items": {
  2187. "$ref": "#/components/schemas/Command"
  2188. },
  2189. "description": "List of commands"
  2190. }
  2191. }
  2192. }
  2193. }
  2194. },
  2195. "description": "Get a list of all available commands in the OpenCode system.",
  2196. "summary": "List commands",
  2197. "x-codeSamples": [
  2198. {
  2199. "lang": "js",
  2200. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.command.list({\n ...\n})"
  2201. }
  2202. ]
  2203. }
  2204. },
  2205. "/agent": {
  2206. "get": {
  2207. "tags": ["instance"],
  2208. "operationId": "app.agents",
  2209. "parameters": [
  2210. {
  2211. "name": "directory",
  2212. "in": "query",
  2213. "schema": {
  2214. "type": "string"
  2215. },
  2216. "required": false
  2217. },
  2218. {
  2219. "name": "workspace",
  2220. "in": "query",
  2221. "schema": {
  2222. "type": "string"
  2223. },
  2224. "required": false
  2225. }
  2226. ],
  2227. "responses": {
  2228. "200": {
  2229. "description": "List of agents",
  2230. "content": {
  2231. "application/json": {
  2232. "schema": {
  2233. "type": "array",
  2234. "items": {
  2235. "$ref": "#/components/schemas/Agent"
  2236. },
  2237. "description": "List of agents"
  2238. }
  2239. }
  2240. }
  2241. }
  2242. },
  2243. "description": "Get a list of all available AI agents in the OpenCode system.",
  2244. "summary": "List agents",
  2245. "x-codeSamples": [
  2246. {
  2247. "lang": "js",
  2248. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.app.agents({\n ...\n})"
  2249. }
  2250. ]
  2251. }
  2252. },
  2253. "/skill": {
  2254. "get": {
  2255. "tags": ["instance"],
  2256. "operationId": "app.skills",
  2257. "parameters": [
  2258. {
  2259. "name": "directory",
  2260. "in": "query",
  2261. "schema": {
  2262. "type": "string"
  2263. },
  2264. "required": false
  2265. },
  2266. {
  2267. "name": "workspace",
  2268. "in": "query",
  2269. "schema": {
  2270. "type": "string"
  2271. },
  2272. "required": false
  2273. }
  2274. ],
  2275. "responses": {
  2276. "200": {
  2277. "description": "List of skills",
  2278. "content": {
  2279. "application/json": {
  2280. "schema": {
  2281. "type": "array",
  2282. "items": {
  2283. "type": "object",
  2284. "properties": {
  2285. "name": {
  2286. "type": "string"
  2287. },
  2288. "description": {
  2289. "type": "string"
  2290. },
  2291. "location": {
  2292. "type": "string"
  2293. },
  2294. "content": {
  2295. "type": "string"
  2296. }
  2297. },
  2298. "required": ["name", "location", "content"],
  2299. "additionalProperties": false
  2300. },
  2301. "description": "List of skills"
  2302. }
  2303. }
  2304. }
  2305. }
  2306. },
  2307. "description": "Get a list of all available skills in the OpenCode system.",
  2308. "summary": "List skills",
  2309. "x-codeSamples": [
  2310. {
  2311. "lang": "js",
  2312. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.app.skills({\n ...\n})"
  2313. }
  2314. ]
  2315. }
  2316. },
  2317. "/lsp": {
  2318. "get": {
  2319. "tags": ["instance"],
  2320. "operationId": "lsp.status",
  2321. "parameters": [
  2322. {
  2323. "name": "directory",
  2324. "in": "query",
  2325. "schema": {
  2326. "type": "string"
  2327. },
  2328. "required": false
  2329. },
  2330. {
  2331. "name": "workspace",
  2332. "in": "query",
  2333. "schema": {
  2334. "type": "string"
  2335. },
  2336. "required": false
  2337. }
  2338. ],
  2339. "responses": {
  2340. "200": {
  2341. "description": "LSP server status",
  2342. "content": {
  2343. "application/json": {
  2344. "schema": {
  2345. "type": "array",
  2346. "items": {
  2347. "$ref": "#/components/schemas/LSPStatus"
  2348. },
  2349. "description": "LSP server status"
  2350. }
  2351. }
  2352. }
  2353. }
  2354. },
  2355. "description": "Get LSP server status",
  2356. "summary": "Get LSP status",
  2357. "x-codeSamples": [
  2358. {
  2359. "lang": "js",
  2360. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.lsp.status({\n ...\n})"
  2361. }
  2362. ]
  2363. }
  2364. },
  2365. "/formatter": {
  2366. "get": {
  2367. "tags": ["instance"],
  2368. "operationId": "formatter.status",
  2369. "parameters": [
  2370. {
  2371. "name": "directory",
  2372. "in": "query",
  2373. "schema": {
  2374. "type": "string"
  2375. },
  2376. "required": false
  2377. },
  2378. {
  2379. "name": "workspace",
  2380. "in": "query",
  2381. "schema": {
  2382. "type": "string"
  2383. },
  2384. "required": false
  2385. }
  2386. ],
  2387. "responses": {
  2388. "200": {
  2389. "description": "Formatter status",
  2390. "content": {
  2391. "application/json": {
  2392. "schema": {
  2393. "type": "array",
  2394. "items": {
  2395. "$ref": "#/components/schemas/FormatterStatus"
  2396. },
  2397. "description": "Formatter status"
  2398. }
  2399. }
  2400. }
  2401. }
  2402. },
  2403. "description": "Get formatter status",
  2404. "summary": "Get formatter status",
  2405. "x-codeSamples": [
  2406. {
  2407. "lang": "js",
  2408. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.formatter.status({\n ...\n})"
  2409. }
  2410. ]
  2411. }
  2412. },
  2413. "/mcp": {
  2414. "get": {
  2415. "tags": ["mcp"],
  2416. "operationId": "mcp.status",
  2417. "parameters": [
  2418. {
  2419. "name": "directory",
  2420. "in": "query",
  2421. "schema": {
  2422. "type": "string"
  2423. },
  2424. "required": false
  2425. },
  2426. {
  2427. "name": "workspace",
  2428. "in": "query",
  2429. "schema": {
  2430. "type": "string"
  2431. },
  2432. "required": false
  2433. }
  2434. ],
  2435. "responses": {
  2436. "200": {
  2437. "description": "MCP server status",
  2438. "content": {
  2439. "application/json": {
  2440. "schema": {
  2441. "type": "object",
  2442. "additionalProperties": {
  2443. "$ref": "#/components/schemas/MCPStatus"
  2444. },
  2445. "description": "MCP server status"
  2446. }
  2447. }
  2448. }
  2449. }
  2450. },
  2451. "description": "Get the status of all Model Context Protocol (MCP) servers.",
  2452. "summary": "Get MCP status",
  2453. "x-codeSamples": [
  2454. {
  2455. "lang": "js",
  2456. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.status({\n ...\n})"
  2457. }
  2458. ]
  2459. },
  2460. "post": {
  2461. "tags": ["mcp"],
  2462. "operationId": "mcp.add",
  2463. "parameters": [
  2464. {
  2465. "name": "directory",
  2466. "in": "query",
  2467. "schema": {
  2468. "type": "string"
  2469. },
  2470. "required": false
  2471. },
  2472. {
  2473. "name": "workspace",
  2474. "in": "query",
  2475. "schema": {
  2476. "type": "string"
  2477. },
  2478. "required": false
  2479. }
  2480. ],
  2481. "responses": {
  2482. "200": {
  2483. "description": "MCP server added successfully",
  2484. "content": {
  2485. "application/json": {
  2486. "schema": {
  2487. "type": "object",
  2488. "additionalProperties": {
  2489. "$ref": "#/components/schemas/MCPStatus"
  2490. },
  2491. "description": "MCP server added successfully"
  2492. }
  2493. }
  2494. }
  2495. },
  2496. "400": {
  2497. "description": "Bad request",
  2498. "content": {
  2499. "application/json": {
  2500. "schema": {
  2501. "$ref": "#/components/schemas/BadRequestError"
  2502. }
  2503. }
  2504. }
  2505. }
  2506. },
  2507. "description": "Dynamically add a new Model Context Protocol (MCP) server to the system.",
  2508. "summary": "Add MCP server",
  2509. "requestBody": {
  2510. "content": {
  2511. "application/json": {
  2512. "schema": {
  2513. "type": "object",
  2514. "properties": {
  2515. "name": {
  2516. "type": "string"
  2517. },
  2518. "config": {
  2519. "anyOf": [
  2520. {
  2521. "$ref": "#/components/schemas/McpLocalConfig"
  2522. },
  2523. {
  2524. "$ref": "#/components/schemas/McpRemoteConfig"
  2525. }
  2526. ]
  2527. }
  2528. },
  2529. "required": ["name", "config"],
  2530. "additionalProperties": false
  2531. }
  2532. }
  2533. }
  2534. },
  2535. "x-codeSamples": [
  2536. {
  2537. "lang": "js",
  2538. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.add({\n ...\n})"
  2539. }
  2540. ]
  2541. }
  2542. },
  2543. "/mcp/{name}/auth": {
  2544. "post": {
  2545. "tags": ["mcp"],
  2546. "operationId": "mcp.auth.start",
  2547. "parameters": [
  2548. {
  2549. "name": "name",
  2550. "in": "path",
  2551. "schema": {
  2552. "type": "string"
  2553. },
  2554. "required": true
  2555. },
  2556. {
  2557. "name": "directory",
  2558. "in": "query",
  2559. "schema": {
  2560. "type": "string"
  2561. },
  2562. "required": false
  2563. },
  2564. {
  2565. "name": "workspace",
  2566. "in": "query",
  2567. "schema": {
  2568. "type": "string"
  2569. },
  2570. "required": false
  2571. }
  2572. ],
  2573. "responses": {
  2574. "200": {
  2575. "description": "OAuth flow started",
  2576. "content": {
  2577. "application/json": {
  2578. "schema": {
  2579. "type": "object",
  2580. "properties": {
  2581. "authorizationUrl": {
  2582. "type": "string"
  2583. },
  2584. "oauthState": {
  2585. "type": "string"
  2586. }
  2587. },
  2588. "required": ["authorizationUrl", "oauthState"],
  2589. "additionalProperties": false,
  2590. "description": "OAuth flow started"
  2591. }
  2592. }
  2593. }
  2594. },
  2595. "400": {
  2596. "description": "McpUnsupportedOAuthError",
  2597. "content": {
  2598. "application/json": {
  2599. "schema": {
  2600. "$ref": "#/components/schemas/McpUnsupportedOAuthError"
  2601. }
  2602. }
  2603. }
  2604. },
  2605. "404": {
  2606. "description": "Not found",
  2607. "content": {
  2608. "application/json": {
  2609. "schema": {
  2610. "$ref": "#/components/schemas/NotFoundError"
  2611. }
  2612. }
  2613. }
  2614. }
  2615. },
  2616. "description": "Start OAuth authentication flow for a Model Context Protocol (MCP) server.",
  2617. "summary": "Start MCP OAuth",
  2618. "x-codeSamples": [
  2619. {
  2620. "lang": "js",
  2621. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.auth.start({\n ...\n})"
  2622. }
  2623. ]
  2624. },
  2625. "delete": {
  2626. "tags": ["mcp"],
  2627. "operationId": "mcp.auth.remove",
  2628. "parameters": [
  2629. {
  2630. "name": "name",
  2631. "in": "path",
  2632. "schema": {
  2633. "type": "string"
  2634. },
  2635. "required": true
  2636. },
  2637. {
  2638. "name": "directory",
  2639. "in": "query",
  2640. "schema": {
  2641. "type": "string"
  2642. },
  2643. "required": false
  2644. },
  2645. {
  2646. "name": "workspace",
  2647. "in": "query",
  2648. "schema": {
  2649. "type": "string"
  2650. },
  2651. "required": false
  2652. }
  2653. ],
  2654. "responses": {
  2655. "200": {
  2656. "description": "OAuth credentials removed",
  2657. "content": {
  2658. "application/json": {
  2659. "schema": {
  2660. "type": "object",
  2661. "properties": {
  2662. "success": {
  2663. "type": "boolean",
  2664. "enum": [true]
  2665. }
  2666. },
  2667. "required": ["success"],
  2668. "additionalProperties": false,
  2669. "description": "OAuth credentials removed"
  2670. }
  2671. }
  2672. }
  2673. },
  2674. "404": {
  2675. "description": "Not found",
  2676. "content": {
  2677. "application/json": {
  2678. "schema": {
  2679. "$ref": "#/components/schemas/NotFoundError"
  2680. }
  2681. }
  2682. }
  2683. }
  2684. },
  2685. "description": "Remove OAuth credentials for an MCP server.",
  2686. "summary": "Remove MCP OAuth",
  2687. "x-codeSamples": [
  2688. {
  2689. "lang": "js",
  2690. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.auth.remove({\n ...\n})"
  2691. }
  2692. ]
  2693. }
  2694. },
  2695. "/mcp/{name}/auth/callback": {
  2696. "post": {
  2697. "tags": ["mcp"],
  2698. "operationId": "mcp.auth.callback",
  2699. "parameters": [
  2700. {
  2701. "name": "name",
  2702. "in": "path",
  2703. "schema": {
  2704. "type": "string"
  2705. },
  2706. "required": true
  2707. },
  2708. {
  2709. "name": "directory",
  2710. "in": "query",
  2711. "schema": {
  2712. "type": "string"
  2713. },
  2714. "required": false
  2715. },
  2716. {
  2717. "name": "workspace",
  2718. "in": "query",
  2719. "schema": {
  2720. "type": "string"
  2721. },
  2722. "required": false
  2723. }
  2724. ],
  2725. "responses": {
  2726. "200": {
  2727. "description": "OAuth authentication completed",
  2728. "content": {
  2729. "application/json": {
  2730. "schema": {
  2731. "$ref": "#/components/schemas/MCPStatus"
  2732. }
  2733. }
  2734. }
  2735. },
  2736. "400": {
  2737. "description": "Bad request",
  2738. "content": {
  2739. "application/json": {
  2740. "schema": {
  2741. "$ref": "#/components/schemas/BadRequestError"
  2742. }
  2743. }
  2744. }
  2745. },
  2746. "404": {
  2747. "description": "Not found",
  2748. "content": {
  2749. "application/json": {
  2750. "schema": {
  2751. "$ref": "#/components/schemas/NotFoundError"
  2752. }
  2753. }
  2754. }
  2755. }
  2756. },
  2757. "description": "Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code.",
  2758. "summary": "Complete MCP OAuth",
  2759. "requestBody": {
  2760. "content": {
  2761. "application/json": {
  2762. "schema": {
  2763. "type": "object",
  2764. "properties": {
  2765. "code": {
  2766. "type": "string"
  2767. }
  2768. },
  2769. "required": ["code"],
  2770. "additionalProperties": false
  2771. }
  2772. }
  2773. }
  2774. },
  2775. "x-codeSamples": [
  2776. {
  2777. "lang": "js",
  2778. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.auth.callback({\n ...\n})"
  2779. }
  2780. ]
  2781. }
  2782. },
  2783. "/mcp/{name}/auth/authenticate": {
  2784. "post": {
  2785. "tags": ["mcp"],
  2786. "operationId": "mcp.auth.authenticate",
  2787. "parameters": [
  2788. {
  2789. "name": "name",
  2790. "in": "path",
  2791. "schema": {
  2792. "type": "string"
  2793. },
  2794. "required": true
  2795. },
  2796. {
  2797. "name": "directory",
  2798. "in": "query",
  2799. "schema": {
  2800. "type": "string"
  2801. },
  2802. "required": false
  2803. },
  2804. {
  2805. "name": "workspace",
  2806. "in": "query",
  2807. "schema": {
  2808. "type": "string"
  2809. },
  2810. "required": false
  2811. }
  2812. ],
  2813. "responses": {
  2814. "200": {
  2815. "description": "OAuth authentication completed",
  2816. "content": {
  2817. "application/json": {
  2818. "schema": {
  2819. "$ref": "#/components/schemas/MCPStatus"
  2820. }
  2821. }
  2822. }
  2823. },
  2824. "400": {
  2825. "description": "McpUnsupportedOAuthError",
  2826. "content": {
  2827. "application/json": {
  2828. "schema": {
  2829. "$ref": "#/components/schemas/McpUnsupportedOAuthError"
  2830. }
  2831. }
  2832. }
  2833. },
  2834. "404": {
  2835. "description": "Not found",
  2836. "content": {
  2837. "application/json": {
  2838. "schema": {
  2839. "$ref": "#/components/schemas/NotFoundError"
  2840. }
  2841. }
  2842. }
  2843. }
  2844. },
  2845. "description": "Start OAuth flow and wait for callback (opens browser).",
  2846. "summary": "Authenticate MCP OAuth",
  2847. "x-codeSamples": [
  2848. {
  2849. "lang": "js",
  2850. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.auth.authenticate({\n ...\n})"
  2851. }
  2852. ]
  2853. }
  2854. },
  2855. "/mcp/{name}/connect": {
  2856. "post": {
  2857. "tags": ["mcp"],
  2858. "operationId": "mcp.connect",
  2859. "parameters": [
  2860. {
  2861. "name": "name",
  2862. "in": "path",
  2863. "schema": {
  2864. "type": "string"
  2865. },
  2866. "required": true
  2867. },
  2868. {
  2869. "name": "directory",
  2870. "in": "query",
  2871. "schema": {
  2872. "type": "string"
  2873. },
  2874. "required": false
  2875. },
  2876. {
  2877. "name": "workspace",
  2878. "in": "query",
  2879. "schema": {
  2880. "type": "string"
  2881. },
  2882. "required": false
  2883. }
  2884. ],
  2885. "responses": {
  2886. "200": {
  2887. "description": "MCP server connected successfully",
  2888. "content": {
  2889. "application/json": {
  2890. "schema": {
  2891. "type": "boolean",
  2892. "description": "MCP server connected successfully"
  2893. }
  2894. }
  2895. }
  2896. }
  2897. },
  2898. "description": "Connect an MCP server.",
  2899. "x-codeSamples": [
  2900. {
  2901. "lang": "js",
  2902. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.connect({\n ...\n})"
  2903. }
  2904. ]
  2905. }
  2906. },
  2907. "/mcp/{name}/disconnect": {
  2908. "post": {
  2909. "tags": ["mcp"],
  2910. "operationId": "mcp.disconnect",
  2911. "parameters": [
  2912. {
  2913. "name": "name",
  2914. "in": "path",
  2915. "schema": {
  2916. "type": "string"
  2917. },
  2918. "required": true
  2919. },
  2920. {
  2921. "name": "directory",
  2922. "in": "query",
  2923. "schema": {
  2924. "type": "string"
  2925. },
  2926. "required": false
  2927. },
  2928. {
  2929. "name": "workspace",
  2930. "in": "query",
  2931. "schema": {
  2932. "type": "string"
  2933. },
  2934. "required": false
  2935. }
  2936. ],
  2937. "responses": {
  2938. "200": {
  2939. "description": "MCP server disconnected successfully",
  2940. "content": {
  2941. "application/json": {
  2942. "schema": {
  2943. "type": "boolean",
  2944. "description": "MCP server disconnected successfully"
  2945. }
  2946. }
  2947. }
  2948. }
  2949. },
  2950. "description": "Disconnect an MCP server.",
  2951. "x-codeSamples": [
  2952. {
  2953. "lang": "js",
  2954. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.disconnect({\n ...\n})"
  2955. }
  2956. ]
  2957. }
  2958. },
  2959. "/project": {
  2960. "get": {
  2961. "tags": ["project"],
  2962. "operationId": "project.list",
  2963. "parameters": [
  2964. {
  2965. "name": "directory",
  2966. "in": "query",
  2967. "schema": {
  2968. "type": "string"
  2969. },
  2970. "required": false
  2971. },
  2972. {
  2973. "name": "workspace",
  2974. "in": "query",
  2975. "schema": {
  2976. "type": "string"
  2977. },
  2978. "required": false
  2979. }
  2980. ],
  2981. "responses": {
  2982. "200": {
  2983. "description": "List of projects",
  2984. "content": {
  2985. "application/json": {
  2986. "schema": {
  2987. "type": "array",
  2988. "items": {
  2989. "$ref": "#/components/schemas/Project"
  2990. },
  2991. "description": "List of projects"
  2992. }
  2993. }
  2994. }
  2995. }
  2996. },
  2997. "description": "Get a list of projects that have been opened with OpenCode.",
  2998. "summary": "List all projects",
  2999. "x-codeSamples": [
  3000. {
  3001. "lang": "js",
  3002. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.project.list({\n ...\n})"
  3003. }
  3004. ]
  3005. }
  3006. },
  3007. "/project/current": {
  3008. "get": {
  3009. "tags": ["project"],
  3010. "operationId": "project.current",
  3011. "parameters": [
  3012. {
  3013. "name": "directory",
  3014. "in": "query",
  3015. "schema": {
  3016. "type": "string"
  3017. },
  3018. "required": false
  3019. },
  3020. {
  3021. "name": "workspace",
  3022. "in": "query",
  3023. "schema": {
  3024. "type": "string"
  3025. },
  3026. "required": false
  3027. }
  3028. ],
  3029. "responses": {
  3030. "200": {
  3031. "description": "Current project information",
  3032. "content": {
  3033. "application/json": {
  3034. "schema": {
  3035. "$ref": "#/components/schemas/Project"
  3036. }
  3037. }
  3038. }
  3039. }
  3040. },
  3041. "description": "Retrieve the currently active project that OpenCode is working with.",
  3042. "summary": "Get current project",
  3043. "x-codeSamples": [
  3044. {
  3045. "lang": "js",
  3046. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.project.current({\n ...\n})"
  3047. }
  3048. ]
  3049. }
  3050. },
  3051. "/project/git/init": {
  3052. "post": {
  3053. "tags": ["project"],
  3054. "operationId": "project.initGit",
  3055. "parameters": [
  3056. {
  3057. "name": "directory",
  3058. "in": "query",
  3059. "schema": {
  3060. "type": "string"
  3061. },
  3062. "required": false
  3063. },
  3064. {
  3065. "name": "workspace",
  3066. "in": "query",
  3067. "schema": {
  3068. "type": "string"
  3069. },
  3070. "required": false
  3071. }
  3072. ],
  3073. "responses": {
  3074. "200": {
  3075. "description": "Project information after git initialization",
  3076. "content": {
  3077. "application/json": {
  3078. "schema": {
  3079. "$ref": "#/components/schemas/Project"
  3080. }
  3081. }
  3082. }
  3083. }
  3084. },
  3085. "description": "Create a git repository for the current project and return the refreshed project info.",
  3086. "summary": "Initialize git repository",
  3087. "x-codeSamples": [
  3088. {
  3089. "lang": "js",
  3090. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.project.initGit({\n ...\n})"
  3091. }
  3092. ]
  3093. }
  3094. },
  3095. "/project/{projectID}": {
  3096. "patch": {
  3097. "tags": ["project"],
  3098. "operationId": "project.update",
  3099. "parameters": [
  3100. {
  3101. "name": "projectID",
  3102. "in": "path",
  3103. "schema": {
  3104. "type": "string"
  3105. },
  3106. "required": true
  3107. },
  3108. {
  3109. "name": "directory",
  3110. "in": "query",
  3111. "schema": {
  3112. "type": "string"
  3113. },
  3114. "required": false
  3115. },
  3116. {
  3117. "name": "workspace",
  3118. "in": "query",
  3119. "schema": {
  3120. "type": "string"
  3121. },
  3122. "required": false
  3123. }
  3124. ],
  3125. "responses": {
  3126. "200": {
  3127. "description": "Updated project information",
  3128. "content": {
  3129. "application/json": {
  3130. "schema": {
  3131. "$ref": "#/components/schemas/Project"
  3132. }
  3133. }
  3134. }
  3135. },
  3136. "400": {
  3137. "description": "Bad request",
  3138. "content": {
  3139. "application/json": {
  3140. "schema": {
  3141. "$ref": "#/components/schemas/BadRequestError"
  3142. }
  3143. }
  3144. }
  3145. },
  3146. "404": {
  3147. "description": "Not found",
  3148. "content": {
  3149. "application/json": {
  3150. "schema": {
  3151. "$ref": "#/components/schemas/NotFoundError"
  3152. }
  3153. }
  3154. }
  3155. }
  3156. },
  3157. "description": "Update project properties such as name, icon, and commands.",
  3158. "summary": "Update project",
  3159. "requestBody": {
  3160. "content": {
  3161. "application/json": {
  3162. "schema": {
  3163. "type": "object",
  3164. "properties": {
  3165. "name": {
  3166. "type": "string"
  3167. },
  3168. "icon": {
  3169. "type": "object",
  3170. "properties": {
  3171. "url": {
  3172. "type": "string"
  3173. },
  3174. "override": {
  3175. "type": "string"
  3176. },
  3177. "color": {
  3178. "type": "string"
  3179. }
  3180. },
  3181. "additionalProperties": false
  3182. },
  3183. "commands": {
  3184. "type": "object",
  3185. "properties": {
  3186. "start": {
  3187. "type": "string",
  3188. "description": "Startup script to run when creating a new workspace (worktree)"
  3189. }
  3190. },
  3191. "additionalProperties": false
  3192. }
  3193. },
  3194. "additionalProperties": false
  3195. }
  3196. }
  3197. }
  3198. },
  3199. "x-codeSamples": [
  3200. {
  3201. "lang": "js",
  3202. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.project.update({\n ...\n})"
  3203. }
  3204. ]
  3205. }
  3206. },
  3207. "/pty/shells": {
  3208. "get": {
  3209. "tags": ["pty"],
  3210. "operationId": "pty.shells",
  3211. "parameters": [
  3212. {
  3213. "name": "directory",
  3214. "in": "query",
  3215. "schema": {
  3216. "type": "string"
  3217. },
  3218. "required": false
  3219. },
  3220. {
  3221. "name": "workspace",
  3222. "in": "query",
  3223. "schema": {
  3224. "type": "string"
  3225. },
  3226. "required": false
  3227. }
  3228. ],
  3229. "responses": {
  3230. "200": {
  3231. "description": "List of shells",
  3232. "content": {
  3233. "application/json": {
  3234. "schema": {
  3235. "type": "array",
  3236. "items": {
  3237. "type": "object",
  3238. "properties": {
  3239. "path": {
  3240. "type": "string"
  3241. },
  3242. "name": {
  3243. "type": "string"
  3244. },
  3245. "acceptable": {
  3246. "type": "boolean"
  3247. }
  3248. },
  3249. "required": ["path", "name", "acceptable"],
  3250. "additionalProperties": false
  3251. },
  3252. "description": "List of shells"
  3253. }
  3254. }
  3255. }
  3256. }
  3257. },
  3258. "description": "Get a list of available shells on the system.",
  3259. "summary": "List available shells",
  3260. "x-codeSamples": [
  3261. {
  3262. "lang": "js",
  3263. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.shells({\n ...\n})"
  3264. }
  3265. ]
  3266. }
  3267. },
  3268. "/pty": {
  3269. "get": {
  3270. "tags": ["pty"],
  3271. "operationId": "pty.list",
  3272. "parameters": [
  3273. {
  3274. "name": "directory",
  3275. "in": "query",
  3276. "schema": {
  3277. "type": "string"
  3278. },
  3279. "required": false
  3280. },
  3281. {
  3282. "name": "workspace",
  3283. "in": "query",
  3284. "schema": {
  3285. "type": "string"
  3286. },
  3287. "required": false
  3288. }
  3289. ],
  3290. "responses": {
  3291. "200": {
  3292. "description": "List of sessions",
  3293. "content": {
  3294. "application/json": {
  3295. "schema": {
  3296. "type": "array",
  3297. "items": {
  3298. "$ref": "#/components/schemas/Pty"
  3299. },
  3300. "description": "List of sessions"
  3301. }
  3302. }
  3303. }
  3304. }
  3305. },
  3306. "description": "Get a list of all active pseudo-terminal (PTY) sessions managed by OpenCode.",
  3307. "summary": "List PTY sessions",
  3308. "x-codeSamples": [
  3309. {
  3310. "lang": "js",
  3311. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.list({\n ...\n})"
  3312. }
  3313. ]
  3314. },
  3315. "post": {
  3316. "tags": ["pty"],
  3317. "operationId": "pty.create",
  3318. "parameters": [
  3319. {
  3320. "name": "directory",
  3321. "in": "query",
  3322. "schema": {
  3323. "type": "string"
  3324. },
  3325. "required": false
  3326. },
  3327. {
  3328. "name": "workspace",
  3329. "in": "query",
  3330. "schema": {
  3331. "type": "string"
  3332. },
  3333. "required": false
  3334. }
  3335. ],
  3336. "responses": {
  3337. "200": {
  3338. "description": "Created session",
  3339. "content": {
  3340. "application/json": {
  3341. "schema": {
  3342. "$ref": "#/components/schemas/Pty"
  3343. }
  3344. }
  3345. }
  3346. },
  3347. "400": {
  3348. "description": "Bad request",
  3349. "content": {
  3350. "application/json": {
  3351. "schema": {
  3352. "$ref": "#/components/schemas/BadRequestError"
  3353. }
  3354. }
  3355. }
  3356. }
  3357. },
  3358. "description": "Create a new pseudo-terminal (PTY) session for running shell commands and processes.",
  3359. "summary": "Create PTY session",
  3360. "requestBody": {
  3361. "content": {
  3362. "application/json": {
  3363. "schema": {
  3364. "type": "object",
  3365. "properties": {
  3366. "command": {
  3367. "type": "string"
  3368. },
  3369. "args": {
  3370. "type": "array",
  3371. "items": {
  3372. "type": "string"
  3373. }
  3374. },
  3375. "cwd": {
  3376. "type": "string"
  3377. },
  3378. "title": {
  3379. "type": "string"
  3380. },
  3381. "env": {
  3382. "type": "object",
  3383. "additionalProperties": {
  3384. "type": "string"
  3385. }
  3386. }
  3387. },
  3388. "additionalProperties": false
  3389. }
  3390. }
  3391. }
  3392. },
  3393. "x-codeSamples": [
  3394. {
  3395. "lang": "js",
  3396. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.create({\n ...\n})"
  3397. }
  3398. ]
  3399. }
  3400. },
  3401. "/pty/{ptyID}": {
  3402. "get": {
  3403. "tags": ["pty"],
  3404. "operationId": "pty.get",
  3405. "parameters": [
  3406. {
  3407. "name": "ptyID",
  3408. "in": "path",
  3409. "schema": {
  3410. "type": "string",
  3411. "pattern": "^pty"
  3412. },
  3413. "required": true
  3414. },
  3415. {
  3416. "name": "directory",
  3417. "in": "query",
  3418. "schema": {
  3419. "type": "string"
  3420. },
  3421. "required": false
  3422. },
  3423. {
  3424. "name": "workspace",
  3425. "in": "query",
  3426. "schema": {
  3427. "type": "string"
  3428. },
  3429. "required": false
  3430. }
  3431. ],
  3432. "responses": {
  3433. "200": {
  3434. "description": "Session info",
  3435. "content": {
  3436. "application/json": {
  3437. "schema": {
  3438. "$ref": "#/components/schemas/Pty"
  3439. }
  3440. }
  3441. }
  3442. },
  3443. "404": {
  3444. "description": "NotFoundError",
  3445. "content": {
  3446. "application/json": {
  3447. "schema": {
  3448. "$ref": "#/components/schemas/NotFoundError"
  3449. }
  3450. }
  3451. }
  3452. }
  3453. },
  3454. "description": "Retrieve detailed information about a specific pseudo-terminal (PTY) session.",
  3455. "summary": "Get PTY session",
  3456. "x-codeSamples": [
  3457. {
  3458. "lang": "js",
  3459. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.get({\n ...\n})"
  3460. }
  3461. ]
  3462. },
  3463. "put": {
  3464. "tags": ["pty"],
  3465. "operationId": "pty.update",
  3466. "parameters": [
  3467. {
  3468. "name": "ptyID",
  3469. "in": "path",
  3470. "schema": {
  3471. "type": "string",
  3472. "pattern": "^pty"
  3473. },
  3474. "required": true
  3475. },
  3476. {
  3477. "name": "directory",
  3478. "in": "query",
  3479. "schema": {
  3480. "type": "string"
  3481. },
  3482. "required": false
  3483. },
  3484. {
  3485. "name": "workspace",
  3486. "in": "query",
  3487. "schema": {
  3488. "type": "string"
  3489. },
  3490. "required": false
  3491. }
  3492. ],
  3493. "responses": {
  3494. "200": {
  3495. "description": "Updated session",
  3496. "content": {
  3497. "application/json": {
  3498. "schema": {
  3499. "$ref": "#/components/schemas/Pty"
  3500. }
  3501. }
  3502. }
  3503. },
  3504. "400": {
  3505. "description": "Bad request",
  3506. "content": {
  3507. "application/json": {
  3508. "schema": {
  3509. "$ref": "#/components/schemas/BadRequestError"
  3510. }
  3511. }
  3512. }
  3513. }
  3514. },
  3515. "description": "Update properties of an existing pseudo-terminal (PTY) session.",
  3516. "summary": "Update PTY session",
  3517. "requestBody": {
  3518. "content": {
  3519. "application/json": {
  3520. "schema": {
  3521. "type": "object",
  3522. "properties": {
  3523. "title": {
  3524. "type": "string"
  3525. },
  3526. "size": {
  3527. "type": "object",
  3528. "properties": {
  3529. "rows": {
  3530. "type": "integer",
  3531. "exclusiveMinimum": 0
  3532. },
  3533. "cols": {
  3534. "type": "integer",
  3535. "exclusiveMinimum": 0
  3536. }
  3537. },
  3538. "required": ["rows", "cols"],
  3539. "additionalProperties": false
  3540. }
  3541. },
  3542. "additionalProperties": false
  3543. }
  3544. }
  3545. }
  3546. },
  3547. "x-codeSamples": [
  3548. {
  3549. "lang": "js",
  3550. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.update({\n ...\n})"
  3551. }
  3552. ]
  3553. },
  3554. "delete": {
  3555. "tags": ["pty"],
  3556. "operationId": "pty.remove",
  3557. "parameters": [
  3558. {
  3559. "name": "ptyID",
  3560. "in": "path",
  3561. "schema": {
  3562. "type": "string",
  3563. "pattern": "^pty"
  3564. },
  3565. "required": true
  3566. },
  3567. {
  3568. "name": "directory",
  3569. "in": "query",
  3570. "schema": {
  3571. "type": "string"
  3572. },
  3573. "required": false
  3574. },
  3575. {
  3576. "name": "workspace",
  3577. "in": "query",
  3578. "schema": {
  3579. "type": "string"
  3580. },
  3581. "required": false
  3582. }
  3583. ],
  3584. "responses": {
  3585. "200": {
  3586. "description": "Session removed",
  3587. "content": {
  3588. "application/json": {
  3589. "schema": {
  3590. "type": "boolean",
  3591. "description": "Session removed"
  3592. }
  3593. }
  3594. }
  3595. },
  3596. "404": {
  3597. "description": "NotFoundError",
  3598. "content": {
  3599. "application/json": {
  3600. "schema": {
  3601. "$ref": "#/components/schemas/NotFoundError"
  3602. }
  3603. }
  3604. }
  3605. }
  3606. },
  3607. "description": "Remove and terminate a specific pseudo-terminal (PTY) session.",
  3608. "summary": "Remove PTY session",
  3609. "x-codeSamples": [
  3610. {
  3611. "lang": "js",
  3612. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.remove({\n ...\n})"
  3613. }
  3614. ]
  3615. }
  3616. },
  3617. "/pty/{ptyID}/connect-token": {
  3618. "post": {
  3619. "tags": ["pty"],
  3620. "operationId": "pty.connectToken",
  3621. "parameters": [
  3622. {
  3623. "name": "ptyID",
  3624. "in": "path",
  3625. "schema": {
  3626. "type": "string",
  3627. "pattern": "^pty"
  3628. },
  3629. "required": true
  3630. },
  3631. {
  3632. "name": "directory",
  3633. "in": "query",
  3634. "schema": {
  3635. "type": "string"
  3636. },
  3637. "required": false
  3638. },
  3639. {
  3640. "name": "workspace",
  3641. "in": "query",
  3642. "schema": {
  3643. "type": "string"
  3644. },
  3645. "required": false
  3646. }
  3647. ],
  3648. "responses": {
  3649. "200": {
  3650. "description": "WebSocket connect token",
  3651. "content": {
  3652. "application/json": {
  3653. "schema": {
  3654. "type": "object",
  3655. "properties": {
  3656. "ticket": {
  3657. "type": "string"
  3658. },
  3659. "expires_in": {
  3660. "type": "integer",
  3661. "exclusiveMinimum": 0
  3662. }
  3663. },
  3664. "required": ["ticket", "expires_in"],
  3665. "additionalProperties": false,
  3666. "description": "WebSocket connect token"
  3667. }
  3668. }
  3669. }
  3670. },
  3671. "403": {
  3672. "description": "Forbidden",
  3673. "content": {
  3674. "application/json": {
  3675. "schema": {
  3676. "$ref": "#/components/schemas/effect_HttpApiError_Forbidden"
  3677. }
  3678. }
  3679. }
  3680. },
  3681. "404": {
  3682. "description": "NotFoundError",
  3683. "content": {
  3684. "application/json": {
  3685. "schema": {
  3686. "$ref": "#/components/schemas/NotFoundError"
  3687. }
  3688. }
  3689. }
  3690. }
  3691. },
  3692. "description": "Create a short-lived ticket for opening a PTY WebSocket connection.",
  3693. "summary": "Create PTY WebSocket token",
  3694. "x-codeSamples": [
  3695. {
  3696. "lang": "js",
  3697. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.connectToken({\n ...\n})"
  3698. }
  3699. ]
  3700. }
  3701. },
  3702. "/question": {
  3703. "get": {
  3704. "tags": ["question"],
  3705. "operationId": "question.list",
  3706. "parameters": [
  3707. {
  3708. "name": "directory",
  3709. "in": "query",
  3710. "schema": {
  3711. "type": "string"
  3712. },
  3713. "required": false
  3714. },
  3715. {
  3716. "name": "workspace",
  3717. "in": "query",
  3718. "schema": {
  3719. "type": "string"
  3720. },
  3721. "required": false
  3722. }
  3723. ],
  3724. "responses": {
  3725. "200": {
  3726. "description": "List of pending questions",
  3727. "content": {
  3728. "application/json": {
  3729. "schema": {
  3730. "type": "array",
  3731. "items": {
  3732. "$ref": "#/components/schemas/QuestionRequest"
  3733. },
  3734. "description": "List of pending questions"
  3735. }
  3736. }
  3737. }
  3738. }
  3739. },
  3740. "description": "Get all pending question requests across all sessions.",
  3741. "summary": "List pending questions",
  3742. "x-codeSamples": [
  3743. {
  3744. "lang": "js",
  3745. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.question.list({\n ...\n})"
  3746. }
  3747. ]
  3748. }
  3749. },
  3750. "/question/{requestID}/reply": {
  3751. "post": {
  3752. "tags": ["question"],
  3753. "operationId": "question.reply",
  3754. "parameters": [
  3755. {
  3756. "name": "requestID",
  3757. "in": "path",
  3758. "schema": {
  3759. "type": "string",
  3760. "pattern": "^que"
  3761. },
  3762. "required": true
  3763. },
  3764. {
  3765. "name": "directory",
  3766. "in": "query",
  3767. "schema": {
  3768. "type": "string"
  3769. },
  3770. "required": false
  3771. },
  3772. {
  3773. "name": "workspace",
  3774. "in": "query",
  3775. "schema": {
  3776. "type": "string"
  3777. },
  3778. "required": false
  3779. }
  3780. ],
  3781. "responses": {
  3782. "200": {
  3783. "description": "Question answered successfully",
  3784. "content": {
  3785. "application/json": {
  3786. "schema": {
  3787. "type": "boolean",
  3788. "description": "Question answered successfully"
  3789. }
  3790. }
  3791. }
  3792. },
  3793. "400": {
  3794. "description": "Bad request",
  3795. "content": {
  3796. "application/json": {
  3797. "schema": {
  3798. "$ref": "#/components/schemas/BadRequestError"
  3799. }
  3800. }
  3801. }
  3802. },
  3803. "404": {
  3804. "description": "Not found",
  3805. "content": {
  3806. "application/json": {
  3807. "schema": {
  3808. "$ref": "#/components/schemas/NotFoundError"
  3809. }
  3810. }
  3811. }
  3812. }
  3813. },
  3814. "description": "Provide answers to a question request from the AI assistant.",
  3815. "summary": "Reply to question request",
  3816. "requestBody": {
  3817. "content": {
  3818. "application/json": {
  3819. "schema": {
  3820. "type": "object",
  3821. "properties": {
  3822. "answers": {
  3823. "type": "array",
  3824. "items": {
  3825. "$ref": "#/components/schemas/QuestionAnswer"
  3826. },
  3827. "description": "User answers in order of questions (each answer is an array of selected labels)"
  3828. }
  3829. },
  3830. "required": ["answers"],
  3831. "additionalProperties": false
  3832. }
  3833. }
  3834. }
  3835. },
  3836. "x-codeSamples": [
  3837. {
  3838. "lang": "js",
  3839. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.question.reply({\n ...\n})"
  3840. }
  3841. ]
  3842. }
  3843. },
  3844. "/question/{requestID}/reject": {
  3845. "post": {
  3846. "tags": ["question"],
  3847. "operationId": "question.reject",
  3848. "parameters": [
  3849. {
  3850. "name": "requestID",
  3851. "in": "path",
  3852. "schema": {
  3853. "type": "string",
  3854. "pattern": "^que"
  3855. },
  3856. "required": true
  3857. },
  3858. {
  3859. "name": "directory",
  3860. "in": "query",
  3861. "schema": {
  3862. "type": "string"
  3863. },
  3864. "required": false
  3865. },
  3866. {
  3867. "name": "workspace",
  3868. "in": "query",
  3869. "schema": {
  3870. "type": "string"
  3871. },
  3872. "required": false
  3873. }
  3874. ],
  3875. "responses": {
  3876. "200": {
  3877. "description": "Question rejected successfully",
  3878. "content": {
  3879. "application/json": {
  3880. "schema": {
  3881. "type": "boolean",
  3882. "description": "Question rejected successfully"
  3883. }
  3884. }
  3885. }
  3886. },
  3887. "400": {
  3888. "description": "Bad request",
  3889. "content": {
  3890. "application/json": {
  3891. "schema": {
  3892. "$ref": "#/components/schemas/BadRequestError"
  3893. }
  3894. }
  3895. }
  3896. },
  3897. "404": {
  3898. "description": "Not found",
  3899. "content": {
  3900. "application/json": {
  3901. "schema": {
  3902. "$ref": "#/components/schemas/NotFoundError"
  3903. }
  3904. }
  3905. }
  3906. }
  3907. },
  3908. "description": "Reject a question request from the AI assistant.",
  3909. "summary": "Reject question request",
  3910. "x-codeSamples": [
  3911. {
  3912. "lang": "js",
  3913. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.question.reject({\n ...\n})"
  3914. }
  3915. ]
  3916. }
  3917. },
  3918. "/permission": {
  3919. "get": {
  3920. "tags": ["permission"],
  3921. "operationId": "permission.list",
  3922. "parameters": [
  3923. {
  3924. "name": "directory",
  3925. "in": "query",
  3926. "schema": {
  3927. "type": "string"
  3928. },
  3929. "required": false
  3930. },
  3931. {
  3932. "name": "workspace",
  3933. "in": "query",
  3934. "schema": {
  3935. "type": "string"
  3936. },
  3937. "required": false
  3938. }
  3939. ],
  3940. "responses": {
  3941. "200": {
  3942. "description": "List of pending permissions",
  3943. "content": {
  3944. "application/json": {
  3945. "schema": {
  3946. "type": "array",
  3947. "items": {
  3948. "$ref": "#/components/schemas/PermissionRequest"
  3949. },
  3950. "description": "List of pending permissions"
  3951. }
  3952. }
  3953. }
  3954. }
  3955. },
  3956. "description": "Get all pending permission requests across all sessions.",
  3957. "summary": "List pending permissions",
  3958. "x-codeSamples": [
  3959. {
  3960. "lang": "js",
  3961. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.permission.list({\n ...\n})"
  3962. }
  3963. ]
  3964. }
  3965. },
  3966. "/permission/{requestID}/reply": {
  3967. "post": {
  3968. "tags": ["permission"],
  3969. "operationId": "permission.reply",
  3970. "parameters": [
  3971. {
  3972. "name": "requestID",
  3973. "in": "path",
  3974. "schema": {
  3975. "type": "string",
  3976. "pattern": "^per"
  3977. },
  3978. "required": true
  3979. },
  3980. {
  3981. "name": "directory",
  3982. "in": "query",
  3983. "schema": {
  3984. "type": "string"
  3985. },
  3986. "required": false
  3987. },
  3988. {
  3989. "name": "workspace",
  3990. "in": "query",
  3991. "schema": {
  3992. "type": "string"
  3993. },
  3994. "required": false
  3995. }
  3996. ],
  3997. "responses": {
  3998. "200": {
  3999. "description": "Permission processed successfully",
  4000. "content": {
  4001. "application/json": {
  4002. "schema": {
  4003. "type": "boolean",
  4004. "description": "Permission processed successfully"
  4005. }
  4006. }
  4007. }
  4008. },
  4009. "400": {
  4010. "description": "Bad request",
  4011. "content": {
  4012. "application/json": {
  4013. "schema": {
  4014. "$ref": "#/components/schemas/BadRequestError"
  4015. }
  4016. }
  4017. }
  4018. },
  4019. "404": {
  4020. "description": "Not found",
  4021. "content": {
  4022. "application/json": {
  4023. "schema": {
  4024. "$ref": "#/components/schemas/NotFoundError"
  4025. }
  4026. }
  4027. }
  4028. }
  4029. },
  4030. "description": "Approve or deny a permission request from the AI assistant.",
  4031. "summary": "Respond to permission request",
  4032. "requestBody": {
  4033. "content": {
  4034. "application/json": {
  4035. "schema": {
  4036. "type": "object",
  4037. "properties": {
  4038. "reply": {
  4039. "type": "string",
  4040. "enum": ["once", "always", "reject"]
  4041. },
  4042. "message": {
  4043. "type": "string"
  4044. }
  4045. },
  4046. "required": ["reply"],
  4047. "additionalProperties": false
  4048. }
  4049. }
  4050. }
  4051. },
  4052. "x-codeSamples": [
  4053. {
  4054. "lang": "js",
  4055. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.permission.reply({\n ...\n})"
  4056. }
  4057. ]
  4058. }
  4059. },
  4060. "/provider": {
  4061. "get": {
  4062. "tags": ["provider"],
  4063. "operationId": "provider.list",
  4064. "parameters": [
  4065. {
  4066. "name": "directory",
  4067. "in": "query",
  4068. "schema": {
  4069. "type": "string"
  4070. },
  4071. "required": false
  4072. },
  4073. {
  4074. "name": "workspace",
  4075. "in": "query",
  4076. "schema": {
  4077. "type": "string"
  4078. },
  4079. "required": false
  4080. }
  4081. ],
  4082. "responses": {
  4083. "200": {
  4084. "description": "List of providers",
  4085. "content": {
  4086. "application/json": {
  4087. "schema": {
  4088. "type": "object",
  4089. "properties": {
  4090. "all": {
  4091. "type": "array",
  4092. "items": {
  4093. "$ref": "#/components/schemas/Provider"
  4094. }
  4095. },
  4096. "default": {
  4097. "type": "object",
  4098. "additionalProperties": {
  4099. "type": "string"
  4100. }
  4101. },
  4102. "connected": {
  4103. "type": "array",
  4104. "items": {
  4105. "type": "string"
  4106. }
  4107. }
  4108. },
  4109. "required": ["all", "default", "connected"],
  4110. "additionalProperties": false,
  4111. "description": "List of providers"
  4112. }
  4113. }
  4114. }
  4115. }
  4116. },
  4117. "description": "Get a list of all available AI providers, including both available and connected ones.",
  4118. "summary": "List providers",
  4119. "x-codeSamples": [
  4120. {
  4121. "lang": "js",
  4122. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.provider.list({\n ...\n})"
  4123. }
  4124. ]
  4125. }
  4126. },
  4127. "/provider/auth": {
  4128. "get": {
  4129. "tags": ["provider"],
  4130. "operationId": "provider.auth",
  4131. "parameters": [
  4132. {
  4133. "name": "directory",
  4134. "in": "query",
  4135. "schema": {
  4136. "type": "string"
  4137. },
  4138. "required": false
  4139. },
  4140. {
  4141. "name": "workspace",
  4142. "in": "query",
  4143. "schema": {
  4144. "type": "string"
  4145. },
  4146. "required": false
  4147. }
  4148. ],
  4149. "responses": {
  4150. "200": {
  4151. "description": "Provider auth methods",
  4152. "content": {
  4153. "application/json": {
  4154. "schema": {
  4155. "type": "object",
  4156. "additionalProperties": {
  4157. "type": "array",
  4158. "items": {
  4159. "$ref": "#/components/schemas/ProviderAuthMethod"
  4160. }
  4161. },
  4162. "description": "Provider auth methods"
  4163. }
  4164. }
  4165. }
  4166. }
  4167. },
  4168. "description": "Retrieve available authentication methods for all AI providers.",
  4169. "summary": "Get provider auth methods",
  4170. "x-codeSamples": [
  4171. {
  4172. "lang": "js",
  4173. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.provider.auth({\n ...\n})"
  4174. }
  4175. ]
  4176. }
  4177. },
  4178. "/provider/{providerID}/oauth/authorize": {
  4179. "post": {
  4180. "tags": ["provider"],
  4181. "operationId": "provider.oauth.authorize",
  4182. "parameters": [
  4183. {
  4184. "name": "providerID",
  4185. "in": "path",
  4186. "schema": {
  4187. "type": "string"
  4188. },
  4189. "required": true
  4190. },
  4191. {
  4192. "name": "directory",
  4193. "in": "query",
  4194. "schema": {
  4195. "type": "string"
  4196. },
  4197. "required": false
  4198. },
  4199. {
  4200. "name": "workspace",
  4201. "in": "query",
  4202. "schema": {
  4203. "type": "string"
  4204. },
  4205. "required": false
  4206. }
  4207. ],
  4208. "responses": {
  4209. "200": {
  4210. "description": "Authorization URL and method",
  4211. "content": {
  4212. "application/json": {
  4213. "schema": {
  4214. "$ref": "#/components/schemas/ProviderAuthAuthorization"
  4215. }
  4216. }
  4217. }
  4218. },
  4219. "400": {
  4220. "description": "ProviderAuthError",
  4221. "content": {
  4222. "application/json": {
  4223. "schema": {
  4224. "$ref": "#/components/schemas/ProviderAuthError1"
  4225. }
  4226. }
  4227. }
  4228. }
  4229. },
  4230. "description": "Start the OAuth authorization flow for a provider.",
  4231. "summary": "Start OAuth authorization",
  4232. "requestBody": {
  4233. "content": {
  4234. "application/json": {
  4235. "schema": {
  4236. "type": "object",
  4237. "properties": {
  4238. "method": {
  4239. "type": "number",
  4240. "description": "Auth method index"
  4241. },
  4242. "inputs": {
  4243. "type": "object",
  4244. "additionalProperties": {
  4245. "type": "string"
  4246. }
  4247. }
  4248. },
  4249. "required": ["method"],
  4250. "additionalProperties": false
  4251. }
  4252. }
  4253. }
  4254. },
  4255. "x-codeSamples": [
  4256. {
  4257. "lang": "js",
  4258. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.provider.oauth.authorize({\n ...\n})"
  4259. }
  4260. ]
  4261. }
  4262. },
  4263. "/provider/{providerID}/oauth/callback": {
  4264. "post": {
  4265. "tags": ["provider"],
  4266. "operationId": "provider.oauth.callback",
  4267. "parameters": [
  4268. {
  4269. "name": "providerID",
  4270. "in": "path",
  4271. "schema": {
  4272. "type": "string"
  4273. },
  4274. "required": true
  4275. },
  4276. {
  4277. "name": "directory",
  4278. "in": "query",
  4279. "schema": {
  4280. "type": "string"
  4281. },
  4282. "required": false
  4283. },
  4284. {
  4285. "name": "workspace",
  4286. "in": "query",
  4287. "schema": {
  4288. "type": "string"
  4289. },
  4290. "required": false
  4291. }
  4292. ],
  4293. "responses": {
  4294. "200": {
  4295. "description": "OAuth callback processed successfully",
  4296. "content": {
  4297. "application/json": {
  4298. "schema": {
  4299. "type": "boolean",
  4300. "description": "OAuth callback processed successfully"
  4301. }
  4302. }
  4303. }
  4304. },
  4305. "400": {
  4306. "description": "ProviderAuthError",
  4307. "content": {
  4308. "application/json": {
  4309. "schema": {
  4310. "$ref": "#/components/schemas/ProviderAuthError1"
  4311. }
  4312. }
  4313. }
  4314. }
  4315. },
  4316. "description": "Handle the OAuth callback from a provider after user authorization.",
  4317. "summary": "Handle OAuth callback",
  4318. "requestBody": {
  4319. "content": {
  4320. "application/json": {
  4321. "schema": {
  4322. "type": "object",
  4323. "properties": {
  4324. "method": {
  4325. "type": "number",
  4326. "description": "Auth method index"
  4327. },
  4328. "code": {
  4329. "type": "string"
  4330. }
  4331. },
  4332. "required": ["method"],
  4333. "additionalProperties": false
  4334. }
  4335. }
  4336. }
  4337. },
  4338. "x-codeSamples": [
  4339. {
  4340. "lang": "js",
  4341. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.provider.oauth.callback({\n ...\n})"
  4342. }
  4343. ]
  4344. }
  4345. },
  4346. "/session": {
  4347. "get": {
  4348. "tags": ["session"],
  4349. "operationId": "session.list",
  4350. "parameters": [
  4351. {
  4352. "name": "directory",
  4353. "in": "query",
  4354. "schema": {
  4355. "type": "string"
  4356. },
  4357. "required": false
  4358. },
  4359. {
  4360. "name": "workspace",
  4361. "in": "query",
  4362. "schema": {
  4363. "type": "string"
  4364. },
  4365. "required": false
  4366. },
  4367. {
  4368. "name": "scope",
  4369. "in": "query",
  4370. "schema": {
  4371. "type": "string",
  4372. "enum": ["project"]
  4373. },
  4374. "required": false
  4375. },
  4376. {
  4377. "name": "path",
  4378. "in": "query",
  4379. "schema": {
  4380. "type": "string"
  4381. },
  4382. "required": false
  4383. },
  4384. {
  4385. "name": "roots",
  4386. "in": "query",
  4387. "schema": {
  4388. "anyOf": [
  4389. {
  4390. "type": "boolean"
  4391. },
  4392. {
  4393. "type": "string",
  4394. "enum": ["true", "false"]
  4395. }
  4396. ]
  4397. },
  4398. "required": false
  4399. },
  4400. {
  4401. "name": "start",
  4402. "in": "query",
  4403. "schema": {
  4404. "type": "number"
  4405. },
  4406. "required": false
  4407. },
  4408. {
  4409. "name": "search",
  4410. "in": "query",
  4411. "schema": {
  4412. "type": "string"
  4413. },
  4414. "required": false
  4415. },
  4416. {
  4417. "name": "limit",
  4418. "in": "query",
  4419. "schema": {
  4420. "type": "number"
  4421. },
  4422. "required": false
  4423. }
  4424. ],
  4425. "responses": {
  4426. "200": {
  4427. "description": "List of sessions",
  4428. "content": {
  4429. "application/json": {
  4430. "schema": {
  4431. "type": "array",
  4432. "items": {
  4433. "$ref": "#/components/schemas/Session"
  4434. },
  4435. "description": "List of sessions"
  4436. }
  4437. }
  4438. }
  4439. }
  4440. },
  4441. "description": "Get a list of all OpenCode sessions, sorted by most recently updated.",
  4442. "summary": "List sessions",
  4443. "x-codeSamples": [
  4444. {
  4445. "lang": "js",
  4446. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.list({\n ...\n})"
  4447. }
  4448. ]
  4449. },
  4450. "post": {
  4451. "tags": ["session"],
  4452. "operationId": "session.create",
  4453. "parameters": [
  4454. {
  4455. "name": "directory",
  4456. "in": "query",
  4457. "schema": {
  4458. "type": "string"
  4459. },
  4460. "required": false
  4461. },
  4462. {
  4463. "name": "workspace",
  4464. "in": "query",
  4465. "schema": {
  4466. "type": "string"
  4467. },
  4468. "required": false
  4469. }
  4470. ],
  4471. "responses": {
  4472. "200": {
  4473. "description": "Successfully created session",
  4474. "content": {
  4475. "application/json": {
  4476. "schema": {
  4477. "$ref": "#/components/schemas/Session"
  4478. }
  4479. }
  4480. }
  4481. },
  4482. "400": {
  4483. "description": "Bad request",
  4484. "content": {
  4485. "application/json": {
  4486. "schema": {
  4487. "$ref": "#/components/schemas/BadRequestError"
  4488. }
  4489. }
  4490. }
  4491. }
  4492. },
  4493. "description": "Create a new OpenCode session for interacting with AI assistants and managing conversations.",
  4494. "summary": "Create session",
  4495. "requestBody": {
  4496. "content": {
  4497. "application/json": {
  4498. "schema": {
  4499. "type": "object",
  4500. "properties": {
  4501. "parentID": {
  4502. "type": "string",
  4503. "pattern": "^ses"
  4504. },
  4505. "title": {
  4506. "type": "string"
  4507. },
  4508. "agent": {
  4509. "type": "string"
  4510. },
  4511. "model": {
  4512. "type": "object",
  4513. "properties": {
  4514. "id": {
  4515. "type": "string"
  4516. },
  4517. "providerID": {
  4518. "type": "string"
  4519. },
  4520. "variant": {
  4521. "type": "string"
  4522. }
  4523. },
  4524. "required": ["id", "providerID"],
  4525. "additionalProperties": false
  4526. },
  4527. "permission": {
  4528. "$ref": "#/components/schemas/PermissionRuleset"
  4529. },
  4530. "workspaceID": {
  4531. "type": "string",
  4532. "pattern": "^wrk"
  4533. }
  4534. },
  4535. "additionalProperties": false
  4536. }
  4537. }
  4538. }
  4539. },
  4540. "x-codeSamples": [
  4541. {
  4542. "lang": "js",
  4543. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.create({\n ...\n})"
  4544. }
  4545. ]
  4546. }
  4547. },
  4548. "/session/status": {
  4549. "get": {
  4550. "tags": ["session"],
  4551. "operationId": "session.status",
  4552. "parameters": [
  4553. {
  4554. "name": "directory",
  4555. "in": "query",
  4556. "schema": {
  4557. "type": "string"
  4558. },
  4559. "required": false
  4560. },
  4561. {
  4562. "name": "workspace",
  4563. "in": "query",
  4564. "schema": {
  4565. "type": "string"
  4566. },
  4567. "required": false
  4568. }
  4569. ],
  4570. "responses": {
  4571. "200": {
  4572. "description": "Get session status",
  4573. "content": {
  4574. "application/json": {
  4575. "schema": {
  4576. "type": "object",
  4577. "additionalProperties": {
  4578. "$ref": "#/components/schemas/SessionStatus"
  4579. },
  4580. "description": "Get session status"
  4581. }
  4582. }
  4583. }
  4584. },
  4585. "400": {
  4586. "description": "Bad request",
  4587. "content": {
  4588. "application/json": {
  4589. "schema": {
  4590. "$ref": "#/components/schemas/BadRequestError"
  4591. }
  4592. }
  4593. }
  4594. }
  4595. },
  4596. "description": "Retrieve the current status of all sessions, including active, idle, and completed states.",
  4597. "summary": "Get session status",
  4598. "x-codeSamples": [
  4599. {
  4600. "lang": "js",
  4601. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.status({\n ...\n})"
  4602. }
  4603. ]
  4604. }
  4605. },
  4606. "/session/{sessionID}": {
  4607. "get": {
  4608. "tags": ["session"],
  4609. "operationId": "session.get",
  4610. "parameters": [
  4611. {
  4612. "name": "sessionID",
  4613. "in": "path",
  4614. "schema": {
  4615. "type": "string",
  4616. "pattern": "^ses"
  4617. },
  4618. "required": true
  4619. },
  4620. {
  4621. "name": "directory",
  4622. "in": "query",
  4623. "schema": {
  4624. "type": "string"
  4625. },
  4626. "required": false
  4627. },
  4628. {
  4629. "name": "workspace",
  4630. "in": "query",
  4631. "schema": {
  4632. "type": "string"
  4633. },
  4634. "required": false
  4635. }
  4636. ],
  4637. "responses": {
  4638. "200": {
  4639. "description": "Get session",
  4640. "content": {
  4641. "application/json": {
  4642. "schema": {
  4643. "$ref": "#/components/schemas/Session"
  4644. }
  4645. }
  4646. }
  4647. },
  4648. "400": {
  4649. "description": "Bad request",
  4650. "content": {
  4651. "application/json": {
  4652. "schema": {
  4653. "$ref": "#/components/schemas/BadRequestError"
  4654. }
  4655. }
  4656. }
  4657. },
  4658. "404": {
  4659. "description": "NotFoundError",
  4660. "content": {
  4661. "application/json": {
  4662. "schema": {
  4663. "$ref": "#/components/schemas/NotFoundError"
  4664. }
  4665. }
  4666. }
  4667. }
  4668. },
  4669. "description": "Retrieve detailed information about a specific OpenCode session.",
  4670. "summary": "Get session",
  4671. "x-codeSamples": [
  4672. {
  4673. "lang": "js",
  4674. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.get({\n ...\n})"
  4675. }
  4676. ]
  4677. },
  4678. "delete": {
  4679. "tags": ["session"],
  4680. "operationId": "session.delete",
  4681. "parameters": [
  4682. {
  4683. "name": "sessionID",
  4684. "in": "path",
  4685. "schema": {
  4686. "type": "string",
  4687. "pattern": "^ses"
  4688. },
  4689. "required": true
  4690. },
  4691. {
  4692. "name": "directory",
  4693. "in": "query",
  4694. "schema": {
  4695. "type": "string"
  4696. },
  4697. "required": false
  4698. },
  4699. {
  4700. "name": "workspace",
  4701. "in": "query",
  4702. "schema": {
  4703. "type": "string"
  4704. },
  4705. "required": false
  4706. }
  4707. ],
  4708. "responses": {
  4709. "200": {
  4710. "description": "Successfully deleted session",
  4711. "content": {
  4712. "application/json": {
  4713. "schema": {
  4714. "type": "boolean",
  4715. "description": "Successfully deleted session"
  4716. }
  4717. }
  4718. }
  4719. },
  4720. "400": {
  4721. "description": "Bad request",
  4722. "content": {
  4723. "application/json": {
  4724. "schema": {
  4725. "$ref": "#/components/schemas/BadRequestError"
  4726. }
  4727. }
  4728. }
  4729. },
  4730. "404": {
  4731. "description": "NotFoundError",
  4732. "content": {
  4733. "application/json": {
  4734. "schema": {
  4735. "$ref": "#/components/schemas/NotFoundError"
  4736. }
  4737. }
  4738. }
  4739. }
  4740. },
  4741. "description": "Delete a session and permanently remove all associated data, including messages and history.",
  4742. "summary": "Delete session",
  4743. "x-codeSamples": [
  4744. {
  4745. "lang": "js",
  4746. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.delete({\n ...\n})"
  4747. }
  4748. ]
  4749. },
  4750. "patch": {
  4751. "tags": ["session"],
  4752. "operationId": "session.update",
  4753. "parameters": [
  4754. {
  4755. "name": "sessionID",
  4756. "in": "path",
  4757. "schema": {
  4758. "type": "string",
  4759. "pattern": "^ses"
  4760. },
  4761. "required": true
  4762. },
  4763. {
  4764. "name": "directory",
  4765. "in": "query",
  4766. "schema": {
  4767. "type": "string"
  4768. },
  4769. "required": false
  4770. },
  4771. {
  4772. "name": "workspace",
  4773. "in": "query",
  4774. "schema": {
  4775. "type": "string"
  4776. },
  4777. "required": false
  4778. }
  4779. ],
  4780. "responses": {
  4781. "200": {
  4782. "description": "Successfully updated session",
  4783. "content": {
  4784. "application/json": {
  4785. "schema": {
  4786. "$ref": "#/components/schemas/Session"
  4787. }
  4788. }
  4789. }
  4790. },
  4791. "400": {
  4792. "description": "Bad request",
  4793. "content": {
  4794. "application/json": {
  4795. "schema": {
  4796. "$ref": "#/components/schemas/BadRequestError"
  4797. }
  4798. }
  4799. }
  4800. },
  4801. "404": {
  4802. "description": "NotFoundError",
  4803. "content": {
  4804. "application/json": {
  4805. "schema": {
  4806. "$ref": "#/components/schemas/NotFoundError"
  4807. }
  4808. }
  4809. }
  4810. }
  4811. },
  4812. "description": "Update properties of an existing session, such as title or other metadata.",
  4813. "summary": "Update session",
  4814. "requestBody": {
  4815. "content": {
  4816. "application/json": {
  4817. "schema": {
  4818. "type": "object",
  4819. "properties": {
  4820. "title": {
  4821. "type": "string"
  4822. },
  4823. "permission": {
  4824. "$ref": "#/components/schemas/PermissionRuleset"
  4825. },
  4826. "time": {
  4827. "type": "object",
  4828. "properties": {
  4829. "archived": {
  4830. "type": "number"
  4831. }
  4832. },
  4833. "additionalProperties": false
  4834. }
  4835. },
  4836. "additionalProperties": false
  4837. }
  4838. }
  4839. }
  4840. },
  4841. "x-codeSamples": [
  4842. {
  4843. "lang": "js",
  4844. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.update({\n ...\n})"
  4845. }
  4846. ]
  4847. }
  4848. },
  4849. "/session/{sessionID}/children": {
  4850. "get": {
  4851. "tags": ["session"],
  4852. "operationId": "session.children",
  4853. "parameters": [
  4854. {
  4855. "name": "sessionID",
  4856. "in": "path",
  4857. "schema": {
  4858. "type": "string",
  4859. "pattern": "^ses"
  4860. },
  4861. "required": true
  4862. },
  4863. {
  4864. "name": "directory",
  4865. "in": "query",
  4866. "schema": {
  4867. "type": "string"
  4868. },
  4869. "required": false
  4870. },
  4871. {
  4872. "name": "workspace",
  4873. "in": "query",
  4874. "schema": {
  4875. "type": "string"
  4876. },
  4877. "required": false
  4878. }
  4879. ],
  4880. "responses": {
  4881. "200": {
  4882. "description": "List of children",
  4883. "content": {
  4884. "application/json": {
  4885. "schema": {
  4886. "type": "array",
  4887. "items": {
  4888. "$ref": "#/components/schemas/Session"
  4889. },
  4890. "description": "List of children"
  4891. }
  4892. }
  4893. }
  4894. },
  4895. "400": {
  4896. "description": "Bad request",
  4897. "content": {
  4898. "application/json": {
  4899. "schema": {
  4900. "$ref": "#/components/schemas/BadRequestError"
  4901. }
  4902. }
  4903. }
  4904. },
  4905. "404": {
  4906. "description": "NotFoundError",
  4907. "content": {
  4908. "application/json": {
  4909. "schema": {
  4910. "$ref": "#/components/schemas/NotFoundError"
  4911. }
  4912. }
  4913. }
  4914. }
  4915. },
  4916. "description": "Retrieve all child sessions that were forked from the specified parent session.",
  4917. "summary": "Get session children",
  4918. "x-codeSamples": [
  4919. {
  4920. "lang": "js",
  4921. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.children({\n ...\n})"
  4922. }
  4923. ]
  4924. }
  4925. },
  4926. "/session/{sessionID}/todo": {
  4927. "get": {
  4928. "tags": ["session"],
  4929. "operationId": "session.todo",
  4930. "parameters": [
  4931. {
  4932. "name": "sessionID",
  4933. "in": "path",
  4934. "schema": {
  4935. "type": "string",
  4936. "pattern": "^ses"
  4937. },
  4938. "required": true
  4939. },
  4940. {
  4941. "name": "directory",
  4942. "in": "query",
  4943. "schema": {
  4944. "type": "string"
  4945. },
  4946. "required": false
  4947. },
  4948. {
  4949. "name": "workspace",
  4950. "in": "query",
  4951. "schema": {
  4952. "type": "string"
  4953. },
  4954. "required": false
  4955. }
  4956. ],
  4957. "responses": {
  4958. "200": {
  4959. "description": "Todo list",
  4960. "content": {
  4961. "application/json": {
  4962. "schema": {
  4963. "type": "array",
  4964. "items": {
  4965. "$ref": "#/components/schemas/Todo"
  4966. },
  4967. "description": "Todo list"
  4968. }
  4969. }
  4970. }
  4971. },
  4972. "400": {
  4973. "description": "Bad request",
  4974. "content": {
  4975. "application/json": {
  4976. "schema": {
  4977. "$ref": "#/components/schemas/BadRequestError"
  4978. }
  4979. }
  4980. }
  4981. },
  4982. "404": {
  4983. "description": "NotFoundError",
  4984. "content": {
  4985. "application/json": {
  4986. "schema": {
  4987. "$ref": "#/components/schemas/NotFoundError"
  4988. }
  4989. }
  4990. }
  4991. }
  4992. },
  4993. "description": "Retrieve the todo list associated with a specific session, showing tasks and action items.",
  4994. "summary": "Get session todos",
  4995. "x-codeSamples": [
  4996. {
  4997. "lang": "js",
  4998. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.todo({\n ...\n})"
  4999. }
  5000. ]
  5001. }
  5002. },
  5003. "/session/{sessionID}/diff": {
  5004. "get": {
  5005. "tags": ["session"],
  5006. "operationId": "session.diff",
  5007. "parameters": [
  5008. {
  5009. "name": "sessionID",
  5010. "in": "path",
  5011. "schema": {
  5012. "type": "string",
  5013. "pattern": "^ses"
  5014. },
  5015. "required": true
  5016. },
  5017. {
  5018. "name": "directory",
  5019. "in": "query",
  5020. "schema": {
  5021. "type": "string"
  5022. },
  5023. "required": false
  5024. },
  5025. {
  5026. "name": "workspace",
  5027. "in": "query",
  5028. "schema": {
  5029. "type": "string"
  5030. },
  5031. "required": false
  5032. },
  5033. {
  5034. "name": "messageID",
  5035. "in": "query",
  5036. "schema": {
  5037. "type": "string",
  5038. "pattern": "^msg"
  5039. },
  5040. "required": false
  5041. }
  5042. ],
  5043. "responses": {
  5044. "200": {
  5045. "description": "Successfully retrieved diff",
  5046. "content": {
  5047. "application/json": {
  5048. "schema": {
  5049. "type": "array",
  5050. "items": {
  5051. "$ref": "#/components/schemas/SnapshotFileDiff"
  5052. },
  5053. "description": "Successfully retrieved diff"
  5054. }
  5055. }
  5056. }
  5057. }
  5058. },
  5059. "description": "Get the file changes (diff) that resulted from a specific user message in the session.",
  5060. "summary": "Get message diff",
  5061. "x-codeSamples": [
  5062. {
  5063. "lang": "js",
  5064. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.diff({\n ...\n})"
  5065. }
  5066. ]
  5067. }
  5068. },
  5069. "/session/{sessionID}/message": {
  5070. "get": {
  5071. "tags": ["session"],
  5072. "operationId": "session.messages",
  5073. "parameters": [
  5074. {
  5075. "name": "sessionID",
  5076. "in": "path",
  5077. "schema": {
  5078. "type": "string",
  5079. "pattern": "^ses"
  5080. },
  5081. "required": true
  5082. },
  5083. {
  5084. "name": "directory",
  5085. "in": "query",
  5086. "schema": {
  5087. "type": "string"
  5088. },
  5089. "required": false
  5090. },
  5091. {
  5092. "name": "workspace",
  5093. "in": "query",
  5094. "schema": {
  5095. "type": "string"
  5096. },
  5097. "required": false
  5098. },
  5099. {
  5100. "name": "limit",
  5101. "in": "query",
  5102. "schema": {
  5103. "type": "integer",
  5104. "minimum": 0,
  5105. "maximum": 9007199254740991
  5106. },
  5107. "required": false
  5108. },
  5109. {
  5110. "name": "before",
  5111. "in": "query",
  5112. "schema": {
  5113. "type": "string"
  5114. },
  5115. "required": false
  5116. }
  5117. ],
  5118. "responses": {
  5119. "200": {
  5120. "description": "List of messages",
  5121. "content": {
  5122. "application/json": {
  5123. "schema": {
  5124. "type": "array",
  5125. "items": {
  5126. "type": "object",
  5127. "properties": {
  5128. "info": {
  5129. "$ref": "#/components/schemas/Message"
  5130. },
  5131. "parts": {
  5132. "type": "array",
  5133. "items": {
  5134. "$ref": "#/components/schemas/Part"
  5135. }
  5136. }
  5137. },
  5138. "required": ["info", "parts"],
  5139. "additionalProperties": false
  5140. },
  5141. "description": "List of messages"
  5142. }
  5143. }
  5144. }
  5145. },
  5146. "400": {
  5147. "description": "Bad request",
  5148. "content": {
  5149. "application/json": {
  5150. "schema": {
  5151. "$ref": "#/components/schemas/BadRequestError"
  5152. }
  5153. }
  5154. }
  5155. },
  5156. "404": {
  5157. "description": "NotFoundError",
  5158. "content": {
  5159. "application/json": {
  5160. "schema": {
  5161. "$ref": "#/components/schemas/NotFoundError"
  5162. }
  5163. }
  5164. }
  5165. }
  5166. },
  5167. "description": "Retrieve all messages in a session, including user prompts and AI responses.",
  5168. "summary": "Get session messages",
  5169. "x-codeSamples": [
  5170. {
  5171. "lang": "js",
  5172. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.messages({\n ...\n})"
  5173. }
  5174. ]
  5175. },
  5176. "post": {
  5177. "tags": ["session"],
  5178. "operationId": "session.prompt",
  5179. "parameters": [
  5180. {
  5181. "name": "sessionID",
  5182. "in": "path",
  5183. "schema": {
  5184. "type": "string",
  5185. "pattern": "^ses"
  5186. },
  5187. "required": true
  5188. },
  5189. {
  5190. "name": "directory",
  5191. "in": "query",
  5192. "schema": {
  5193. "type": "string"
  5194. },
  5195. "required": false
  5196. },
  5197. {
  5198. "name": "workspace",
  5199. "in": "query",
  5200. "schema": {
  5201. "type": "string"
  5202. },
  5203. "required": false
  5204. }
  5205. ],
  5206. "responses": {
  5207. "200": {
  5208. "description": "Created message",
  5209. "content": {
  5210. "application/json": {
  5211. "schema": {
  5212. "type": "object",
  5213. "required": ["info", "parts"],
  5214. "properties": {
  5215. "info": {
  5216. "$ref": "#/components/schemas/AssistantMessage"
  5217. },
  5218. "parts": {
  5219. "type": "array",
  5220. "items": {
  5221. "$ref": "#/components/schemas/Part"
  5222. }
  5223. }
  5224. }
  5225. }
  5226. }
  5227. }
  5228. },
  5229. "400": {
  5230. "description": "Bad request",
  5231. "content": {
  5232. "application/json": {
  5233. "schema": {
  5234. "$ref": "#/components/schemas/BadRequestError"
  5235. }
  5236. }
  5237. }
  5238. },
  5239. "404": {
  5240. "description": "NotFoundError",
  5241. "content": {
  5242. "application/json": {
  5243. "schema": {
  5244. "$ref": "#/components/schemas/NotFoundError"
  5245. }
  5246. }
  5247. }
  5248. }
  5249. },
  5250. "description": "Create and send a new message to a session, streaming the AI response.",
  5251. "summary": "Send message",
  5252. "requestBody": {
  5253. "content": {
  5254. "application/json": {
  5255. "schema": {
  5256. "type": "object",
  5257. "properties": {
  5258. "messageID": {
  5259. "type": "string",
  5260. "pattern": "^msg"
  5261. },
  5262. "model": {
  5263. "type": "object",
  5264. "properties": {
  5265. "providerID": {
  5266. "type": "string"
  5267. },
  5268. "modelID": {
  5269. "type": "string"
  5270. }
  5271. },
  5272. "required": ["providerID", "modelID"],
  5273. "additionalProperties": false
  5274. },
  5275. "agent": {
  5276. "type": "string"
  5277. },
  5278. "noReply": {
  5279. "type": "boolean"
  5280. },
  5281. "tools": {
  5282. "type": "object",
  5283. "additionalProperties": {
  5284. "type": "boolean"
  5285. }
  5286. },
  5287. "format": {
  5288. "$ref": "#/components/schemas/OutputFormat"
  5289. },
  5290. "system": {
  5291. "type": "string"
  5292. },
  5293. "variant": {
  5294. "type": "string"
  5295. },
  5296. "parts": {
  5297. "type": "array",
  5298. "items": {
  5299. "anyOf": [
  5300. {
  5301. "$ref": "#/components/schemas/TextPartInput"
  5302. },
  5303. {
  5304. "$ref": "#/components/schemas/FilePartInput"
  5305. },
  5306. {
  5307. "$ref": "#/components/schemas/AgentPartInput"
  5308. },
  5309. {
  5310. "$ref": "#/components/schemas/SubtaskPartInput"
  5311. }
  5312. ]
  5313. }
  5314. }
  5315. },
  5316. "required": ["parts"],
  5317. "additionalProperties": false
  5318. }
  5319. }
  5320. }
  5321. },
  5322. "x-codeSamples": [
  5323. {
  5324. "lang": "js",
  5325. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.prompt({\n ...\n})"
  5326. }
  5327. ]
  5328. }
  5329. },
  5330. "/session/{sessionID}/message/{messageID}": {
  5331. "get": {
  5332. "tags": ["session"],
  5333. "operationId": "session.message",
  5334. "parameters": [
  5335. {
  5336. "name": "sessionID",
  5337. "in": "path",
  5338. "schema": {
  5339. "type": "string",
  5340. "pattern": "^ses"
  5341. },
  5342. "required": true
  5343. },
  5344. {
  5345. "name": "messageID",
  5346. "in": "path",
  5347. "schema": {
  5348. "type": "string",
  5349. "pattern": "^msg"
  5350. },
  5351. "required": true
  5352. },
  5353. {
  5354. "name": "directory",
  5355. "in": "query",
  5356. "schema": {
  5357. "type": "string"
  5358. },
  5359. "required": false
  5360. },
  5361. {
  5362. "name": "workspace",
  5363. "in": "query",
  5364. "schema": {
  5365. "type": "string"
  5366. },
  5367. "required": false
  5368. }
  5369. ],
  5370. "responses": {
  5371. "200": {
  5372. "description": "Message",
  5373. "content": {
  5374. "application/json": {
  5375. "schema": {
  5376. "type": "object",
  5377. "properties": {
  5378. "info": {
  5379. "$ref": "#/components/schemas/Message"
  5380. },
  5381. "parts": {
  5382. "type": "array",
  5383. "items": {
  5384. "$ref": "#/components/schemas/Part"
  5385. }
  5386. }
  5387. },
  5388. "required": ["info", "parts"],
  5389. "additionalProperties": false,
  5390. "description": "Message"
  5391. }
  5392. }
  5393. }
  5394. },
  5395. "400": {
  5396. "description": "Bad request",
  5397. "content": {
  5398. "application/json": {
  5399. "schema": {
  5400. "$ref": "#/components/schemas/BadRequestError"
  5401. }
  5402. }
  5403. }
  5404. },
  5405. "404": {
  5406. "description": "NotFoundError",
  5407. "content": {
  5408. "application/json": {
  5409. "schema": {
  5410. "$ref": "#/components/schemas/NotFoundError"
  5411. }
  5412. }
  5413. }
  5414. }
  5415. },
  5416. "description": "Retrieve a specific message from a session by its message ID.",
  5417. "summary": "Get message",
  5418. "x-codeSamples": [
  5419. {
  5420. "lang": "js",
  5421. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.message({\n ...\n})"
  5422. }
  5423. ]
  5424. },
  5425. "delete": {
  5426. "tags": ["session"],
  5427. "operationId": "session.deleteMessage",
  5428. "parameters": [
  5429. {
  5430. "name": "sessionID",
  5431. "in": "path",
  5432. "schema": {
  5433. "type": "string",
  5434. "pattern": "^ses"
  5435. },
  5436. "required": true
  5437. },
  5438. {
  5439. "name": "messageID",
  5440. "in": "path",
  5441. "schema": {
  5442. "type": "string",
  5443. "pattern": "^msg"
  5444. },
  5445. "required": true
  5446. },
  5447. {
  5448. "name": "directory",
  5449. "in": "query",
  5450. "schema": {
  5451. "type": "string"
  5452. },
  5453. "required": false
  5454. },
  5455. {
  5456. "name": "workspace",
  5457. "in": "query",
  5458. "schema": {
  5459. "type": "string"
  5460. },
  5461. "required": false
  5462. }
  5463. ],
  5464. "responses": {
  5465. "200": {
  5466. "description": "Successfully deleted message",
  5467. "content": {
  5468. "application/json": {
  5469. "schema": {
  5470. "type": "boolean",
  5471. "description": "Successfully deleted message"
  5472. }
  5473. }
  5474. }
  5475. },
  5476. "400": {
  5477. "description": "Bad request",
  5478. "content": {
  5479. "application/json": {
  5480. "schema": {
  5481. "$ref": "#/components/schemas/BadRequestError"
  5482. }
  5483. }
  5484. }
  5485. },
  5486. "404": {
  5487. "description": "NotFoundError",
  5488. "content": {
  5489. "application/json": {
  5490. "schema": {
  5491. "$ref": "#/components/schemas/NotFoundError"
  5492. }
  5493. }
  5494. }
  5495. }
  5496. },
  5497. "description": "Permanently delete a specific message and all of its parts from a session without reverting file changes.",
  5498. "summary": "Delete message",
  5499. "x-codeSamples": [
  5500. {
  5501. "lang": "js",
  5502. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.deleteMessage({\n ...\n})"
  5503. }
  5504. ]
  5505. }
  5506. },
  5507. "/session/{sessionID}/fork": {
  5508. "post": {
  5509. "tags": ["session"],
  5510. "operationId": "session.fork",
  5511. "parameters": [
  5512. {
  5513. "name": "sessionID",
  5514. "in": "path",
  5515. "schema": {
  5516. "type": "string",
  5517. "pattern": "^ses"
  5518. },
  5519. "required": true
  5520. },
  5521. {
  5522. "name": "directory",
  5523. "in": "query",
  5524. "schema": {
  5525. "type": "string"
  5526. },
  5527. "required": false
  5528. },
  5529. {
  5530. "name": "workspace",
  5531. "in": "query",
  5532. "schema": {
  5533. "type": "string"
  5534. },
  5535. "required": false
  5536. }
  5537. ],
  5538. "responses": {
  5539. "200": {
  5540. "description": "200",
  5541. "content": {
  5542. "application/json": {
  5543. "schema": {
  5544. "$ref": "#/components/schemas/Session"
  5545. }
  5546. }
  5547. }
  5548. },
  5549. "400": {
  5550. "description": "Bad request",
  5551. "content": {
  5552. "application/json": {
  5553. "schema": {
  5554. "$ref": "#/components/schemas/BadRequestError"
  5555. }
  5556. }
  5557. }
  5558. },
  5559. "404": {
  5560. "description": "NotFoundError",
  5561. "content": {
  5562. "application/json": {
  5563. "schema": {
  5564. "$ref": "#/components/schemas/NotFoundError"
  5565. }
  5566. }
  5567. }
  5568. }
  5569. },
  5570. "description": "Create a new session by forking an existing session at a specific message point.",
  5571. "summary": "Fork session",
  5572. "requestBody": {
  5573. "content": {
  5574. "application/json": {
  5575. "schema": {
  5576. "type": "object",
  5577. "properties": {
  5578. "messageID": {
  5579. "type": "string",
  5580. "pattern": "^msg"
  5581. }
  5582. },
  5583. "additionalProperties": false
  5584. }
  5585. }
  5586. }
  5587. },
  5588. "x-codeSamples": [
  5589. {
  5590. "lang": "js",
  5591. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.fork({\n ...\n})"
  5592. }
  5593. ]
  5594. }
  5595. },
  5596. "/session/{sessionID}/abort": {
  5597. "post": {
  5598. "tags": ["session"],
  5599. "operationId": "session.abort",
  5600. "parameters": [
  5601. {
  5602. "name": "sessionID",
  5603. "in": "path",
  5604. "schema": {
  5605. "type": "string",
  5606. "pattern": "^ses"
  5607. },
  5608. "required": true
  5609. },
  5610. {
  5611. "name": "directory",
  5612. "in": "query",
  5613. "schema": {
  5614. "type": "string"
  5615. },
  5616. "required": false
  5617. },
  5618. {
  5619. "name": "workspace",
  5620. "in": "query",
  5621. "schema": {
  5622. "type": "string"
  5623. },
  5624. "required": false
  5625. }
  5626. ],
  5627. "responses": {
  5628. "200": {
  5629. "description": "Aborted session",
  5630. "content": {
  5631. "application/json": {
  5632. "schema": {
  5633. "type": "boolean",
  5634. "description": "Aborted session"
  5635. }
  5636. }
  5637. }
  5638. },
  5639. "400": {
  5640. "description": "Bad request",
  5641. "content": {
  5642. "application/json": {
  5643. "schema": {
  5644. "$ref": "#/components/schemas/BadRequestError"
  5645. }
  5646. }
  5647. }
  5648. }
  5649. },
  5650. "description": "Abort an active session and stop any ongoing AI processing or command execution.",
  5651. "summary": "Abort session",
  5652. "x-codeSamples": [
  5653. {
  5654. "lang": "js",
  5655. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.abort({\n ...\n})"
  5656. }
  5657. ]
  5658. }
  5659. },
  5660. "/session/{sessionID}/init": {
  5661. "post": {
  5662. "tags": ["session"],
  5663. "operationId": "session.init",
  5664. "parameters": [
  5665. {
  5666. "name": "sessionID",
  5667. "in": "path",
  5668. "schema": {
  5669. "type": "string",
  5670. "pattern": "^ses"
  5671. },
  5672. "required": true
  5673. },
  5674. {
  5675. "name": "directory",
  5676. "in": "query",
  5677. "schema": {
  5678. "type": "string"
  5679. },
  5680. "required": false
  5681. },
  5682. {
  5683. "name": "workspace",
  5684. "in": "query",
  5685. "schema": {
  5686. "type": "string"
  5687. },
  5688. "required": false
  5689. }
  5690. ],
  5691. "responses": {
  5692. "200": {
  5693. "description": "200",
  5694. "content": {
  5695. "application/json": {
  5696. "schema": {
  5697. "type": "boolean",
  5698. "description": "200"
  5699. }
  5700. }
  5701. }
  5702. },
  5703. "400": {
  5704. "description": "Bad request",
  5705. "content": {
  5706. "application/json": {
  5707. "schema": {
  5708. "$ref": "#/components/schemas/BadRequestError"
  5709. }
  5710. }
  5711. }
  5712. },
  5713. "404": {
  5714. "description": "NotFoundError",
  5715. "content": {
  5716. "application/json": {
  5717. "schema": {
  5718. "$ref": "#/components/schemas/NotFoundError"
  5719. }
  5720. }
  5721. }
  5722. }
  5723. },
  5724. "description": "Analyze the current application and create an AGENTS.md file with project-specific agent configurations.",
  5725. "summary": "Initialize session",
  5726. "requestBody": {
  5727. "content": {
  5728. "application/json": {
  5729. "schema": {
  5730. "type": "object",
  5731. "properties": {
  5732. "modelID": {
  5733. "type": "string"
  5734. },
  5735. "providerID": {
  5736. "type": "string"
  5737. },
  5738. "messageID": {
  5739. "type": "string",
  5740. "pattern": "^msg"
  5741. }
  5742. },
  5743. "required": ["modelID", "providerID", "messageID"],
  5744. "additionalProperties": false
  5745. }
  5746. }
  5747. }
  5748. },
  5749. "x-codeSamples": [
  5750. {
  5751. "lang": "js",
  5752. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.init({\n ...\n})"
  5753. }
  5754. ]
  5755. }
  5756. },
  5757. "/session/{sessionID}/share": {
  5758. "post": {
  5759. "tags": ["session"],
  5760. "operationId": "session.share",
  5761. "parameters": [
  5762. {
  5763. "name": "sessionID",
  5764. "in": "path",
  5765. "schema": {
  5766. "type": "string",
  5767. "pattern": "^ses"
  5768. },
  5769. "required": true
  5770. },
  5771. {
  5772. "name": "directory",
  5773. "in": "query",
  5774. "schema": {
  5775. "type": "string"
  5776. },
  5777. "required": false
  5778. },
  5779. {
  5780. "name": "workspace",
  5781. "in": "query",
  5782. "schema": {
  5783. "type": "string"
  5784. },
  5785. "required": false
  5786. }
  5787. ],
  5788. "responses": {
  5789. "200": {
  5790. "description": "Successfully shared session",
  5791. "content": {
  5792. "application/json": {
  5793. "schema": {
  5794. "$ref": "#/components/schemas/Session"
  5795. }
  5796. }
  5797. }
  5798. },
  5799. "404": {
  5800. "description": "NotFoundError",
  5801. "content": {
  5802. "application/json": {
  5803. "schema": {
  5804. "$ref": "#/components/schemas/NotFoundError"
  5805. }
  5806. }
  5807. }
  5808. },
  5809. "500": {
  5810. "description": "InternalServerError",
  5811. "content": {
  5812. "application/json": {
  5813. "schema": {
  5814. "$ref": "#/components/schemas/effect_HttpApiError_InternalServerError"
  5815. }
  5816. }
  5817. }
  5818. }
  5819. },
  5820. "description": "Create a shareable link for a session, allowing others to view the conversation.",
  5821. "summary": "Share session",
  5822. "x-codeSamples": [
  5823. {
  5824. "lang": "js",
  5825. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.share({\n ...\n})"
  5826. }
  5827. ]
  5828. },
  5829. "delete": {
  5830. "tags": ["session"],
  5831. "operationId": "session.unshare",
  5832. "parameters": [
  5833. {
  5834. "name": "sessionID",
  5835. "in": "path",
  5836. "schema": {
  5837. "type": "string",
  5838. "pattern": "^ses"
  5839. },
  5840. "required": true
  5841. },
  5842. {
  5843. "name": "directory",
  5844. "in": "query",
  5845. "schema": {
  5846. "type": "string"
  5847. },
  5848. "required": false
  5849. },
  5850. {
  5851. "name": "workspace",
  5852. "in": "query",
  5853. "schema": {
  5854. "type": "string"
  5855. },
  5856. "required": false
  5857. }
  5858. ],
  5859. "responses": {
  5860. "200": {
  5861. "description": "Successfully unshared session",
  5862. "content": {
  5863. "application/json": {
  5864. "schema": {
  5865. "$ref": "#/components/schemas/Session"
  5866. }
  5867. }
  5868. }
  5869. },
  5870. "404": {
  5871. "description": "NotFoundError",
  5872. "content": {
  5873. "application/json": {
  5874. "schema": {
  5875. "$ref": "#/components/schemas/NotFoundError"
  5876. }
  5877. }
  5878. }
  5879. },
  5880. "500": {
  5881. "description": "InternalServerError",
  5882. "content": {
  5883. "application/json": {
  5884. "schema": {
  5885. "$ref": "#/components/schemas/effect_HttpApiError_InternalServerError"
  5886. }
  5887. }
  5888. }
  5889. }
  5890. },
  5891. "description": "Remove the shareable link for a session, making it private again.",
  5892. "summary": "Unshare session",
  5893. "x-codeSamples": [
  5894. {
  5895. "lang": "js",
  5896. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.unshare({\n ...\n})"
  5897. }
  5898. ]
  5899. }
  5900. },
  5901. "/session/{sessionID}/summarize": {
  5902. "post": {
  5903. "tags": ["session"],
  5904. "operationId": "session.summarize",
  5905. "parameters": [
  5906. {
  5907. "name": "sessionID",
  5908. "in": "path",
  5909. "schema": {
  5910. "type": "string",
  5911. "pattern": "^ses"
  5912. },
  5913. "required": true
  5914. },
  5915. {
  5916. "name": "directory",
  5917. "in": "query",
  5918. "schema": {
  5919. "type": "string"
  5920. },
  5921. "required": false
  5922. },
  5923. {
  5924. "name": "workspace",
  5925. "in": "query",
  5926. "schema": {
  5927. "type": "string"
  5928. },
  5929. "required": false
  5930. }
  5931. ],
  5932. "responses": {
  5933. "200": {
  5934. "description": "Summarized session",
  5935. "content": {
  5936. "application/json": {
  5937. "schema": {
  5938. "type": "boolean",
  5939. "description": "Summarized session"
  5940. }
  5941. }
  5942. }
  5943. },
  5944. "400": {
  5945. "description": "Bad request",
  5946. "content": {
  5947. "application/json": {
  5948. "schema": {
  5949. "$ref": "#/components/schemas/BadRequestError"
  5950. }
  5951. }
  5952. }
  5953. },
  5954. "404": {
  5955. "description": "NotFoundError",
  5956. "content": {
  5957. "application/json": {
  5958. "schema": {
  5959. "$ref": "#/components/schemas/NotFoundError"
  5960. }
  5961. }
  5962. }
  5963. }
  5964. },
  5965. "description": "Generate a concise summary of the session using AI compaction to preserve key information.",
  5966. "summary": "Summarize session",
  5967. "requestBody": {
  5968. "content": {
  5969. "application/json": {
  5970. "schema": {
  5971. "type": "object",
  5972. "properties": {
  5973. "providerID": {
  5974. "type": "string"
  5975. },
  5976. "modelID": {
  5977. "type": "string"
  5978. },
  5979. "auto": {
  5980. "type": "boolean"
  5981. }
  5982. },
  5983. "required": ["providerID", "modelID"],
  5984. "additionalProperties": false
  5985. }
  5986. }
  5987. }
  5988. },
  5989. "x-codeSamples": [
  5990. {
  5991. "lang": "js",
  5992. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.summarize({\n ...\n})"
  5993. }
  5994. ]
  5995. }
  5996. },
  5997. "/session/{sessionID}/prompt_async": {
  5998. "post": {
  5999. "tags": ["session"],
  6000. "operationId": "session.prompt_async",
  6001. "parameters": [
  6002. {
  6003. "name": "sessionID",
  6004. "in": "path",
  6005. "schema": {
  6006. "type": "string",
  6007. "pattern": "^ses"
  6008. },
  6009. "required": true
  6010. },
  6011. {
  6012. "name": "directory",
  6013. "in": "query",
  6014. "schema": {
  6015. "type": "string"
  6016. },
  6017. "required": false
  6018. },
  6019. {
  6020. "name": "workspace",
  6021. "in": "query",
  6022. "schema": {
  6023. "type": "string"
  6024. },
  6025. "required": false
  6026. }
  6027. ],
  6028. "responses": {
  6029. "204": {
  6030. "description": "Prompt accepted"
  6031. },
  6032. "400": {
  6033. "description": "Bad request",
  6034. "content": {
  6035. "application/json": {
  6036. "schema": {
  6037. "$ref": "#/components/schemas/BadRequestError"
  6038. }
  6039. }
  6040. }
  6041. },
  6042. "404": {
  6043. "description": "NotFoundError",
  6044. "content": {
  6045. "application/json": {
  6046. "schema": {
  6047. "$ref": "#/components/schemas/NotFoundError"
  6048. }
  6049. }
  6050. }
  6051. }
  6052. },
  6053. "description": "Create and send a new message to a session asynchronously, starting the session if needed and returning immediately.",
  6054. "summary": "Send async message",
  6055. "requestBody": {
  6056. "content": {
  6057. "application/json": {
  6058. "schema": {
  6059. "type": "object",
  6060. "properties": {
  6061. "messageID": {
  6062. "type": "string",
  6063. "pattern": "^msg"
  6064. },
  6065. "model": {
  6066. "type": "object",
  6067. "properties": {
  6068. "providerID": {
  6069. "type": "string"
  6070. },
  6071. "modelID": {
  6072. "type": "string"
  6073. }
  6074. },
  6075. "required": ["providerID", "modelID"],
  6076. "additionalProperties": false
  6077. },
  6078. "agent": {
  6079. "type": "string"
  6080. },
  6081. "noReply": {
  6082. "type": "boolean"
  6083. },
  6084. "tools": {
  6085. "type": "object",
  6086. "additionalProperties": {
  6087. "type": "boolean"
  6088. }
  6089. },
  6090. "format": {
  6091. "$ref": "#/components/schemas/OutputFormat"
  6092. },
  6093. "system": {
  6094. "type": "string"
  6095. },
  6096. "variant": {
  6097. "type": "string"
  6098. },
  6099. "parts": {
  6100. "type": "array",
  6101. "items": {
  6102. "anyOf": [
  6103. {
  6104. "$ref": "#/components/schemas/TextPartInput"
  6105. },
  6106. {
  6107. "$ref": "#/components/schemas/FilePartInput"
  6108. },
  6109. {
  6110. "$ref": "#/components/schemas/AgentPartInput"
  6111. },
  6112. {
  6113. "$ref": "#/components/schemas/SubtaskPartInput"
  6114. }
  6115. ]
  6116. }
  6117. }
  6118. },
  6119. "required": ["parts"],
  6120. "additionalProperties": false
  6121. }
  6122. }
  6123. }
  6124. },
  6125. "x-codeSamples": [
  6126. {
  6127. "lang": "js",
  6128. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.prompt_async({\n ...\n})"
  6129. }
  6130. ]
  6131. }
  6132. },
  6133. "/session/{sessionID}/command": {
  6134. "post": {
  6135. "tags": ["session"],
  6136. "operationId": "session.command",
  6137. "parameters": [
  6138. {
  6139. "name": "sessionID",
  6140. "in": "path",
  6141. "schema": {
  6142. "type": "string",
  6143. "pattern": "^ses"
  6144. },
  6145. "required": true
  6146. },
  6147. {
  6148. "name": "directory",
  6149. "in": "query",
  6150. "schema": {
  6151. "type": "string"
  6152. },
  6153. "required": false
  6154. },
  6155. {
  6156. "name": "workspace",
  6157. "in": "query",
  6158. "schema": {
  6159. "type": "string"
  6160. },
  6161. "required": false
  6162. }
  6163. ],
  6164. "responses": {
  6165. "200": {
  6166. "description": "Created message",
  6167. "content": {
  6168. "application/json": {
  6169. "schema": {
  6170. "type": "object",
  6171. "required": ["info", "parts"],
  6172. "properties": {
  6173. "info": {
  6174. "$ref": "#/components/schemas/AssistantMessage"
  6175. },
  6176. "parts": {
  6177. "type": "array",
  6178. "items": {
  6179. "$ref": "#/components/schemas/Part"
  6180. }
  6181. }
  6182. }
  6183. }
  6184. }
  6185. }
  6186. },
  6187. "400": {
  6188. "description": "Bad request",
  6189. "content": {
  6190. "application/json": {
  6191. "schema": {
  6192. "$ref": "#/components/schemas/BadRequestError"
  6193. }
  6194. }
  6195. }
  6196. },
  6197. "404": {
  6198. "description": "NotFoundError",
  6199. "content": {
  6200. "application/json": {
  6201. "schema": {
  6202. "$ref": "#/components/schemas/NotFoundError"
  6203. }
  6204. }
  6205. }
  6206. }
  6207. },
  6208. "description": "Send a new command to a session for execution by the AI assistant.",
  6209. "summary": "Send command",
  6210. "requestBody": {
  6211. "content": {
  6212. "application/json": {
  6213. "schema": {
  6214. "type": "object",
  6215. "properties": {
  6216. "messageID": {
  6217. "type": "string",
  6218. "pattern": "^msg"
  6219. },
  6220. "agent": {
  6221. "type": "string"
  6222. },
  6223. "model": {
  6224. "type": "string"
  6225. },
  6226. "arguments": {
  6227. "type": "string"
  6228. },
  6229. "command": {
  6230. "type": "string"
  6231. },
  6232. "variant": {
  6233. "type": "string"
  6234. },
  6235. "parts": {
  6236. "type": "array",
  6237. "items": {
  6238. "type": "object",
  6239. "properties": {
  6240. "id": {
  6241. "type": "string",
  6242. "pattern": "^prt"
  6243. },
  6244. "type": {
  6245. "type": "string",
  6246. "enum": ["file"]
  6247. },
  6248. "mime": {
  6249. "type": "string"
  6250. },
  6251. "filename": {
  6252. "type": "string"
  6253. },
  6254. "url": {
  6255. "type": "string"
  6256. },
  6257. "source": {
  6258. "$ref": "#/components/schemas/FilePartSource"
  6259. }
  6260. },
  6261. "required": ["type", "mime", "url"],
  6262. "additionalProperties": false
  6263. }
  6264. }
  6265. },
  6266. "required": ["arguments", "command"],
  6267. "additionalProperties": false
  6268. }
  6269. }
  6270. }
  6271. },
  6272. "x-codeSamples": [
  6273. {
  6274. "lang": "js",
  6275. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.command({\n ...\n})"
  6276. }
  6277. ]
  6278. }
  6279. },
  6280. "/session/{sessionID}/shell": {
  6281. "post": {
  6282. "tags": ["session"],
  6283. "operationId": "session.shell",
  6284. "parameters": [
  6285. {
  6286. "name": "sessionID",
  6287. "in": "path",
  6288. "schema": {
  6289. "type": "string",
  6290. "pattern": "^ses"
  6291. },
  6292. "required": true
  6293. },
  6294. {
  6295. "name": "directory",
  6296. "in": "query",
  6297. "schema": {
  6298. "type": "string"
  6299. },
  6300. "required": false
  6301. },
  6302. {
  6303. "name": "workspace",
  6304. "in": "query",
  6305. "schema": {
  6306. "type": "string"
  6307. },
  6308. "required": false
  6309. }
  6310. ],
  6311. "responses": {
  6312. "200": {
  6313. "description": "Created message",
  6314. "content": {
  6315. "application/json": {
  6316. "schema": {
  6317. "type": "object",
  6318. "properties": {
  6319. "info": {
  6320. "$ref": "#/components/schemas/Message"
  6321. },
  6322. "parts": {
  6323. "type": "array",
  6324. "items": {
  6325. "$ref": "#/components/schemas/Part"
  6326. }
  6327. }
  6328. },
  6329. "required": ["info", "parts"],
  6330. "additionalProperties": false,
  6331. "description": "Created message"
  6332. }
  6333. }
  6334. }
  6335. },
  6336. "400": {
  6337. "description": "Bad request",
  6338. "content": {
  6339. "application/json": {
  6340. "schema": {
  6341. "$ref": "#/components/schemas/BadRequestError"
  6342. }
  6343. }
  6344. }
  6345. },
  6346. "404": {
  6347. "description": "NotFoundError",
  6348. "content": {
  6349. "application/json": {
  6350. "schema": {
  6351. "$ref": "#/components/schemas/NotFoundError"
  6352. }
  6353. }
  6354. }
  6355. }
  6356. },
  6357. "description": "Execute a shell command within the session context and return the AI's response.",
  6358. "summary": "Run shell command",
  6359. "requestBody": {
  6360. "content": {
  6361. "application/json": {
  6362. "schema": {
  6363. "type": "object",
  6364. "properties": {
  6365. "messageID": {
  6366. "type": "string",
  6367. "pattern": "^msg"
  6368. },
  6369. "agent": {
  6370. "type": "string"
  6371. },
  6372. "model": {
  6373. "type": "object",
  6374. "properties": {
  6375. "providerID": {
  6376. "type": "string"
  6377. },
  6378. "modelID": {
  6379. "type": "string"
  6380. }
  6381. },
  6382. "required": ["providerID", "modelID"],
  6383. "additionalProperties": false
  6384. },
  6385. "command": {
  6386. "type": "string"
  6387. }
  6388. },
  6389. "required": ["agent", "command"],
  6390. "additionalProperties": false
  6391. }
  6392. }
  6393. }
  6394. },
  6395. "x-codeSamples": [
  6396. {
  6397. "lang": "js",
  6398. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.shell({\n ...\n})"
  6399. }
  6400. ]
  6401. }
  6402. },
  6403. "/session/{sessionID}/revert": {
  6404. "post": {
  6405. "tags": ["session"],
  6406. "operationId": "session.revert",
  6407. "parameters": [
  6408. {
  6409. "name": "sessionID",
  6410. "in": "path",
  6411. "schema": {
  6412. "type": "string",
  6413. "pattern": "^ses"
  6414. },
  6415. "required": true
  6416. },
  6417. {
  6418. "name": "directory",
  6419. "in": "query",
  6420. "schema": {
  6421. "type": "string"
  6422. },
  6423. "required": false
  6424. },
  6425. {
  6426. "name": "workspace",
  6427. "in": "query",
  6428. "schema": {
  6429. "type": "string"
  6430. },
  6431. "required": false
  6432. }
  6433. ],
  6434. "responses": {
  6435. "200": {
  6436. "description": "Updated session",
  6437. "content": {
  6438. "application/json": {
  6439. "schema": {
  6440. "$ref": "#/components/schemas/Session"
  6441. }
  6442. }
  6443. }
  6444. },
  6445. "400": {
  6446. "description": "Bad request",
  6447. "content": {
  6448. "application/json": {
  6449. "schema": {
  6450. "$ref": "#/components/schemas/BadRequestError"
  6451. }
  6452. }
  6453. }
  6454. },
  6455. "404": {
  6456. "description": "NotFoundError",
  6457. "content": {
  6458. "application/json": {
  6459. "schema": {
  6460. "$ref": "#/components/schemas/NotFoundError"
  6461. }
  6462. }
  6463. }
  6464. }
  6465. },
  6466. "description": "Revert a specific message in a session, undoing its effects and restoring the previous state.",
  6467. "summary": "Revert message",
  6468. "requestBody": {
  6469. "content": {
  6470. "application/json": {
  6471. "schema": {
  6472. "type": "object",
  6473. "properties": {
  6474. "messageID": {
  6475. "type": "string",
  6476. "pattern": "^msg"
  6477. },
  6478. "partID": {
  6479. "type": "string",
  6480. "pattern": "^prt"
  6481. }
  6482. },
  6483. "required": ["messageID"],
  6484. "additionalProperties": false
  6485. }
  6486. }
  6487. }
  6488. },
  6489. "x-codeSamples": [
  6490. {
  6491. "lang": "js",
  6492. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.revert({\n ...\n})"
  6493. }
  6494. ]
  6495. }
  6496. },
  6497. "/session/{sessionID}/unrevert": {
  6498. "post": {
  6499. "tags": ["session"],
  6500. "operationId": "session.unrevert",
  6501. "parameters": [
  6502. {
  6503. "name": "sessionID",
  6504. "in": "path",
  6505. "schema": {
  6506. "type": "string",
  6507. "pattern": "^ses"
  6508. },
  6509. "required": true
  6510. },
  6511. {
  6512. "name": "directory",
  6513. "in": "query",
  6514. "schema": {
  6515. "type": "string"
  6516. },
  6517. "required": false
  6518. },
  6519. {
  6520. "name": "workspace",
  6521. "in": "query",
  6522. "schema": {
  6523. "type": "string"
  6524. },
  6525. "required": false
  6526. }
  6527. ],
  6528. "responses": {
  6529. "200": {
  6530. "description": "Updated session",
  6531. "content": {
  6532. "application/json": {
  6533. "schema": {
  6534. "$ref": "#/components/schemas/Session"
  6535. }
  6536. }
  6537. }
  6538. },
  6539. "400": {
  6540. "description": "Bad request",
  6541. "content": {
  6542. "application/json": {
  6543. "schema": {
  6544. "$ref": "#/components/schemas/BadRequestError"
  6545. }
  6546. }
  6547. }
  6548. },
  6549. "404": {
  6550. "description": "NotFoundError",
  6551. "content": {
  6552. "application/json": {
  6553. "schema": {
  6554. "$ref": "#/components/schemas/NotFoundError"
  6555. }
  6556. }
  6557. }
  6558. }
  6559. },
  6560. "description": "Restore all previously reverted messages in a session.",
  6561. "summary": "Restore reverted messages",
  6562. "x-codeSamples": [
  6563. {
  6564. "lang": "js",
  6565. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.unrevert({\n ...\n})"
  6566. }
  6567. ]
  6568. }
  6569. },
  6570. "/session/{sessionID}/permissions/{permissionID}": {
  6571. "post": {
  6572. "tags": ["session"],
  6573. "operationId": "permission.respond",
  6574. "parameters": [
  6575. {
  6576. "name": "sessionID",
  6577. "in": "path",
  6578. "schema": {
  6579. "type": "string",
  6580. "pattern": "^ses"
  6581. },
  6582. "required": true
  6583. },
  6584. {
  6585. "name": "permissionID",
  6586. "in": "path",
  6587. "schema": {
  6588. "type": "string",
  6589. "pattern": "^per"
  6590. },
  6591. "required": true
  6592. },
  6593. {
  6594. "name": "directory",
  6595. "in": "query",
  6596. "schema": {
  6597. "type": "string"
  6598. },
  6599. "required": false
  6600. },
  6601. {
  6602. "name": "workspace",
  6603. "in": "query",
  6604. "schema": {
  6605. "type": "string"
  6606. },
  6607. "required": false
  6608. }
  6609. ],
  6610. "responses": {
  6611. "200": {
  6612. "description": "Permission processed successfully",
  6613. "content": {
  6614. "application/json": {
  6615. "schema": {
  6616. "type": "boolean",
  6617. "description": "Permission processed successfully"
  6618. }
  6619. }
  6620. }
  6621. },
  6622. "400": {
  6623. "description": "Bad request",
  6624. "content": {
  6625. "application/json": {
  6626. "schema": {
  6627. "$ref": "#/components/schemas/BadRequestError"
  6628. }
  6629. }
  6630. }
  6631. },
  6632. "404": {
  6633. "description": "NotFoundError",
  6634. "content": {
  6635. "application/json": {
  6636. "schema": {
  6637. "$ref": "#/components/schemas/NotFoundError"
  6638. }
  6639. }
  6640. }
  6641. }
  6642. },
  6643. "description": "Approve or deny a permission request from the AI assistant.",
  6644. "summary": "Respond to permission",
  6645. "deprecated": true,
  6646. "requestBody": {
  6647. "content": {
  6648. "application/json": {
  6649. "schema": {
  6650. "type": "object",
  6651. "properties": {
  6652. "response": {
  6653. "type": "string",
  6654. "enum": ["once", "always", "reject"]
  6655. }
  6656. },
  6657. "required": ["response"],
  6658. "additionalProperties": false
  6659. }
  6660. }
  6661. }
  6662. },
  6663. "x-codeSamples": [
  6664. {
  6665. "lang": "js",
  6666. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.permission.respond({\n ...\n})"
  6667. }
  6668. ]
  6669. }
  6670. },
  6671. "/session/{sessionID}/message/{messageID}/part/{partID}": {
  6672. "delete": {
  6673. "tags": ["session"],
  6674. "operationId": "part.delete",
  6675. "parameters": [
  6676. {
  6677. "name": "sessionID",
  6678. "in": "path",
  6679. "schema": {
  6680. "type": "string",
  6681. "pattern": "^ses"
  6682. },
  6683. "required": true
  6684. },
  6685. {
  6686. "name": "messageID",
  6687. "in": "path",
  6688. "schema": {
  6689. "type": "string",
  6690. "pattern": "^msg"
  6691. },
  6692. "required": true
  6693. },
  6694. {
  6695. "name": "partID",
  6696. "in": "path",
  6697. "schema": {
  6698. "type": "string",
  6699. "pattern": "^prt"
  6700. },
  6701. "required": true
  6702. },
  6703. {
  6704. "name": "directory",
  6705. "in": "query",
  6706. "schema": {
  6707. "type": "string"
  6708. },
  6709. "required": false
  6710. },
  6711. {
  6712. "name": "workspace",
  6713. "in": "query",
  6714. "schema": {
  6715. "type": "string"
  6716. },
  6717. "required": false
  6718. }
  6719. ],
  6720. "responses": {
  6721. "200": {
  6722. "description": "Successfully deleted part",
  6723. "content": {
  6724. "application/json": {
  6725. "schema": {
  6726. "type": "boolean",
  6727. "description": "Successfully deleted part"
  6728. }
  6729. }
  6730. }
  6731. },
  6732. "400": {
  6733. "description": "Bad request",
  6734. "content": {
  6735. "application/json": {
  6736. "schema": {
  6737. "$ref": "#/components/schemas/BadRequestError"
  6738. }
  6739. }
  6740. }
  6741. },
  6742. "404": {
  6743. "description": "NotFoundError",
  6744. "content": {
  6745. "application/json": {
  6746. "schema": {
  6747. "$ref": "#/components/schemas/NotFoundError"
  6748. }
  6749. }
  6750. }
  6751. }
  6752. },
  6753. "description": "Delete a part from a message.",
  6754. "x-codeSamples": [
  6755. {
  6756. "lang": "js",
  6757. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.part.delete({\n ...\n})"
  6758. }
  6759. ]
  6760. },
  6761. "patch": {
  6762. "tags": ["session"],
  6763. "operationId": "part.update",
  6764. "parameters": [
  6765. {
  6766. "name": "sessionID",
  6767. "in": "path",
  6768. "schema": {
  6769. "type": "string",
  6770. "pattern": "^ses"
  6771. },
  6772. "required": true
  6773. },
  6774. {
  6775. "name": "messageID",
  6776. "in": "path",
  6777. "schema": {
  6778. "type": "string",
  6779. "pattern": "^msg"
  6780. },
  6781. "required": true
  6782. },
  6783. {
  6784. "name": "partID",
  6785. "in": "path",
  6786. "schema": {
  6787. "type": "string",
  6788. "pattern": "^prt"
  6789. },
  6790. "required": true
  6791. },
  6792. {
  6793. "name": "directory",
  6794. "in": "query",
  6795. "schema": {
  6796. "type": "string"
  6797. },
  6798. "required": false
  6799. },
  6800. {
  6801. "name": "workspace",
  6802. "in": "query",
  6803. "schema": {
  6804. "type": "string"
  6805. },
  6806. "required": false
  6807. }
  6808. ],
  6809. "responses": {
  6810. "200": {
  6811. "description": "Successfully updated part",
  6812. "content": {
  6813. "application/json": {
  6814. "schema": {
  6815. "$ref": "#/components/schemas/Part"
  6816. }
  6817. }
  6818. }
  6819. },
  6820. "400": {
  6821. "description": "Bad request",
  6822. "content": {
  6823. "application/json": {
  6824. "schema": {
  6825. "$ref": "#/components/schemas/BadRequestError"
  6826. }
  6827. }
  6828. }
  6829. },
  6830. "404": {
  6831. "description": "NotFoundError",
  6832. "content": {
  6833. "application/json": {
  6834. "schema": {
  6835. "$ref": "#/components/schemas/NotFoundError"
  6836. }
  6837. }
  6838. }
  6839. }
  6840. },
  6841. "description": "Update a part in a message.",
  6842. "requestBody": {
  6843. "content": {
  6844. "application/json": {
  6845. "schema": {
  6846. "$ref": "#/components/schemas/Part"
  6847. }
  6848. }
  6849. }
  6850. },
  6851. "x-codeSamples": [
  6852. {
  6853. "lang": "js",
  6854. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.part.update({\n ...\n})"
  6855. }
  6856. ]
  6857. }
  6858. },
  6859. "/sync/start": {
  6860. "post": {
  6861. "tags": ["sync"],
  6862. "operationId": "sync.start",
  6863. "parameters": [
  6864. {
  6865. "name": "directory",
  6866. "in": "query",
  6867. "schema": {
  6868. "type": "string"
  6869. },
  6870. "required": false
  6871. },
  6872. {
  6873. "name": "workspace",
  6874. "in": "query",
  6875. "schema": {
  6876. "type": "string"
  6877. },
  6878. "required": false
  6879. }
  6880. ],
  6881. "responses": {
  6882. "200": {
  6883. "description": "Workspace sync started",
  6884. "content": {
  6885. "application/json": {
  6886. "schema": {
  6887. "type": "boolean",
  6888. "description": "Workspace sync started"
  6889. }
  6890. }
  6891. }
  6892. }
  6893. },
  6894. "description": "Start sync loops for workspaces in the current project that have active sessions.",
  6895. "summary": "Start workspace sync",
  6896. "x-codeSamples": [
  6897. {
  6898. "lang": "js",
  6899. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.sync.start({\n ...\n})"
  6900. }
  6901. ]
  6902. }
  6903. },
  6904. "/sync/replay": {
  6905. "post": {
  6906. "tags": ["sync"],
  6907. "operationId": "sync.replay",
  6908. "parameters": [
  6909. {
  6910. "name": "directory",
  6911. "in": "query",
  6912. "schema": {
  6913. "type": "string"
  6914. },
  6915. "required": false
  6916. },
  6917. {
  6918. "name": "workspace",
  6919. "in": "query",
  6920. "schema": {
  6921. "type": "string"
  6922. },
  6923. "required": false
  6924. }
  6925. ],
  6926. "responses": {
  6927. "200": {
  6928. "description": "Replayed sync events",
  6929. "content": {
  6930. "application/json": {
  6931. "schema": {
  6932. "type": "object",
  6933. "properties": {
  6934. "sessionID": {
  6935. "type": "string"
  6936. }
  6937. },
  6938. "required": ["sessionID"],
  6939. "additionalProperties": false,
  6940. "description": "Replayed sync events"
  6941. }
  6942. }
  6943. }
  6944. },
  6945. "400": {
  6946. "description": "Bad request",
  6947. "content": {
  6948. "application/json": {
  6949. "schema": {
  6950. "$ref": "#/components/schemas/BadRequestError"
  6951. }
  6952. }
  6953. }
  6954. }
  6955. },
  6956. "description": "Validate and replay a complete sync event history.",
  6957. "summary": "Replay sync events",
  6958. "requestBody": {
  6959. "content": {
  6960. "application/json": {
  6961. "schema": {
  6962. "type": "object",
  6963. "properties": {
  6964. "directory": {
  6965. "type": "string"
  6966. },
  6967. "events": {
  6968. "type": "array",
  6969. "minItems": 1,
  6970. "items": {
  6971. "type": "object",
  6972. "properties": {
  6973. "id": {
  6974. "type": "string"
  6975. },
  6976. "aggregateID": {
  6977. "type": "string"
  6978. },
  6979. "seq": {
  6980. "type": "integer",
  6981. "minimum": 0
  6982. },
  6983. "type": {
  6984. "type": "string"
  6985. },
  6986. "data": {
  6987. "type": "object"
  6988. }
  6989. },
  6990. "required": ["id", "aggregateID", "seq", "type", "data"],
  6991. "additionalProperties": false
  6992. }
  6993. }
  6994. },
  6995. "required": ["directory", "events"],
  6996. "additionalProperties": false
  6997. }
  6998. }
  6999. }
  7000. },
  7001. "x-codeSamples": [
  7002. {
  7003. "lang": "js",
  7004. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.sync.replay({\n ...\n})"
  7005. }
  7006. ]
  7007. }
  7008. },
  7009. "/sync/steal": {
  7010. "post": {
  7011. "tags": ["sync"],
  7012. "operationId": "sync.steal",
  7013. "parameters": [
  7014. {
  7015. "name": "directory",
  7016. "in": "query",
  7017. "schema": {
  7018. "type": "string"
  7019. },
  7020. "required": false
  7021. },
  7022. {
  7023. "name": "workspace",
  7024. "in": "query",
  7025. "schema": {
  7026. "type": "string"
  7027. },
  7028. "required": false
  7029. }
  7030. ],
  7031. "responses": {
  7032. "200": {
  7033. "description": "Session stolen into workspace",
  7034. "content": {
  7035. "application/json": {
  7036. "schema": {
  7037. "type": "object",
  7038. "properties": {
  7039. "sessionID": {
  7040. "type": "string",
  7041. "pattern": "^ses"
  7042. }
  7043. },
  7044. "required": ["sessionID"],
  7045. "additionalProperties": false,
  7046. "description": "Session stolen into workspace"
  7047. }
  7048. }
  7049. }
  7050. },
  7051. "400": {
  7052. "description": "Bad request",
  7053. "content": {
  7054. "application/json": {
  7055. "schema": {
  7056. "$ref": "#/components/schemas/BadRequestError"
  7057. }
  7058. }
  7059. }
  7060. }
  7061. },
  7062. "description": "Update a session to belong to the current workspace through the sync event system.",
  7063. "summary": "Steal session into workspace",
  7064. "requestBody": {
  7065. "content": {
  7066. "application/json": {
  7067. "schema": {
  7068. "type": "object",
  7069. "properties": {
  7070. "sessionID": {
  7071. "type": "string",
  7072. "pattern": "^ses"
  7073. }
  7074. },
  7075. "required": ["sessionID"],
  7076. "additionalProperties": false
  7077. }
  7078. }
  7079. }
  7080. },
  7081. "x-codeSamples": [
  7082. {
  7083. "lang": "js",
  7084. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.sync.steal({\n ...\n})"
  7085. }
  7086. ]
  7087. }
  7088. },
  7089. "/sync/history": {
  7090. "post": {
  7091. "tags": ["sync"],
  7092. "operationId": "sync.history.list",
  7093. "parameters": [
  7094. {
  7095. "name": "directory",
  7096. "in": "query",
  7097. "schema": {
  7098. "type": "string"
  7099. },
  7100. "required": false
  7101. },
  7102. {
  7103. "name": "workspace",
  7104. "in": "query",
  7105. "schema": {
  7106. "type": "string"
  7107. },
  7108. "required": false
  7109. }
  7110. ],
  7111. "responses": {
  7112. "200": {
  7113. "description": "Sync events",
  7114. "content": {
  7115. "application/json": {
  7116. "schema": {
  7117. "type": "array",
  7118. "items": {
  7119. "type": "object",
  7120. "properties": {
  7121. "id": {
  7122. "type": "string"
  7123. },
  7124. "aggregate_id": {
  7125. "type": "string"
  7126. },
  7127. "seq": {
  7128. "type": "integer",
  7129. "minimum": 0
  7130. },
  7131. "type": {
  7132. "type": "string"
  7133. },
  7134. "data": {
  7135. "type": "object"
  7136. }
  7137. },
  7138. "required": ["id", "aggregate_id", "seq", "type", "data"],
  7139. "additionalProperties": false
  7140. },
  7141. "description": "Sync events"
  7142. }
  7143. }
  7144. }
  7145. },
  7146. "400": {
  7147. "description": "Bad request",
  7148. "content": {
  7149. "application/json": {
  7150. "schema": {
  7151. "$ref": "#/components/schemas/BadRequestError"
  7152. }
  7153. }
  7154. }
  7155. }
  7156. },
  7157. "description": "List sync events for all aggregates. Keys are aggregate IDs the client already knows about, values are the last known sequence ID. Events with seq > value are returned for those aggregates. Aggregates not listed in the input get their full history.",
  7158. "summary": "List sync events",
  7159. "requestBody": {
  7160. "content": {
  7161. "application/json": {
  7162. "schema": {
  7163. "type": "object",
  7164. "additionalProperties": {
  7165. "type": "integer",
  7166. "minimum": 0
  7167. }
  7168. }
  7169. }
  7170. }
  7171. },
  7172. "x-codeSamples": [
  7173. {
  7174. "lang": "js",
  7175. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.sync.history.list({\n ...\n})"
  7176. }
  7177. ]
  7178. }
  7179. },
  7180. "/api/session": {
  7181. "get": {
  7182. "tags": ["v2"],
  7183. "operationId": "v2.session.list",
  7184. "parameters": [
  7185. {
  7186. "name": "directory",
  7187. "in": "query",
  7188. "schema": {
  7189. "type": "string"
  7190. },
  7191. "required": false
  7192. },
  7193. {
  7194. "name": "workspace",
  7195. "in": "query",
  7196. "schema": {
  7197. "type": "string"
  7198. },
  7199. "required": false
  7200. },
  7201. {
  7202. "name": "limit",
  7203. "in": "query",
  7204. "schema": {
  7205. "type": "number"
  7206. },
  7207. "required": false
  7208. },
  7209. {
  7210. "name": "order",
  7211. "in": "query",
  7212. "schema": {
  7213. "type": "string",
  7214. "enum": ["asc", "desc"]
  7215. },
  7216. "required": false
  7217. },
  7218. {
  7219. "name": "path",
  7220. "in": "query",
  7221. "schema": {
  7222. "type": "string"
  7223. },
  7224. "required": false
  7225. },
  7226. {
  7227. "name": "roots",
  7228. "in": "query",
  7229. "schema": {
  7230. "anyOf": [
  7231. {
  7232. "type": "boolean"
  7233. },
  7234. {
  7235. "type": "string",
  7236. "enum": ["true", "false"]
  7237. }
  7238. ]
  7239. },
  7240. "required": false
  7241. },
  7242. {
  7243. "name": "start",
  7244. "in": "query",
  7245. "schema": {
  7246. "type": "number"
  7247. },
  7248. "required": false
  7249. },
  7250. {
  7251. "name": "search",
  7252. "in": "query",
  7253. "schema": {
  7254. "type": "string"
  7255. },
  7256. "required": false
  7257. },
  7258. {
  7259. "name": "cursor",
  7260. "in": "query",
  7261. "schema": {
  7262. "type": "string",
  7263. "description": "Opaque pagination cursor returned as cursor.previous or cursor.next in the previous response. Do not combine with order or filters."
  7264. },
  7265. "required": false
  7266. }
  7267. ],
  7268. "responses": {
  7269. "200": {
  7270. "description": "V2SessionsResponse",
  7271. "content": {
  7272. "application/json": {
  7273. "schema": {
  7274. "$ref": "#/components/schemas/V2SessionsResponse"
  7275. }
  7276. }
  7277. }
  7278. },
  7279. "400": {
  7280. "description": "Bad request",
  7281. "content": {
  7282. "application/json": {
  7283. "schema": {
  7284. "$ref": "#/components/schemas/BadRequestError"
  7285. }
  7286. }
  7287. }
  7288. }
  7289. },
  7290. "description": "Retrieve sessions in the requested order. Items keep that order across pages; use cursor.next or cursor.previous to move through the ordered list.",
  7291. "summary": "List v2 sessions",
  7292. "x-codeSamples": [
  7293. {
  7294. "lang": "js",
  7295. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.v2.session.list({\n ...\n})"
  7296. }
  7297. ]
  7298. }
  7299. },
  7300. "/api/session/{sessionID}/prompt": {
  7301. "post": {
  7302. "tags": ["v2"],
  7303. "operationId": "v2.session.prompt",
  7304. "parameters": [
  7305. {
  7306. "name": "sessionID",
  7307. "in": "path",
  7308. "schema": {
  7309. "type": "string",
  7310. "pattern": "^ses"
  7311. },
  7312. "required": true
  7313. },
  7314. {
  7315. "name": "directory",
  7316. "in": "query",
  7317. "schema": {
  7318. "type": "string"
  7319. },
  7320. "required": false
  7321. },
  7322. {
  7323. "name": "workspace",
  7324. "in": "query",
  7325. "schema": {
  7326. "type": "string"
  7327. },
  7328. "required": false
  7329. }
  7330. ],
  7331. "responses": {
  7332. "200": {
  7333. "description": "Session.Message",
  7334. "content": {
  7335. "application/json": {
  7336. "schema": {
  7337. "$ref": "#/components/schemas/SessionMessage"
  7338. }
  7339. }
  7340. }
  7341. }
  7342. },
  7343. "description": "Create a v2 session message and queue it for the agent loop.",
  7344. "summary": "Send v2 message",
  7345. "requestBody": {
  7346. "content": {
  7347. "application/json": {
  7348. "schema": {
  7349. "type": "object",
  7350. "properties": {
  7351. "prompt": {
  7352. "$ref": "#/components/schemas/Prompt"
  7353. },
  7354. "delivery": {
  7355. "$ref": "#/components/schemas/SessionDelivery"
  7356. }
  7357. },
  7358. "required": ["prompt"],
  7359. "additionalProperties": false
  7360. }
  7361. }
  7362. }
  7363. },
  7364. "x-codeSamples": [
  7365. {
  7366. "lang": "js",
  7367. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.v2.session.prompt({\n ...\n})"
  7368. }
  7369. ]
  7370. }
  7371. },
  7372. "/api/session/{sessionID}/compact": {
  7373. "post": {
  7374. "tags": ["v2"],
  7375. "operationId": "v2.session.compact",
  7376. "parameters": [
  7377. {
  7378. "name": "sessionID",
  7379. "in": "path",
  7380. "schema": {
  7381. "type": "string",
  7382. "pattern": "^ses"
  7383. },
  7384. "required": true
  7385. },
  7386. {
  7387. "name": "directory",
  7388. "in": "query",
  7389. "schema": {
  7390. "type": "string"
  7391. },
  7392. "required": false
  7393. },
  7394. {
  7395. "name": "workspace",
  7396. "in": "query",
  7397. "schema": {
  7398. "type": "string"
  7399. },
  7400. "required": false
  7401. }
  7402. ],
  7403. "responses": {
  7404. "204": {
  7405. "description": "<No Content>"
  7406. }
  7407. },
  7408. "description": "Compact a v2 session conversation.",
  7409. "summary": "Compact v2 session",
  7410. "x-codeSamples": [
  7411. {
  7412. "lang": "js",
  7413. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.v2.session.compact({\n ...\n})"
  7414. }
  7415. ]
  7416. }
  7417. },
  7418. "/api/session/{sessionID}/wait": {
  7419. "post": {
  7420. "tags": ["v2"],
  7421. "operationId": "v2.session.wait",
  7422. "parameters": [
  7423. {
  7424. "name": "sessionID",
  7425. "in": "path",
  7426. "schema": {
  7427. "type": "string",
  7428. "pattern": "^ses"
  7429. },
  7430. "required": true
  7431. },
  7432. {
  7433. "name": "directory",
  7434. "in": "query",
  7435. "schema": {
  7436. "type": "string"
  7437. },
  7438. "required": false
  7439. },
  7440. {
  7441. "name": "workspace",
  7442. "in": "query",
  7443. "schema": {
  7444. "type": "string"
  7445. },
  7446. "required": false
  7447. }
  7448. ],
  7449. "responses": {
  7450. "204": {
  7451. "description": "<No Content>"
  7452. }
  7453. },
  7454. "description": "Wait for a v2 session agent loop to become idle.",
  7455. "summary": "Wait for v2 session",
  7456. "x-codeSamples": [
  7457. {
  7458. "lang": "js",
  7459. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.v2.session.wait({\n ...\n})"
  7460. }
  7461. ]
  7462. }
  7463. },
  7464. "/api/session/{sessionID}/context": {
  7465. "get": {
  7466. "tags": ["v2"],
  7467. "operationId": "v2.session.context",
  7468. "parameters": [
  7469. {
  7470. "name": "sessionID",
  7471. "in": "path",
  7472. "schema": {
  7473. "type": "string",
  7474. "pattern": "^ses"
  7475. },
  7476. "required": true
  7477. },
  7478. {
  7479. "name": "directory",
  7480. "in": "query",
  7481. "schema": {
  7482. "type": "string"
  7483. },
  7484. "required": false
  7485. },
  7486. {
  7487. "name": "workspace",
  7488. "in": "query",
  7489. "schema": {
  7490. "type": "string"
  7491. },
  7492. "required": false
  7493. }
  7494. ],
  7495. "responses": {
  7496. "200": {
  7497. "description": "Success",
  7498. "content": {
  7499. "application/json": {
  7500. "schema": {
  7501. "type": "array",
  7502. "items": {
  7503. "$ref": "#/components/schemas/SessionMessage"
  7504. }
  7505. }
  7506. }
  7507. }
  7508. }
  7509. },
  7510. "description": "Retrieve the active context messages for a v2 session (all messages after the last compaction).",
  7511. "summary": "Get v2 session context",
  7512. "x-codeSamples": [
  7513. {
  7514. "lang": "js",
  7515. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.v2.session.context({\n ...\n})"
  7516. }
  7517. ]
  7518. }
  7519. },
  7520. "/api/session/{sessionID}/message": {
  7521. "get": {
  7522. "tags": ["v2 messages"],
  7523. "operationId": "v2.session.messages",
  7524. "parameters": [
  7525. {
  7526. "name": "sessionID",
  7527. "in": "path",
  7528. "schema": {
  7529. "type": "string",
  7530. "pattern": "^ses"
  7531. },
  7532. "required": true
  7533. },
  7534. {
  7535. "name": "directory",
  7536. "in": "query",
  7537. "schema": {
  7538. "type": "string"
  7539. },
  7540. "required": false
  7541. },
  7542. {
  7543. "name": "workspace",
  7544. "in": "query",
  7545. "schema": {
  7546. "type": "string"
  7547. },
  7548. "required": false
  7549. },
  7550. {
  7551. "name": "limit",
  7552. "in": "query",
  7553. "schema": {
  7554. "type": "number"
  7555. },
  7556. "required": false
  7557. },
  7558. {
  7559. "name": "order",
  7560. "in": "query",
  7561. "schema": {
  7562. "type": "string",
  7563. "enum": ["asc", "desc"]
  7564. },
  7565. "required": false
  7566. },
  7567. {
  7568. "name": "cursor",
  7569. "in": "query",
  7570. "schema": {
  7571. "type": "string",
  7572. "description": "Opaque pagination cursor returned as cursor.previous or cursor.next in the previous response. Do not combine with order."
  7573. },
  7574. "required": false
  7575. }
  7576. ],
  7577. "responses": {
  7578. "200": {
  7579. "description": "V2SessionMessagesResponse",
  7580. "content": {
  7581. "application/json": {
  7582. "schema": {
  7583. "$ref": "#/components/schemas/V2SessionMessagesResponse"
  7584. }
  7585. }
  7586. }
  7587. },
  7588. "400": {
  7589. "description": "Bad request",
  7590. "content": {
  7591. "application/json": {
  7592. "schema": {
  7593. "$ref": "#/components/schemas/BadRequestError"
  7594. }
  7595. }
  7596. }
  7597. }
  7598. },
  7599. "description": "Retrieve projected v2 messages for a session. Items keep the requested order across pages; use cursor.next or cursor.previous to move through the ordered timeline.",
  7600. "summary": "Get v2 session messages",
  7601. "x-codeSamples": [
  7602. {
  7603. "lang": "js",
  7604. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.v2.session.messages({\n ...\n})"
  7605. }
  7606. ]
  7607. }
  7608. },
  7609. "/api/model": {
  7610. "get": {
  7611. "tags": ["v2 models"],
  7612. "operationId": "v2.model.list",
  7613. "parameters": [
  7614. {
  7615. "name": "instance",
  7616. "in": "query",
  7617. "schema": {
  7618. "type": "object",
  7619. "properties": {
  7620. "directory": {
  7621. "type": "string"
  7622. },
  7623. "workspace": {
  7624. "type": "string"
  7625. }
  7626. },
  7627. "additionalProperties": false
  7628. },
  7629. "required": false,
  7630. "style": "deepObject",
  7631. "explode": true
  7632. }
  7633. ],
  7634. "responses": {
  7635. "200": {
  7636. "description": "Success",
  7637. "content": {
  7638. "application/json": {
  7639. "schema": {
  7640. "type": "array",
  7641. "items": {
  7642. "$ref": "#/components/schemas/ModelV2Info"
  7643. }
  7644. }
  7645. }
  7646. }
  7647. }
  7648. },
  7649. "description": "Retrieve available v2 models ordered by release date.",
  7650. "summary": "List v2 models",
  7651. "x-codeSamples": [
  7652. {
  7653. "lang": "js",
  7654. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.v2.model.list({\n ...\n})"
  7655. }
  7656. ]
  7657. }
  7658. },
  7659. "/api/provider": {
  7660. "get": {
  7661. "tags": ["v2 providers"],
  7662. "operationId": "v2.provider.list",
  7663. "parameters": [
  7664. {
  7665. "name": "instance",
  7666. "in": "query",
  7667. "schema": {
  7668. "type": "object",
  7669. "properties": {
  7670. "directory": {
  7671. "type": "string"
  7672. },
  7673. "workspace": {
  7674. "type": "string"
  7675. }
  7676. },
  7677. "additionalProperties": false
  7678. },
  7679. "required": false,
  7680. "style": "deepObject",
  7681. "explode": true
  7682. }
  7683. ],
  7684. "responses": {
  7685. "200": {
  7686. "description": "Success",
  7687. "content": {
  7688. "application/json": {
  7689. "schema": {
  7690. "type": "array",
  7691. "items": {
  7692. "$ref": "#/components/schemas/ProviderV2Info"
  7693. }
  7694. }
  7695. }
  7696. }
  7697. }
  7698. },
  7699. "description": "Retrieve active v2 AI providers so clients can show provider availability and configuration.",
  7700. "summary": "List v2 providers",
  7701. "x-codeSamples": [
  7702. {
  7703. "lang": "js",
  7704. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.v2.provider.list({\n ...\n})"
  7705. }
  7706. ]
  7707. }
  7708. },
  7709. "/api/provider/{providerID}": {
  7710. "get": {
  7711. "tags": ["v2 providers"],
  7712. "operationId": "v2.provider.get",
  7713. "parameters": [
  7714. {
  7715. "name": "providerID",
  7716. "in": "path",
  7717. "schema": {
  7718. "type": "string"
  7719. },
  7720. "required": true
  7721. },
  7722. {
  7723. "name": "instance",
  7724. "in": "query",
  7725. "schema": {
  7726. "type": "object",
  7727. "properties": {
  7728. "directory": {
  7729. "type": "string"
  7730. },
  7731. "workspace": {
  7732. "type": "string"
  7733. }
  7734. },
  7735. "additionalProperties": false
  7736. },
  7737. "required": false,
  7738. "style": "deepObject",
  7739. "explode": true
  7740. }
  7741. ],
  7742. "responses": {
  7743. "200": {
  7744. "description": "ProviderV2.Info",
  7745. "content": {
  7746. "application/json": {
  7747. "schema": {
  7748. "$ref": "#/components/schemas/ProviderV2Info"
  7749. }
  7750. }
  7751. }
  7752. },
  7753. "404": {
  7754. "description": "NotFoundError",
  7755. "content": {
  7756. "application/json": {
  7757. "schema": {
  7758. "$ref": "#/components/schemas/NotFoundError"
  7759. }
  7760. }
  7761. }
  7762. }
  7763. },
  7764. "description": "Retrieve a single v2 AI provider so clients can inspect its availability and endpoint settings.",
  7765. "summary": "Get v2 provider",
  7766. "x-codeSamples": [
  7767. {
  7768. "lang": "js",
  7769. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.v2.provider.get({\n ...\n})"
  7770. }
  7771. ]
  7772. }
  7773. },
  7774. "/tui/append-prompt": {
  7775. "post": {
  7776. "tags": ["tui"],
  7777. "operationId": "tui.appendPrompt",
  7778. "parameters": [
  7779. {
  7780. "name": "directory",
  7781. "in": "query",
  7782. "schema": {
  7783. "type": "string"
  7784. },
  7785. "required": false
  7786. },
  7787. {
  7788. "name": "workspace",
  7789. "in": "query",
  7790. "schema": {
  7791. "type": "string"
  7792. },
  7793. "required": false
  7794. }
  7795. ],
  7796. "responses": {
  7797. "200": {
  7798. "description": "Prompt processed successfully",
  7799. "content": {
  7800. "application/json": {
  7801. "schema": {
  7802. "type": "boolean",
  7803. "description": "Prompt processed successfully"
  7804. }
  7805. }
  7806. }
  7807. },
  7808. "400": {
  7809. "description": "Bad request",
  7810. "content": {
  7811. "application/json": {
  7812. "schema": {
  7813. "$ref": "#/components/schemas/BadRequestError"
  7814. }
  7815. }
  7816. }
  7817. }
  7818. },
  7819. "description": "Append prompt to the TUI.",
  7820. "summary": "Append TUI prompt",
  7821. "requestBody": {
  7822. "content": {
  7823. "application/json": {
  7824. "schema": {
  7825. "type": "object",
  7826. "properties": {
  7827. "text": {
  7828. "type": "string"
  7829. }
  7830. },
  7831. "required": ["text"],
  7832. "additionalProperties": false
  7833. }
  7834. }
  7835. }
  7836. },
  7837. "x-codeSamples": [
  7838. {
  7839. "lang": "js",
  7840. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.appendPrompt({\n ...\n})"
  7841. }
  7842. ]
  7843. }
  7844. },
  7845. "/tui/open-help": {
  7846. "post": {
  7847. "tags": ["tui"],
  7848. "operationId": "tui.openHelp",
  7849. "parameters": [
  7850. {
  7851. "name": "directory",
  7852. "in": "query",
  7853. "schema": {
  7854. "type": "string"
  7855. },
  7856. "required": false
  7857. },
  7858. {
  7859. "name": "workspace",
  7860. "in": "query",
  7861. "schema": {
  7862. "type": "string"
  7863. },
  7864. "required": false
  7865. }
  7866. ],
  7867. "responses": {
  7868. "200": {
  7869. "description": "Help dialog opened successfully",
  7870. "content": {
  7871. "application/json": {
  7872. "schema": {
  7873. "type": "boolean",
  7874. "description": "Help dialog opened successfully"
  7875. }
  7876. }
  7877. }
  7878. }
  7879. },
  7880. "description": "Open the help dialog in the TUI to display user assistance information.",
  7881. "summary": "Open help dialog",
  7882. "x-codeSamples": [
  7883. {
  7884. "lang": "js",
  7885. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.openHelp({\n ...\n})"
  7886. }
  7887. ]
  7888. }
  7889. },
  7890. "/tui/open-sessions": {
  7891. "post": {
  7892. "tags": ["tui"],
  7893. "operationId": "tui.openSessions",
  7894. "parameters": [
  7895. {
  7896. "name": "directory",
  7897. "in": "query",
  7898. "schema": {
  7899. "type": "string"
  7900. },
  7901. "required": false
  7902. },
  7903. {
  7904. "name": "workspace",
  7905. "in": "query",
  7906. "schema": {
  7907. "type": "string"
  7908. },
  7909. "required": false
  7910. }
  7911. ],
  7912. "responses": {
  7913. "200": {
  7914. "description": "Session dialog opened successfully",
  7915. "content": {
  7916. "application/json": {
  7917. "schema": {
  7918. "type": "boolean",
  7919. "description": "Session dialog opened successfully"
  7920. }
  7921. }
  7922. }
  7923. }
  7924. },
  7925. "description": "Open the session dialog.",
  7926. "summary": "Open sessions dialog",
  7927. "x-codeSamples": [
  7928. {
  7929. "lang": "js",
  7930. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.openSessions({\n ...\n})"
  7931. }
  7932. ]
  7933. }
  7934. },
  7935. "/tui/open-themes": {
  7936. "post": {
  7937. "tags": ["tui"],
  7938. "operationId": "tui.openThemes",
  7939. "parameters": [
  7940. {
  7941. "name": "directory",
  7942. "in": "query",
  7943. "schema": {
  7944. "type": "string"
  7945. },
  7946. "required": false
  7947. },
  7948. {
  7949. "name": "workspace",
  7950. "in": "query",
  7951. "schema": {
  7952. "type": "string"
  7953. },
  7954. "required": false
  7955. }
  7956. ],
  7957. "responses": {
  7958. "200": {
  7959. "description": "Theme dialog opened successfully",
  7960. "content": {
  7961. "application/json": {
  7962. "schema": {
  7963. "type": "boolean",
  7964. "description": "Theme dialog opened successfully"
  7965. }
  7966. }
  7967. }
  7968. }
  7969. },
  7970. "description": "Open the theme dialog.",
  7971. "summary": "Open themes dialog",
  7972. "x-codeSamples": [
  7973. {
  7974. "lang": "js",
  7975. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.openThemes({\n ...\n})"
  7976. }
  7977. ]
  7978. }
  7979. },
  7980. "/tui/open-models": {
  7981. "post": {
  7982. "tags": ["tui"],
  7983. "operationId": "tui.openModels",
  7984. "parameters": [
  7985. {
  7986. "name": "directory",
  7987. "in": "query",
  7988. "schema": {
  7989. "type": "string"
  7990. },
  7991. "required": false
  7992. },
  7993. {
  7994. "name": "workspace",
  7995. "in": "query",
  7996. "schema": {
  7997. "type": "string"
  7998. },
  7999. "required": false
  8000. }
  8001. ],
  8002. "responses": {
  8003. "200": {
  8004. "description": "Model dialog opened successfully",
  8005. "content": {
  8006. "application/json": {
  8007. "schema": {
  8008. "type": "boolean",
  8009. "description": "Model dialog opened successfully"
  8010. }
  8011. }
  8012. }
  8013. }
  8014. },
  8015. "description": "Open the model dialog.",
  8016. "summary": "Open models dialog",
  8017. "x-codeSamples": [
  8018. {
  8019. "lang": "js",
  8020. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.openModels({\n ...\n})"
  8021. }
  8022. ]
  8023. }
  8024. },
  8025. "/tui/submit-prompt": {
  8026. "post": {
  8027. "tags": ["tui"],
  8028. "operationId": "tui.submitPrompt",
  8029. "parameters": [
  8030. {
  8031. "name": "directory",
  8032. "in": "query",
  8033. "schema": {
  8034. "type": "string"
  8035. },
  8036. "required": false
  8037. },
  8038. {
  8039. "name": "workspace",
  8040. "in": "query",
  8041. "schema": {
  8042. "type": "string"
  8043. },
  8044. "required": false
  8045. }
  8046. ],
  8047. "responses": {
  8048. "200": {
  8049. "description": "Prompt submitted successfully",
  8050. "content": {
  8051. "application/json": {
  8052. "schema": {
  8053. "type": "boolean",
  8054. "description": "Prompt submitted successfully"
  8055. }
  8056. }
  8057. }
  8058. }
  8059. },
  8060. "description": "Submit the prompt.",
  8061. "summary": "Submit TUI prompt",
  8062. "x-codeSamples": [
  8063. {
  8064. "lang": "js",
  8065. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.submitPrompt({\n ...\n})"
  8066. }
  8067. ]
  8068. }
  8069. },
  8070. "/tui/clear-prompt": {
  8071. "post": {
  8072. "tags": ["tui"],
  8073. "operationId": "tui.clearPrompt",
  8074. "parameters": [
  8075. {
  8076. "name": "directory",
  8077. "in": "query",
  8078. "schema": {
  8079. "type": "string"
  8080. },
  8081. "required": false
  8082. },
  8083. {
  8084. "name": "workspace",
  8085. "in": "query",
  8086. "schema": {
  8087. "type": "string"
  8088. },
  8089. "required": false
  8090. }
  8091. ],
  8092. "responses": {
  8093. "200": {
  8094. "description": "Prompt cleared successfully",
  8095. "content": {
  8096. "application/json": {
  8097. "schema": {
  8098. "type": "boolean",
  8099. "description": "Prompt cleared successfully"
  8100. }
  8101. }
  8102. }
  8103. }
  8104. },
  8105. "description": "Clear the prompt.",
  8106. "summary": "Clear TUI prompt",
  8107. "x-codeSamples": [
  8108. {
  8109. "lang": "js",
  8110. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.clearPrompt({\n ...\n})"
  8111. }
  8112. ]
  8113. }
  8114. },
  8115. "/tui/execute-command": {
  8116. "post": {
  8117. "tags": ["tui"],
  8118. "operationId": "tui.executeCommand",
  8119. "parameters": [
  8120. {
  8121. "name": "directory",
  8122. "in": "query",
  8123. "schema": {
  8124. "type": "string"
  8125. },
  8126. "required": false
  8127. },
  8128. {
  8129. "name": "workspace",
  8130. "in": "query",
  8131. "schema": {
  8132. "type": "string"
  8133. },
  8134. "required": false
  8135. }
  8136. ],
  8137. "responses": {
  8138. "200": {
  8139. "description": "Command executed successfully",
  8140. "content": {
  8141. "application/json": {
  8142. "schema": {
  8143. "type": "boolean",
  8144. "description": "Command executed successfully"
  8145. }
  8146. }
  8147. }
  8148. },
  8149. "400": {
  8150. "description": "Bad request",
  8151. "content": {
  8152. "application/json": {
  8153. "schema": {
  8154. "$ref": "#/components/schemas/BadRequestError"
  8155. }
  8156. }
  8157. }
  8158. }
  8159. },
  8160. "description": "Execute a TUI command.",
  8161. "summary": "Execute TUI command",
  8162. "requestBody": {
  8163. "content": {
  8164. "application/json": {
  8165. "schema": {
  8166. "type": "object",
  8167. "properties": {
  8168. "command": {
  8169. "type": "string"
  8170. }
  8171. },
  8172. "required": ["command"],
  8173. "additionalProperties": false
  8174. }
  8175. }
  8176. }
  8177. },
  8178. "x-codeSamples": [
  8179. {
  8180. "lang": "js",
  8181. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.executeCommand({\n ...\n})"
  8182. }
  8183. ]
  8184. }
  8185. },
  8186. "/tui/show-toast": {
  8187. "post": {
  8188. "tags": ["tui"],
  8189. "operationId": "tui.showToast",
  8190. "parameters": [
  8191. {
  8192. "name": "directory",
  8193. "in": "query",
  8194. "schema": {
  8195. "type": "string"
  8196. },
  8197. "required": false
  8198. },
  8199. {
  8200. "name": "workspace",
  8201. "in": "query",
  8202. "schema": {
  8203. "type": "string"
  8204. },
  8205. "required": false
  8206. }
  8207. ],
  8208. "responses": {
  8209. "200": {
  8210. "description": "Toast notification shown successfully",
  8211. "content": {
  8212. "application/json": {
  8213. "schema": {
  8214. "type": "boolean",
  8215. "description": "Toast notification shown successfully"
  8216. }
  8217. }
  8218. }
  8219. }
  8220. },
  8221. "description": "Show a toast notification in the TUI.",
  8222. "summary": "Show TUI toast",
  8223. "requestBody": {
  8224. "content": {
  8225. "application/json": {
  8226. "schema": {
  8227. "type": "object",
  8228. "properties": {
  8229. "title": {
  8230. "type": "string"
  8231. },
  8232. "message": {
  8233. "type": "string"
  8234. },
  8235. "variant": {
  8236. "type": "string",
  8237. "enum": ["info", "success", "warning", "error"]
  8238. },
  8239. "duration": {
  8240. "type": "integer",
  8241. "exclusiveMinimum": 0
  8242. }
  8243. },
  8244. "required": ["message", "variant"],
  8245. "additionalProperties": false
  8246. }
  8247. }
  8248. }
  8249. },
  8250. "x-codeSamples": [
  8251. {
  8252. "lang": "js",
  8253. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.showToast({\n ...\n})"
  8254. }
  8255. ]
  8256. }
  8257. },
  8258. "/tui/publish": {
  8259. "post": {
  8260. "tags": ["tui"],
  8261. "operationId": "tui.publish",
  8262. "parameters": [
  8263. {
  8264. "name": "directory",
  8265. "in": "query",
  8266. "schema": {
  8267. "type": "string"
  8268. },
  8269. "required": false
  8270. },
  8271. {
  8272. "name": "workspace",
  8273. "in": "query",
  8274. "schema": {
  8275. "type": "string"
  8276. },
  8277. "required": false
  8278. }
  8279. ],
  8280. "responses": {
  8281. "200": {
  8282. "description": "Event published successfully",
  8283. "content": {
  8284. "application/json": {
  8285. "schema": {
  8286. "type": "boolean",
  8287. "description": "Event published successfully"
  8288. }
  8289. }
  8290. }
  8291. },
  8292. "400": {
  8293. "description": "Bad request",
  8294. "content": {
  8295. "application/json": {
  8296. "schema": {
  8297. "$ref": "#/components/schemas/BadRequestError"
  8298. }
  8299. }
  8300. }
  8301. }
  8302. },
  8303. "description": "Publish a TUI event.",
  8304. "summary": "Publish TUI event",
  8305. "requestBody": {
  8306. "content": {
  8307. "application/json": {
  8308. "schema": {
  8309. "anyOf": [
  8310. {
  8311. "$ref": "#/components/schemas/EventTuiPromptAppend"
  8312. },
  8313. {
  8314. "$ref": "#/components/schemas/EventTuiCommandExecute"
  8315. },
  8316. {
  8317. "$ref": "#/components/schemas/EventTuiToastShow"
  8318. },
  8319. {
  8320. "$ref": "#/components/schemas/EventTuiSessionSelect"
  8321. }
  8322. ]
  8323. }
  8324. }
  8325. }
  8326. },
  8327. "x-codeSamples": [
  8328. {
  8329. "lang": "js",
  8330. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.publish({\n ...\n})"
  8331. }
  8332. ]
  8333. }
  8334. },
  8335. "/tui/select-session": {
  8336. "post": {
  8337. "tags": ["tui"],
  8338. "operationId": "tui.selectSession",
  8339. "parameters": [
  8340. {
  8341. "name": "directory",
  8342. "in": "query",
  8343. "schema": {
  8344. "type": "string"
  8345. },
  8346. "required": false
  8347. },
  8348. {
  8349. "name": "workspace",
  8350. "in": "query",
  8351. "schema": {
  8352. "type": "string"
  8353. },
  8354. "required": false
  8355. }
  8356. ],
  8357. "responses": {
  8358. "200": {
  8359. "description": "Session selected successfully",
  8360. "content": {
  8361. "application/json": {
  8362. "schema": {
  8363. "type": "boolean",
  8364. "description": "Session selected successfully"
  8365. }
  8366. }
  8367. }
  8368. },
  8369. "400": {
  8370. "description": "Bad request",
  8371. "content": {
  8372. "application/json": {
  8373. "schema": {
  8374. "$ref": "#/components/schemas/BadRequestError"
  8375. }
  8376. }
  8377. }
  8378. },
  8379. "404": {
  8380. "description": "NotFoundError",
  8381. "content": {
  8382. "application/json": {
  8383. "schema": {
  8384. "$ref": "#/components/schemas/NotFoundError"
  8385. }
  8386. }
  8387. }
  8388. }
  8389. },
  8390. "description": "Navigate the TUI to display the specified session.",
  8391. "summary": "Select session",
  8392. "requestBody": {
  8393. "content": {
  8394. "application/json": {
  8395. "schema": {
  8396. "type": "object",
  8397. "properties": {
  8398. "sessionID": {
  8399. "type": "string",
  8400. "pattern": "^ses",
  8401. "description": "Session ID to navigate to"
  8402. }
  8403. },
  8404. "required": ["sessionID"],
  8405. "additionalProperties": false
  8406. }
  8407. }
  8408. }
  8409. },
  8410. "x-codeSamples": [
  8411. {
  8412. "lang": "js",
  8413. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.selectSession({\n ...\n})"
  8414. }
  8415. ]
  8416. }
  8417. },
  8418. "/tui/control/next": {
  8419. "get": {
  8420. "tags": ["tui"],
  8421. "operationId": "tui.control.next",
  8422. "parameters": [
  8423. {
  8424. "name": "directory",
  8425. "in": "query",
  8426. "schema": {
  8427. "type": "string"
  8428. },
  8429. "required": false
  8430. },
  8431. {
  8432. "name": "workspace",
  8433. "in": "query",
  8434. "schema": {
  8435. "type": "string"
  8436. },
  8437. "required": false
  8438. }
  8439. ],
  8440. "responses": {
  8441. "200": {
  8442. "description": "Next TUI request",
  8443. "content": {
  8444. "application/json": {
  8445. "schema": {
  8446. "type": "object",
  8447. "properties": {
  8448. "path": {
  8449. "type": "string"
  8450. },
  8451. "body": {}
  8452. },
  8453. "required": ["path", "body"],
  8454. "additionalProperties": false,
  8455. "description": "Next TUI request"
  8456. }
  8457. }
  8458. }
  8459. }
  8460. },
  8461. "description": "Retrieve the next TUI request from the queue for processing.",
  8462. "summary": "Get next TUI request",
  8463. "x-codeSamples": [
  8464. {
  8465. "lang": "js",
  8466. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.control.next({\n ...\n})"
  8467. }
  8468. ]
  8469. }
  8470. },
  8471. "/tui/control/response": {
  8472. "post": {
  8473. "tags": ["tui"],
  8474. "operationId": "tui.control.response",
  8475. "parameters": [
  8476. {
  8477. "name": "directory",
  8478. "in": "query",
  8479. "schema": {
  8480. "type": "string"
  8481. },
  8482. "required": false
  8483. },
  8484. {
  8485. "name": "workspace",
  8486. "in": "query",
  8487. "schema": {
  8488. "type": "string"
  8489. },
  8490. "required": false
  8491. }
  8492. ],
  8493. "responses": {
  8494. "200": {
  8495. "description": "Response submitted successfully",
  8496. "content": {
  8497. "application/json": {
  8498. "schema": {
  8499. "type": "boolean",
  8500. "description": "Response submitted successfully"
  8501. }
  8502. }
  8503. }
  8504. }
  8505. },
  8506. "description": "Submit a response to the TUI request queue to complete a pending request.",
  8507. "summary": "Submit TUI response",
  8508. "requestBody": {
  8509. "content": {
  8510. "application/json": {
  8511. "schema": {}
  8512. }
  8513. }
  8514. },
  8515. "x-codeSamples": [
  8516. {
  8517. "lang": "js",
  8518. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.control.response({\n ...\n})"
  8519. }
  8520. ]
  8521. }
  8522. },
  8523. "/experimental/workspace/adapter": {
  8524. "get": {
  8525. "tags": ["workspace"],
  8526. "operationId": "experimental.workspace.adapter.list",
  8527. "parameters": [
  8528. {
  8529. "name": "directory",
  8530. "in": "query",
  8531. "schema": {
  8532. "type": "string"
  8533. },
  8534. "required": false
  8535. },
  8536. {
  8537. "name": "workspace",
  8538. "in": "query",
  8539. "schema": {
  8540. "type": "string"
  8541. },
  8542. "required": false
  8543. }
  8544. ],
  8545. "responses": {
  8546. "200": {
  8547. "description": "Workspace adapters",
  8548. "content": {
  8549. "application/json": {
  8550. "schema": {
  8551. "type": "array",
  8552. "items": {
  8553. "type": "object",
  8554. "properties": {
  8555. "type": {
  8556. "type": "string"
  8557. },
  8558. "name": {
  8559. "type": "string"
  8560. },
  8561. "description": {
  8562. "type": "string"
  8563. }
  8564. },
  8565. "required": ["type", "name", "description"],
  8566. "additionalProperties": false
  8567. },
  8568. "description": "Workspace adapters"
  8569. }
  8570. }
  8571. }
  8572. }
  8573. },
  8574. "description": "List all available workspace adapters for the current project.",
  8575. "summary": "List workspace adapters",
  8576. "x-codeSamples": [
  8577. {
  8578. "lang": "js",
  8579. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.workspace.adapter.list({\n ...\n})"
  8580. }
  8581. ]
  8582. }
  8583. },
  8584. "/experimental/workspace": {
  8585. "get": {
  8586. "tags": ["workspace"],
  8587. "operationId": "experimental.workspace.list",
  8588. "parameters": [
  8589. {
  8590. "name": "directory",
  8591. "in": "query",
  8592. "schema": {
  8593. "type": "string"
  8594. },
  8595. "required": false
  8596. },
  8597. {
  8598. "name": "workspace",
  8599. "in": "query",
  8600. "schema": {
  8601. "type": "string"
  8602. },
  8603. "required": false
  8604. }
  8605. ],
  8606. "responses": {
  8607. "200": {
  8608. "description": "Workspaces",
  8609. "content": {
  8610. "application/json": {
  8611. "schema": {
  8612. "type": "array",
  8613. "items": {
  8614. "$ref": "#/components/schemas/Workspace"
  8615. },
  8616. "description": "Workspaces"
  8617. }
  8618. }
  8619. }
  8620. }
  8621. },
  8622. "description": "List all workspaces.",
  8623. "summary": "List workspaces",
  8624. "x-codeSamples": [
  8625. {
  8626. "lang": "js",
  8627. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.workspace.list({\n ...\n})"
  8628. }
  8629. ]
  8630. },
  8631. "post": {
  8632. "tags": ["workspace"],
  8633. "operationId": "experimental.workspace.create",
  8634. "parameters": [
  8635. {
  8636. "name": "directory",
  8637. "in": "query",
  8638. "schema": {
  8639. "type": "string"
  8640. },
  8641. "required": false
  8642. },
  8643. {
  8644. "name": "workspace",
  8645. "in": "query",
  8646. "schema": {
  8647. "type": "string"
  8648. },
  8649. "required": false
  8650. }
  8651. ],
  8652. "responses": {
  8653. "200": {
  8654. "description": "Workspace created",
  8655. "content": {
  8656. "application/json": {
  8657. "schema": {
  8658. "$ref": "#/components/schemas/Workspace"
  8659. }
  8660. }
  8661. }
  8662. },
  8663. "400": {
  8664. "description": "Bad request",
  8665. "content": {
  8666. "application/json": {
  8667. "schema": {
  8668. "$ref": "#/components/schemas/BadRequestError"
  8669. }
  8670. }
  8671. }
  8672. }
  8673. },
  8674. "description": "Create a workspace for the current project.",
  8675. "summary": "Create workspace",
  8676. "requestBody": {
  8677. "content": {
  8678. "application/json": {
  8679. "schema": {
  8680. "type": "object",
  8681. "properties": {
  8682. "id": {
  8683. "type": "string",
  8684. "pattern": "^wrk"
  8685. },
  8686. "type": {
  8687. "type": "string"
  8688. },
  8689. "branch": {
  8690. "anyOf": [
  8691. {
  8692. "type": "string"
  8693. },
  8694. {
  8695. "type": "null"
  8696. }
  8697. ]
  8698. },
  8699. "extra": {
  8700. "anyOf": [
  8701. {},
  8702. {
  8703. "type": "null"
  8704. }
  8705. ]
  8706. }
  8707. },
  8708. "required": ["type"],
  8709. "additionalProperties": false
  8710. }
  8711. }
  8712. }
  8713. },
  8714. "x-codeSamples": [
  8715. {
  8716. "lang": "js",
  8717. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.workspace.create({\n ...\n})"
  8718. }
  8719. ]
  8720. }
  8721. },
  8722. "/experimental/workspace/sync-list": {
  8723. "post": {
  8724. "tags": ["workspace"],
  8725. "operationId": "experimental.workspace.syncList",
  8726. "parameters": [
  8727. {
  8728. "name": "directory",
  8729. "in": "query",
  8730. "schema": {
  8731. "type": "string"
  8732. },
  8733. "required": false
  8734. },
  8735. {
  8736. "name": "workspace",
  8737. "in": "query",
  8738. "schema": {
  8739. "type": "string"
  8740. },
  8741. "required": false
  8742. }
  8743. ],
  8744. "responses": {
  8745. "204": {
  8746. "description": "Workspace list synced"
  8747. }
  8748. },
  8749. "description": "Register missing workspaces returned by workspace adapters.",
  8750. "summary": "Sync workspace list",
  8751. "x-codeSamples": [
  8752. {
  8753. "lang": "js",
  8754. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.workspace.syncList({\n ...\n})"
  8755. }
  8756. ]
  8757. }
  8758. },
  8759. "/experimental/workspace/status": {
  8760. "get": {
  8761. "tags": ["workspace"],
  8762. "operationId": "experimental.workspace.status",
  8763. "parameters": [
  8764. {
  8765. "name": "directory",
  8766. "in": "query",
  8767. "schema": {
  8768. "type": "string"
  8769. },
  8770. "required": false
  8771. },
  8772. {
  8773. "name": "workspace",
  8774. "in": "query",
  8775. "schema": {
  8776. "type": "string"
  8777. },
  8778. "required": false
  8779. }
  8780. ],
  8781. "responses": {
  8782. "200": {
  8783. "description": "Workspace status",
  8784. "content": {
  8785. "application/json": {
  8786. "schema": {
  8787. "type": "array",
  8788. "items": {
  8789. "type": "object",
  8790. "properties": {
  8791. "workspaceID": {
  8792. "type": "string",
  8793. "pattern": "^wrk"
  8794. },
  8795. "status": {
  8796. "type": "string",
  8797. "enum": ["connected", "connecting", "disconnected", "error"]
  8798. }
  8799. },
  8800. "required": ["workspaceID", "status"],
  8801. "additionalProperties": false
  8802. },
  8803. "description": "Workspace status"
  8804. }
  8805. }
  8806. }
  8807. }
  8808. },
  8809. "description": "Get connection status for workspaces in the current project.",
  8810. "summary": "Workspace status",
  8811. "x-codeSamples": [
  8812. {
  8813. "lang": "js",
  8814. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.workspace.status({\n ...\n})"
  8815. }
  8816. ]
  8817. }
  8818. },
  8819. "/experimental/workspace/{id}": {
  8820. "delete": {
  8821. "tags": ["workspace"],
  8822. "operationId": "experimental.workspace.remove",
  8823. "parameters": [
  8824. {
  8825. "name": "id",
  8826. "in": "path",
  8827. "schema": {
  8828. "type": "string",
  8829. "pattern": "^wrk"
  8830. },
  8831. "required": true
  8832. },
  8833. {
  8834. "name": "directory",
  8835. "in": "query",
  8836. "schema": {
  8837. "type": "string"
  8838. },
  8839. "required": false
  8840. },
  8841. {
  8842. "name": "workspace",
  8843. "in": "query",
  8844. "schema": {
  8845. "type": "string"
  8846. },
  8847. "required": false
  8848. }
  8849. ],
  8850. "responses": {
  8851. "200": {
  8852. "description": "Workspace removed",
  8853. "content": {
  8854. "application/json": {
  8855. "schema": {
  8856. "$ref": "#/components/schemas/Workspace"
  8857. }
  8858. }
  8859. }
  8860. },
  8861. "400": {
  8862. "description": "Bad request",
  8863. "content": {
  8864. "application/json": {
  8865. "schema": {
  8866. "$ref": "#/components/schemas/BadRequestError"
  8867. }
  8868. }
  8869. }
  8870. }
  8871. },
  8872. "description": "Remove an existing workspace.",
  8873. "summary": "Remove workspace",
  8874. "x-codeSamples": [
  8875. {
  8876. "lang": "js",
  8877. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.workspace.remove({\n ...\n})"
  8878. }
  8879. ]
  8880. }
  8881. },
  8882. "/experimental/workspace/warp": {
  8883. "post": {
  8884. "tags": ["workspace"],
  8885. "operationId": "experimental.workspace.warp",
  8886. "parameters": [
  8887. {
  8888. "name": "directory",
  8889. "in": "query",
  8890. "schema": {
  8891. "type": "string"
  8892. },
  8893. "required": false
  8894. },
  8895. {
  8896. "name": "workspace",
  8897. "in": "query",
  8898. "schema": {
  8899. "type": "string"
  8900. },
  8901. "required": false
  8902. }
  8903. ],
  8904. "responses": {
  8905. "204": {
  8906. "description": "Session warped"
  8907. },
  8908. "400": {
  8909. "description": "WorkspaceWarpError | VcsApplyError",
  8910. "content": {
  8911. "application/json": {
  8912. "schema": {
  8913. "anyOf": [
  8914. {
  8915. "$ref": "#/components/schemas/WorkspaceWarpError"
  8916. },
  8917. {
  8918. "$ref": "#/components/schemas/VcsApplyError"
  8919. }
  8920. ]
  8921. }
  8922. }
  8923. }
  8924. }
  8925. },
  8926. "description": "Move a session's sync history into the target workspace, or detach it to the local project.",
  8927. "summary": "Warp session into workspace",
  8928. "requestBody": {
  8929. "content": {
  8930. "application/json": {
  8931. "schema": {
  8932. "type": "object",
  8933. "properties": {
  8934. "id": {
  8935. "anyOf": [
  8936. {
  8937. "type": "string",
  8938. "pattern": "^wrk"
  8939. },
  8940. {
  8941. "type": "null"
  8942. }
  8943. ]
  8944. },
  8945. "sessionID": {
  8946. "type": "string",
  8947. "pattern": "^ses"
  8948. },
  8949. "copyChanges": {
  8950. "type": "boolean"
  8951. }
  8952. },
  8953. "required": ["id", "sessionID"],
  8954. "additionalProperties": false
  8955. }
  8956. }
  8957. }
  8958. },
  8959. "x-codeSamples": [
  8960. {
  8961. "lang": "js",
  8962. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.workspace.warp({\n ...\n})"
  8963. }
  8964. ]
  8965. }
  8966. },
  8967. "/pty/{ptyID}/connect": {
  8968. "get": {
  8969. "tags": ["pty"],
  8970. "operationId": "pty.connect",
  8971. "parameters": [
  8972. {
  8973. "name": "ptyID",
  8974. "in": "path",
  8975. "schema": {
  8976. "type": "string",
  8977. "pattern": "^pty"
  8978. },
  8979. "required": true
  8980. },
  8981. {
  8982. "name": "directory",
  8983. "in": "query",
  8984. "schema": {
  8985. "type": "string"
  8986. },
  8987. "required": false
  8988. },
  8989. {
  8990. "name": "workspace",
  8991. "in": "query",
  8992. "schema": {
  8993. "type": "string"
  8994. },
  8995. "required": false
  8996. }
  8997. ],
  8998. "responses": {
  8999. "200": {
  9000. "description": "Connected session",
  9001. "content": {
  9002. "application/json": {
  9003. "schema": {
  9004. "type": "boolean",
  9005. "description": "Connected session"
  9006. }
  9007. }
  9008. }
  9009. },
  9010. "403": {
  9011. "description": "Forbidden",
  9012. "content": {
  9013. "application/json": {
  9014. "schema": {
  9015. "$ref": "#/components/schemas/effect_HttpApiError_Forbidden"
  9016. }
  9017. }
  9018. }
  9019. },
  9020. "404": {
  9021. "description": "Not found",
  9022. "content": {
  9023. "application/json": {
  9024. "schema": {
  9025. "$ref": "#/components/schemas/NotFoundError"
  9026. }
  9027. }
  9028. }
  9029. }
  9030. },
  9031. "description": "Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.",
  9032. "summary": "Connect to PTY session",
  9033. "x-codeSamples": [
  9034. {
  9035. "lang": "js",
  9036. "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.connect({\n ...\n})"
  9037. }
  9038. ]
  9039. }
  9040. }
  9041. },
  9042. "components": {
  9043. "schemas": {
  9044. "Event": {
  9045. "anyOf": [
  9046. {
  9047. "$ref": "#/components/schemas/EventServerInstanceDisposed"
  9048. },
  9049. {
  9050. "$ref": "#/components/schemas/EventFileEdited"
  9051. },
  9052. {
  9053. "$ref": "#/components/schemas/EventFileWatcherUpdated"
  9054. },
  9055. {
  9056. "$ref": "#/components/schemas/EventLspClientDiagnostics"
  9057. },
  9058. {
  9059. "$ref": "#/components/schemas/EventLspUpdated"
  9060. },
  9061. {
  9062. "$ref": "#/components/schemas/EventMessagePartDelta"
  9063. },
  9064. {
  9065. "$ref": "#/components/schemas/EventPermissionAsked"
  9066. },
  9067. {
  9068. "$ref": "#/components/schemas/EventPermissionReplied"
  9069. },
  9070. {
  9071. "$ref": "#/components/schemas/EventSessionDiff"
  9072. },
  9073. {
  9074. "$ref": "#/components/schemas/EventSessionError"
  9075. },
  9076. {
  9077. "$ref": "#/components/schemas/EventQuestionAsked"
  9078. },
  9079. {
  9080. "$ref": "#/components/schemas/EventQuestionReplied"
  9081. },
  9082. {
  9083. "$ref": "#/components/schemas/EventQuestionRejected"
  9084. },
  9085. {
  9086. "$ref": "#/components/schemas/EventTodoUpdated"
  9087. },
  9088. {
  9089. "$ref": "#/components/schemas/EventSessionStatus"
  9090. },
  9091. {
  9092. "$ref": "#/components/schemas/EventSessionIdle"
  9093. },
  9094. {
  9095. "$ref": "#/components/schemas/EventSessionCompacted"
  9096. },
  9097. {
  9098. "$ref": "#/components/schemas/Event.tui.prompt.append"
  9099. },
  9100. {
  9101. "$ref": "#/components/schemas/Event.tui.command.execute"
  9102. },
  9103. {
  9104. "$ref": "#/components/schemas/EventTuiToastShow1"
  9105. },
  9106. {
  9107. "$ref": "#/components/schemas/Event.tui.session.select"
  9108. },
  9109. {
  9110. "$ref": "#/components/schemas/EventMcpToolsChanged"
  9111. },
  9112. {
  9113. "$ref": "#/components/schemas/EventMcpBrowserOpenFailed"
  9114. },
  9115. {
  9116. "$ref": "#/components/schemas/EventCommandExecuted"
  9117. },
  9118. {
  9119. "$ref": "#/components/schemas/EventProjectUpdated"
  9120. },
  9121. {
  9122. "$ref": "#/components/schemas/EventVcsBranchUpdated"
  9123. },
  9124. {
  9125. "$ref": "#/components/schemas/EventWorkspaceReady"
  9126. },
  9127. {
  9128. "$ref": "#/components/schemas/EventWorkspaceFailed"
  9129. },
  9130. {
  9131. "$ref": "#/components/schemas/EventWorkspaceStatus"
  9132. },
  9133. {
  9134. "$ref": "#/components/schemas/EventWorktreeReady"
  9135. },
  9136. {
  9137. "$ref": "#/components/schemas/EventWorktreeFailed"
  9138. },
  9139. {
  9140. "$ref": "#/components/schemas/EventPtyCreated"
  9141. },
  9142. {
  9143. "$ref": "#/components/schemas/EventPtyUpdated"
  9144. },
  9145. {
  9146. "$ref": "#/components/schemas/EventPtyExited"
  9147. },
  9148. {
  9149. "$ref": "#/components/schemas/EventPtyDeleted"
  9150. },
  9151. {
  9152. "$ref": "#/components/schemas/EventInstallationUpdated"
  9153. },
  9154. {
  9155. "$ref": "#/components/schemas/EventInstallationUpdate-available"
  9156. },
  9157. {
  9158. "$ref": "#/components/schemas/EventServerConnected"
  9159. },
  9160. {
  9161. "$ref": "#/components/schemas/EventGlobalDisposed"
  9162. }
  9163. ]
  9164. },
  9165. "OAuth": {
  9166. "type": "object",
  9167. "properties": {
  9168. "type": {
  9169. "type": "string",
  9170. "enum": ["oauth"]
  9171. },
  9172. "refresh": {
  9173. "type": "string"
  9174. },
  9175. "access": {
  9176. "type": "string"
  9177. },
  9178. "expires": {
  9179. "type": "integer",
  9180. "minimum": 0
  9181. },
  9182. "accountId": {
  9183. "type": "string"
  9184. },
  9185. "enterpriseUrl": {
  9186. "type": "string"
  9187. }
  9188. },
  9189. "required": ["type", "refresh", "access", "expires"],
  9190. "additionalProperties": false
  9191. },
  9192. "ApiAuth": {
  9193. "type": "object",
  9194. "properties": {
  9195. "type": {
  9196. "type": "string",
  9197. "enum": ["api"]
  9198. },
  9199. "key": {
  9200. "type": "string"
  9201. },
  9202. "metadata": {
  9203. "type": "object",
  9204. "additionalProperties": {
  9205. "type": "string"
  9206. }
  9207. }
  9208. },
  9209. "required": ["type", "key"],
  9210. "additionalProperties": false
  9211. },
  9212. "WellKnownAuth": {
  9213. "type": "object",
  9214. "properties": {
  9215. "type": {
  9216. "type": "string",
  9217. "enum": ["wellknown"]
  9218. },
  9219. "key": {
  9220. "type": "string"
  9221. },
  9222. "token": {
  9223. "type": "string"
  9224. }
  9225. },
  9226. "required": ["type", "key", "token"],
  9227. "additionalProperties": false
  9228. },
  9229. "Auth": {
  9230. "anyOf": [
  9231. {
  9232. "$ref": "#/components/schemas/OAuth"
  9233. },
  9234. {
  9235. "$ref": "#/components/schemas/ApiAuth"
  9236. },
  9237. {
  9238. "$ref": "#/components/schemas/WellKnownAuth"
  9239. }
  9240. ]
  9241. },
  9242. "PermissionRequest": {
  9243. "type": "object",
  9244. "properties": {
  9245. "id": {
  9246. "type": "string",
  9247. "pattern": "^per"
  9248. },
  9249. "sessionID": {
  9250. "type": "string",
  9251. "pattern": "^ses"
  9252. },
  9253. "permission": {
  9254. "type": "string"
  9255. },
  9256. "patterns": {
  9257. "type": "array",
  9258. "items": {
  9259. "type": "string"
  9260. }
  9261. },
  9262. "metadata": {
  9263. "type": "object"
  9264. },
  9265. "always": {
  9266. "type": "array",
  9267. "items": {
  9268. "type": "string"
  9269. }
  9270. },
  9271. "tool": {
  9272. "type": "object",
  9273. "properties": {
  9274. "messageID": {
  9275. "type": "string",
  9276. "pattern": "^msg"
  9277. },
  9278. "callID": {
  9279. "type": "string"
  9280. }
  9281. },
  9282. "required": ["messageID", "callID"],
  9283. "additionalProperties": false
  9284. }
  9285. },
  9286. "required": ["id", "sessionID", "permission", "patterns", "metadata", "always"],
  9287. "additionalProperties": false
  9288. },
  9289. "SnapshotFileDiff": {
  9290. "type": "object",
  9291. "properties": {
  9292. "file": {
  9293. "type": "string"
  9294. },
  9295. "patch": {
  9296. "type": "string"
  9297. },
  9298. "additions": {
  9299. "type": "number"
  9300. },
  9301. "deletions": {
  9302. "type": "number"
  9303. },
  9304. "status": {
  9305. "type": "string",
  9306. "enum": ["added", "deleted", "modified"]
  9307. }
  9308. },
  9309. "required": ["additions", "deletions"],
  9310. "additionalProperties": false
  9311. },
  9312. "ProviderAuthError": {
  9313. "type": "object",
  9314. "properties": {
  9315. "name": {
  9316. "type": "string",
  9317. "enum": ["ProviderAuthError"]
  9318. },
  9319. "data": {
  9320. "type": "object",
  9321. "properties": {
  9322. "providerID": {
  9323. "type": "string"
  9324. },
  9325. "message": {
  9326. "type": "string"
  9327. }
  9328. },
  9329. "required": ["providerID", "message"],
  9330. "additionalProperties": false
  9331. }
  9332. },
  9333. "required": ["name", "data"],
  9334. "additionalProperties": false
  9335. },
  9336. "UnknownError": {
  9337. "type": "object",
  9338. "properties": {
  9339. "name": {
  9340. "type": "string",
  9341. "enum": ["UnknownError"]
  9342. },
  9343. "data": {
  9344. "type": "object",
  9345. "properties": {
  9346. "message": {
  9347. "type": "string"
  9348. }
  9349. },
  9350. "required": ["message"],
  9351. "additionalProperties": false
  9352. }
  9353. },
  9354. "required": ["name", "data"],
  9355. "additionalProperties": false
  9356. },
  9357. "MessageOutputLengthError": {
  9358. "type": "object",
  9359. "properties": {
  9360. "name": {
  9361. "type": "string",
  9362. "enum": ["MessageOutputLengthError"]
  9363. },
  9364. "data": {
  9365. "type": "object",
  9366. "properties": {}
  9367. }
  9368. },
  9369. "required": ["name", "data"],
  9370. "additionalProperties": false
  9371. },
  9372. "MessageAbortedError": {
  9373. "type": "object",
  9374. "properties": {
  9375. "name": {
  9376. "type": "string",
  9377. "enum": ["MessageAbortedError"]
  9378. },
  9379. "data": {
  9380. "type": "object",
  9381. "properties": {
  9382. "message": {
  9383. "type": "string"
  9384. }
  9385. },
  9386. "required": ["message"],
  9387. "additionalProperties": false
  9388. }
  9389. },
  9390. "required": ["name", "data"],
  9391. "additionalProperties": false
  9392. },
  9393. "StructuredOutputError": {
  9394. "type": "object",
  9395. "properties": {
  9396. "name": {
  9397. "type": "string",
  9398. "enum": ["StructuredOutputError"]
  9399. },
  9400. "data": {
  9401. "type": "object",
  9402. "properties": {
  9403. "message": {
  9404. "type": "string"
  9405. },
  9406. "retries": {
  9407. "type": "integer",
  9408. "minimum": 0
  9409. }
  9410. },
  9411. "required": ["message", "retries"],
  9412. "additionalProperties": false
  9413. }
  9414. },
  9415. "required": ["name", "data"],
  9416. "additionalProperties": false
  9417. },
  9418. "ContextOverflowError": {
  9419. "type": "object",
  9420. "properties": {
  9421. "name": {
  9422. "type": "string",
  9423. "enum": ["ContextOverflowError"]
  9424. },
  9425. "data": {
  9426. "type": "object",
  9427. "properties": {
  9428. "message": {
  9429. "type": "string"
  9430. },
  9431. "responseBody": {
  9432. "type": "string"
  9433. }
  9434. },
  9435. "required": ["message"],
  9436. "additionalProperties": false
  9437. }
  9438. },
  9439. "required": ["name", "data"],
  9440. "additionalProperties": false
  9441. },
  9442. "APIError": {
  9443. "type": "object",
  9444. "properties": {
  9445. "name": {
  9446. "type": "string",
  9447. "enum": ["APIError"]
  9448. },
  9449. "data": {
  9450. "type": "object",
  9451. "properties": {
  9452. "message": {
  9453. "type": "string"
  9454. },
  9455. "statusCode": {
  9456. "type": "integer",
  9457. "minimum": 0
  9458. },
  9459. "isRetryable": {
  9460. "type": "boolean"
  9461. },
  9462. "responseHeaders": {
  9463. "type": "object",
  9464. "additionalProperties": {
  9465. "type": "string"
  9466. }
  9467. },
  9468. "responseBody": {
  9469. "type": "string"
  9470. },
  9471. "metadata": {
  9472. "type": "object",
  9473. "additionalProperties": {
  9474. "type": "string"
  9475. }
  9476. }
  9477. },
  9478. "required": ["message", "isRetryable"],
  9479. "additionalProperties": false
  9480. }
  9481. },
  9482. "required": ["name", "data"],
  9483. "additionalProperties": false
  9484. },
  9485. "QuestionOption": {
  9486. "type": "object",
  9487. "properties": {
  9488. "label": {
  9489. "type": "string",
  9490. "description": "Display text (1-5 words, concise)"
  9491. },
  9492. "description": {
  9493. "type": "string",
  9494. "description": "Explanation of choice"
  9495. }
  9496. },
  9497. "required": ["label", "description"],
  9498. "additionalProperties": false
  9499. },
  9500. "QuestionInfo": {
  9501. "type": "object",
  9502. "properties": {
  9503. "question": {
  9504. "type": "string",
  9505. "description": "Complete question"
  9506. },
  9507. "header": {
  9508. "type": "string",
  9509. "description": "Very short label (max 30 chars)"
  9510. },
  9511. "options": {
  9512. "type": "array",
  9513. "items": {
  9514. "$ref": "#/components/schemas/QuestionOption"
  9515. },
  9516. "description": "Available choices"
  9517. },
  9518. "multiple": {
  9519. "type": "boolean"
  9520. },
  9521. "custom": {
  9522. "type": "boolean"
  9523. }
  9524. },
  9525. "required": ["question", "header", "options"],
  9526. "additionalProperties": false
  9527. },
  9528. "QuestionTool": {
  9529. "type": "object",
  9530. "properties": {
  9531. "messageID": {
  9532. "type": "string",
  9533. "pattern": "^msg"
  9534. },
  9535. "callID": {
  9536. "type": "string"
  9537. }
  9538. },
  9539. "required": ["messageID", "callID"],
  9540. "additionalProperties": false
  9541. },
  9542. "QuestionRequest": {
  9543. "type": "object",
  9544. "properties": {
  9545. "id": {
  9546. "type": "string",
  9547. "pattern": "^que"
  9548. },
  9549. "sessionID": {
  9550. "type": "string",
  9551. "pattern": "^ses"
  9552. },
  9553. "questions": {
  9554. "type": "array",
  9555. "items": {
  9556. "$ref": "#/components/schemas/QuestionInfo"
  9557. },
  9558. "description": "Questions to ask"
  9559. },
  9560. "tool": {
  9561. "$ref": "#/components/schemas/QuestionTool"
  9562. }
  9563. },
  9564. "required": ["id", "sessionID", "questions"],
  9565. "additionalProperties": false
  9566. },
  9567. "QuestionAnswer": {
  9568. "type": "array",
  9569. "items": {
  9570. "type": "string"
  9571. }
  9572. },
  9573. "QuestionReplied": {
  9574. "type": "object",
  9575. "properties": {
  9576. "sessionID": {
  9577. "type": "string",
  9578. "pattern": "^ses"
  9579. },
  9580. "requestID": {
  9581. "type": "string",
  9582. "pattern": "^que"
  9583. },
  9584. "answers": {
  9585. "type": "array",
  9586. "items": {
  9587. "$ref": "#/components/schemas/QuestionAnswer"
  9588. }
  9589. }
  9590. },
  9591. "required": ["sessionID", "requestID", "answers"],
  9592. "additionalProperties": false
  9593. },
  9594. "QuestionRejected": {
  9595. "type": "object",
  9596. "properties": {
  9597. "sessionID": {
  9598. "type": "string",
  9599. "pattern": "^ses"
  9600. },
  9601. "requestID": {
  9602. "type": "string",
  9603. "pattern": "^que"
  9604. }
  9605. },
  9606. "required": ["sessionID", "requestID"],
  9607. "additionalProperties": false
  9608. },
  9609. "Todo": {
  9610. "type": "object",
  9611. "properties": {
  9612. "content": {
  9613. "type": "string",
  9614. "description": "Brief description of the task"
  9615. },
  9616. "status": {
  9617. "type": "string",
  9618. "description": "Current status of the task: pending, in_progress, completed, cancelled"
  9619. },
  9620. "priority": {
  9621. "type": "string",
  9622. "description": "Priority level of the task: high, medium, low"
  9623. }
  9624. },
  9625. "required": ["content", "status", "priority"],
  9626. "additionalProperties": false
  9627. },
  9628. "SessionStatus": {
  9629. "anyOf": [
  9630. {
  9631. "type": "object",
  9632. "properties": {
  9633. "type": {
  9634. "type": "string",
  9635. "enum": ["idle"]
  9636. }
  9637. },
  9638. "required": ["type"],
  9639. "additionalProperties": false
  9640. },
  9641. {
  9642. "type": "object",
  9643. "properties": {
  9644. "type": {
  9645. "type": "string",
  9646. "enum": ["retry"]
  9647. },
  9648. "attempt": {
  9649. "type": "integer",
  9650. "minimum": 0
  9651. },
  9652. "message": {
  9653. "type": "string"
  9654. },
  9655. "action": {
  9656. "type": "object",
  9657. "properties": {
  9658. "reason": {
  9659. "type": "string"
  9660. },
  9661. "provider": {
  9662. "type": "string"
  9663. },
  9664. "title": {
  9665. "type": "string"
  9666. },
  9667. "message": {
  9668. "type": "string"
  9669. },
  9670. "label": {
  9671. "type": "string"
  9672. },
  9673. "link": {
  9674. "type": "string"
  9675. }
  9676. },
  9677. "required": ["reason", "provider", "title", "message", "label"],
  9678. "additionalProperties": false
  9679. },
  9680. "next": {
  9681. "type": "integer",
  9682. "minimum": 0
  9683. }
  9684. },
  9685. "required": ["type", "attempt", "message", "next"],
  9686. "additionalProperties": false
  9687. },
  9688. {
  9689. "type": "object",
  9690. "properties": {
  9691. "type": {
  9692. "type": "string",
  9693. "enum": ["busy"]
  9694. }
  9695. },
  9696. "required": ["type"],
  9697. "additionalProperties": false
  9698. }
  9699. ]
  9700. },
  9701. "Event.tui.prompt.append": {
  9702. "type": "object",
  9703. "properties": {
  9704. "id": {
  9705. "type": "string"
  9706. },
  9707. "type": {
  9708. "type": "string",
  9709. "enum": ["tui.prompt.append"]
  9710. },
  9711. "properties": {
  9712. "type": "object",
  9713. "properties": {
  9714. "text": {
  9715. "type": "string"
  9716. }
  9717. },
  9718. "required": ["text"],
  9719. "additionalProperties": false
  9720. }
  9721. },
  9722. "required": ["id", "type", "properties"],
  9723. "additionalProperties": false
  9724. },
  9725. "Event.tui.command.execute": {
  9726. "type": "object",
  9727. "properties": {
  9728. "id": {
  9729. "type": "string"
  9730. },
  9731. "type": {
  9732. "type": "string",
  9733. "enum": ["tui.command.execute"]
  9734. },
  9735. "properties": {
  9736. "type": "object",
  9737. "properties": {
  9738. "command": {
  9739. "anyOf": [
  9740. {
  9741. "type": "string",
  9742. "enum": [
  9743. "session.list",
  9744. "session.new",
  9745. "session.share",
  9746. "session.interrupt",
  9747. "session.compact",
  9748. "session.page.up",
  9749. "session.page.down",
  9750. "session.line.up",
  9751. "session.line.down",
  9752. "session.half.page.up",
  9753. "session.half.page.down",
  9754. "session.first",
  9755. "session.last",
  9756. "prompt.clear",
  9757. "prompt.submit",
  9758. "agent.cycle"
  9759. ]
  9760. },
  9761. {
  9762. "type": "string"
  9763. }
  9764. ]
  9765. }
  9766. },
  9767. "required": ["command"],
  9768. "additionalProperties": false
  9769. }
  9770. },
  9771. "required": ["id", "type", "properties"],
  9772. "additionalProperties": false
  9773. },
  9774. "Event.tui.toast.show": {
  9775. "type": "object",
  9776. "properties": {
  9777. "id": {
  9778. "type": "string"
  9779. },
  9780. "type": {
  9781. "type": "string",
  9782. "enum": ["tui.toast.show"]
  9783. },
  9784. "properties": {
  9785. "type": "object",
  9786. "properties": {
  9787. "title": {
  9788. "type": "string"
  9789. },
  9790. "message": {
  9791. "type": "string"
  9792. },
  9793. "variant": {
  9794. "type": "string",
  9795. "enum": ["info", "success", "warning", "error"]
  9796. },
  9797. "duration": {
  9798. "type": "integer",
  9799. "exclusiveMinimum": 0
  9800. }
  9801. },
  9802. "required": ["message", "variant"],
  9803. "additionalProperties": false
  9804. }
  9805. },
  9806. "required": ["id", "type", "properties"],
  9807. "additionalProperties": false
  9808. },
  9809. "Event.tui.session.select": {
  9810. "type": "object",
  9811. "properties": {
  9812. "id": {
  9813. "type": "string"
  9814. },
  9815. "type": {
  9816. "type": "string",
  9817. "enum": ["tui.session.select"]
  9818. },
  9819. "properties": {
  9820. "type": "object",
  9821. "properties": {
  9822. "sessionID": {
  9823. "type": "string",
  9824. "pattern": "^ses",
  9825. "description": "Session ID to navigate to"
  9826. }
  9827. },
  9828. "required": ["sessionID"],
  9829. "additionalProperties": false
  9830. }
  9831. },
  9832. "required": ["id", "type", "properties"],
  9833. "additionalProperties": false
  9834. },
  9835. "Project": {
  9836. "type": "object",
  9837. "properties": {
  9838. "id": {
  9839. "type": "string"
  9840. },
  9841. "worktree": {
  9842. "type": "string"
  9843. },
  9844. "vcs": {
  9845. "type": "string",
  9846. "enum": ["git"]
  9847. },
  9848. "name": {
  9849. "type": "string"
  9850. },
  9851. "icon": {
  9852. "type": "object",
  9853. "properties": {
  9854. "url": {
  9855. "type": "string"
  9856. },
  9857. "override": {
  9858. "type": "string"
  9859. },
  9860. "color": {
  9861. "type": "string"
  9862. }
  9863. },
  9864. "additionalProperties": false
  9865. },
  9866. "commands": {
  9867. "type": "object",
  9868. "properties": {
  9869. "start": {
  9870. "type": "string",
  9871. "description": "Startup script to run when creating a new workspace (worktree)"
  9872. }
  9873. },
  9874. "additionalProperties": false
  9875. },
  9876. "time": {
  9877. "type": "object",
  9878. "properties": {
  9879. "created": {
  9880. "type": "integer",
  9881. "minimum": 0
  9882. },
  9883. "updated": {
  9884. "type": "integer",
  9885. "minimum": 0
  9886. },
  9887. "initialized": {
  9888. "type": "integer",
  9889. "minimum": 0
  9890. }
  9891. },
  9892. "required": ["created", "updated"],
  9893. "additionalProperties": false
  9894. },
  9895. "sandboxes": {
  9896. "type": "array",
  9897. "items": {
  9898. "type": "string"
  9899. }
  9900. }
  9901. },
  9902. "required": ["id", "worktree", "time", "sandboxes"],
  9903. "additionalProperties": false
  9904. },
  9905. "Pty": {
  9906. "type": "object",
  9907. "properties": {
  9908. "id": {
  9909. "type": "string",
  9910. "pattern": "^pty"
  9911. },
  9912. "title": {
  9913. "type": "string"
  9914. },
  9915. "command": {
  9916. "type": "string"
  9917. },
  9918. "args": {
  9919. "type": "array",
  9920. "items": {
  9921. "type": "string"
  9922. }
  9923. },
  9924. "cwd": {
  9925. "type": "string"
  9926. },
  9927. "status": {
  9928. "type": "string",
  9929. "enum": ["running", "exited"]
  9930. },
  9931. "pid": {
  9932. "type": "integer",
  9933. "exclusiveMinimum": 0
  9934. }
  9935. },
  9936. "required": ["id", "title", "command", "args", "cwd", "status", "pid"],
  9937. "additionalProperties": false
  9938. },
  9939. "OutputFormatText": {
  9940. "type": "object",
  9941. "properties": {
  9942. "type": {
  9943. "type": "string",
  9944. "enum": ["text"]
  9945. }
  9946. },
  9947. "required": ["type"],
  9948. "additionalProperties": false
  9949. },
  9950. "JSONSchema": {
  9951. "type": "object"
  9952. },
  9953. "OutputFormatJsonSchema": {
  9954. "type": "object",
  9955. "properties": {
  9956. "type": {
  9957. "type": "string",
  9958. "enum": ["json_schema"]
  9959. },
  9960. "schema": {
  9961. "$ref": "#/components/schemas/JSONSchema"
  9962. },
  9963. "retryCount": {
  9964. "type": "integer",
  9965. "minimum": 0
  9966. }
  9967. },
  9968. "required": ["type", "schema"],
  9969. "additionalProperties": false
  9970. },
  9971. "OutputFormat": {
  9972. "anyOf": [
  9973. {
  9974. "$ref": "#/components/schemas/OutputFormatText"
  9975. },
  9976. {
  9977. "$ref": "#/components/schemas/OutputFormatJsonSchema"
  9978. }
  9979. ]
  9980. },
  9981. "UserMessage": {
  9982. "type": "object",
  9983. "properties": {
  9984. "id": {
  9985. "type": "string",
  9986. "pattern": "^msg"
  9987. },
  9988. "sessionID": {
  9989. "type": "string",
  9990. "pattern": "^ses"
  9991. },
  9992. "role": {
  9993. "type": "string",
  9994. "enum": ["user"]
  9995. },
  9996. "time": {
  9997. "type": "object",
  9998. "properties": {
  9999. "created": {
  10000. "type": "integer",
  10001. "minimum": 0
  10002. }
  10003. },
  10004. "required": ["created"],
  10005. "additionalProperties": false
  10006. },
  10007. "format": {
  10008. "$ref": "#/components/schemas/OutputFormat"
  10009. },
  10010. "summary": {
  10011. "type": "object",
  10012. "properties": {
  10013. "title": {
  10014. "type": "string"
  10015. },
  10016. "body": {
  10017. "type": "string"
  10018. },
  10019. "diffs": {
  10020. "type": "array",
  10021. "items": {
  10022. "$ref": "#/components/schemas/SnapshotFileDiff"
  10023. }
  10024. }
  10025. },
  10026. "required": ["diffs"],
  10027. "additionalProperties": false
  10028. },
  10029. "agent": {
  10030. "type": "string"
  10031. },
  10032. "model": {
  10033. "type": "object",
  10034. "properties": {
  10035. "providerID": {
  10036. "type": "string"
  10037. },
  10038. "modelID": {
  10039. "type": "string"
  10040. },
  10041. "variant": {
  10042. "type": "string"
  10043. }
  10044. },
  10045. "required": ["providerID", "modelID"],
  10046. "additionalProperties": false
  10047. },
  10048. "system": {
  10049. "type": "string"
  10050. },
  10051. "tools": {
  10052. "type": "object",
  10053. "additionalProperties": {
  10054. "type": "boolean"
  10055. }
  10056. }
  10057. },
  10058. "required": ["id", "sessionID", "role", "time", "agent", "model"],
  10059. "additionalProperties": false
  10060. },
  10061. "AssistantMessage": {
  10062. "type": "object",
  10063. "properties": {
  10064. "id": {
  10065. "type": "string",
  10066. "pattern": "^msg"
  10067. },
  10068. "sessionID": {
  10069. "type": "string",
  10070. "pattern": "^ses"
  10071. },
  10072. "role": {
  10073. "type": "string",
  10074. "enum": ["assistant"]
  10075. },
  10076. "time": {
  10077. "type": "object",
  10078. "properties": {
  10079. "created": {
  10080. "type": "integer",
  10081. "minimum": 0
  10082. },
  10083. "completed": {
  10084. "type": "integer",
  10085. "minimum": 0
  10086. }
  10087. },
  10088. "required": ["created"],
  10089. "additionalProperties": false
  10090. },
  10091. "error": {
  10092. "anyOf": [
  10093. {
  10094. "$ref": "#/components/schemas/ProviderAuthError"
  10095. },
  10096. {
  10097. "$ref": "#/components/schemas/UnknownError"
  10098. },
  10099. {
  10100. "$ref": "#/components/schemas/MessageOutputLengthError"
  10101. },
  10102. {
  10103. "$ref": "#/components/schemas/MessageAbortedError"
  10104. },
  10105. {
  10106. "$ref": "#/components/schemas/StructuredOutputError"
  10107. },
  10108. {
  10109. "$ref": "#/components/schemas/ContextOverflowError"
  10110. },
  10111. {
  10112. "$ref": "#/components/schemas/APIError"
  10113. }
  10114. ]
  10115. },
  10116. "parentID": {
  10117. "type": "string",
  10118. "pattern": "^msg"
  10119. },
  10120. "modelID": {
  10121. "type": "string"
  10122. },
  10123. "providerID": {
  10124. "type": "string"
  10125. },
  10126. "mode": {
  10127. "type": "string"
  10128. },
  10129. "agent": {
  10130. "type": "string"
  10131. },
  10132. "path": {
  10133. "type": "object",
  10134. "properties": {
  10135. "cwd": {
  10136. "type": "string"
  10137. },
  10138. "root": {
  10139. "type": "string"
  10140. }
  10141. },
  10142. "required": ["cwd", "root"],
  10143. "additionalProperties": false
  10144. },
  10145. "summary": {
  10146. "type": "boolean"
  10147. },
  10148. "cost": {
  10149. "type": "number"
  10150. },
  10151. "tokens": {
  10152. "type": "object",
  10153. "properties": {
  10154. "total": {
  10155. "type": "number"
  10156. },
  10157. "input": {
  10158. "type": "number"
  10159. },
  10160. "output": {
  10161. "type": "number"
  10162. },
  10163. "reasoning": {
  10164. "type": "number"
  10165. },
  10166. "cache": {
  10167. "type": "object",
  10168. "properties": {
  10169. "read": {
  10170. "type": "number"
  10171. },
  10172. "write": {
  10173. "type": "number"
  10174. }
  10175. },
  10176. "required": ["read", "write"],
  10177. "additionalProperties": false
  10178. }
  10179. },
  10180. "required": ["input", "output", "reasoning", "cache"],
  10181. "additionalProperties": false
  10182. },
  10183. "structured": {},
  10184. "variant": {
  10185. "type": "string"
  10186. },
  10187. "finish": {
  10188. "type": "string"
  10189. }
  10190. },
  10191. "required": [
  10192. "id",
  10193. "sessionID",
  10194. "role",
  10195. "time",
  10196. "parentID",
  10197. "modelID",
  10198. "providerID",
  10199. "mode",
  10200. "agent",
  10201. "path",
  10202. "cost",
  10203. "tokens"
  10204. ],
  10205. "additionalProperties": false
  10206. },
  10207. "Message": {
  10208. "anyOf": [
  10209. {
  10210. "$ref": "#/components/schemas/UserMessage"
  10211. },
  10212. {
  10213. "$ref": "#/components/schemas/AssistantMessage"
  10214. }
  10215. ]
  10216. },
  10217. "TextPart": {
  10218. "type": "object",
  10219. "properties": {
  10220. "id": {
  10221. "type": "string",
  10222. "pattern": "^prt"
  10223. },
  10224. "sessionID": {
  10225. "type": "string",
  10226. "pattern": "^ses"
  10227. },
  10228. "messageID": {
  10229. "type": "string",
  10230. "pattern": "^msg"
  10231. },
  10232. "type": {
  10233. "type": "string",
  10234. "enum": ["text"]
  10235. },
  10236. "text": {
  10237. "type": "string"
  10238. },
  10239. "synthetic": {
  10240. "type": "boolean"
  10241. },
  10242. "ignored": {
  10243. "type": "boolean"
  10244. },
  10245. "time": {
  10246. "type": "object",
  10247. "properties": {
  10248. "start": {
  10249. "type": "integer",
  10250. "minimum": 0
  10251. },
  10252. "end": {
  10253. "type": "integer",
  10254. "minimum": 0
  10255. }
  10256. },
  10257. "required": ["start"],
  10258. "additionalProperties": false
  10259. },
  10260. "metadata": {
  10261. "type": "object"
  10262. }
  10263. },
  10264. "required": ["id", "sessionID", "messageID", "type", "text"],
  10265. "additionalProperties": false
  10266. },
  10267. "SubtaskPart": {
  10268. "type": "object",
  10269. "properties": {
  10270. "id": {
  10271. "type": "string",
  10272. "pattern": "^prt"
  10273. },
  10274. "sessionID": {
  10275. "type": "string",
  10276. "pattern": "^ses"
  10277. },
  10278. "messageID": {
  10279. "type": "string",
  10280. "pattern": "^msg"
  10281. },
  10282. "type": {
  10283. "type": "string",
  10284. "enum": ["subtask"]
  10285. },
  10286. "prompt": {
  10287. "type": "string"
  10288. },
  10289. "description": {
  10290. "type": "string"
  10291. },
  10292. "agent": {
  10293. "type": "string"
  10294. },
  10295. "model": {
  10296. "type": "object",
  10297. "properties": {
  10298. "providerID": {
  10299. "type": "string"
  10300. },
  10301. "modelID": {
  10302. "type": "string"
  10303. }
  10304. },
  10305. "required": ["providerID", "modelID"],
  10306. "additionalProperties": false
  10307. },
  10308. "command": {
  10309. "type": "string"
  10310. }
  10311. },
  10312. "required": ["id", "sessionID", "messageID", "type", "prompt", "description", "agent"],
  10313. "additionalProperties": false
  10314. },
  10315. "ReasoningPart": {
  10316. "type": "object",
  10317. "properties": {
  10318. "id": {
  10319. "type": "string",
  10320. "pattern": "^prt"
  10321. },
  10322. "sessionID": {
  10323. "type": "string",
  10324. "pattern": "^ses"
  10325. },
  10326. "messageID": {
  10327. "type": "string",
  10328. "pattern": "^msg"
  10329. },
  10330. "type": {
  10331. "type": "string",
  10332. "enum": ["reasoning"]
  10333. },
  10334. "text": {
  10335. "type": "string"
  10336. },
  10337. "metadata": {
  10338. "type": "object"
  10339. },
  10340. "time": {
  10341. "type": "object",
  10342. "properties": {
  10343. "start": {
  10344. "type": "integer",
  10345. "minimum": 0
  10346. },
  10347. "end": {
  10348. "type": "integer",
  10349. "minimum": 0
  10350. }
  10351. },
  10352. "required": ["start"],
  10353. "additionalProperties": false
  10354. }
  10355. },
  10356. "required": ["id", "sessionID", "messageID", "type", "text", "time"],
  10357. "additionalProperties": false
  10358. },
  10359. "FilePartSourceText": {
  10360. "type": "object",
  10361. "properties": {
  10362. "value": {
  10363. "type": "string"
  10364. },
  10365. "start": {
  10366. "type": "number"
  10367. },
  10368. "end": {
  10369. "type": "number"
  10370. }
  10371. },
  10372. "required": ["value", "start", "end"],
  10373. "additionalProperties": false
  10374. },
  10375. "FileSource": {
  10376. "type": "object",
  10377. "properties": {
  10378. "text": {
  10379. "$ref": "#/components/schemas/FilePartSourceText"
  10380. },
  10381. "type": {
  10382. "type": "string",
  10383. "enum": ["file"]
  10384. },
  10385. "path": {
  10386. "type": "string"
  10387. }
  10388. },
  10389. "required": ["text", "type", "path"],
  10390. "additionalProperties": false
  10391. },
  10392. "Range": {
  10393. "type": "object",
  10394. "properties": {
  10395. "start": {
  10396. "type": "object",
  10397. "properties": {
  10398. "line": {
  10399. "type": "integer",
  10400. "minimum": 0
  10401. },
  10402. "character": {
  10403. "type": "integer",
  10404. "minimum": 0
  10405. }
  10406. },
  10407. "required": ["line", "character"],
  10408. "additionalProperties": false
  10409. },
  10410. "end": {
  10411. "type": "object",
  10412. "properties": {
  10413. "line": {
  10414. "type": "integer",
  10415. "minimum": 0
  10416. },
  10417. "character": {
  10418. "type": "integer",
  10419. "minimum": 0
  10420. }
  10421. },
  10422. "required": ["line", "character"],
  10423. "additionalProperties": false
  10424. }
  10425. },
  10426. "required": ["start", "end"],
  10427. "additionalProperties": false
  10428. },
  10429. "SymbolSource": {
  10430. "type": "object",
  10431. "properties": {
  10432. "text": {
  10433. "$ref": "#/components/schemas/FilePartSourceText"
  10434. },
  10435. "type": {
  10436. "type": "string",
  10437. "enum": ["symbol"]
  10438. },
  10439. "path": {
  10440. "type": "string"
  10441. },
  10442. "range": {
  10443. "$ref": "#/components/schemas/Range"
  10444. },
  10445. "name": {
  10446. "type": "string"
  10447. },
  10448. "kind": {
  10449. "type": "integer",
  10450. "minimum": 0
  10451. }
  10452. },
  10453. "required": ["text", "type", "path", "range", "name", "kind"],
  10454. "additionalProperties": false
  10455. },
  10456. "ResourceSource": {
  10457. "type": "object",
  10458. "properties": {
  10459. "text": {
  10460. "$ref": "#/components/schemas/FilePartSourceText"
  10461. },
  10462. "type": {
  10463. "type": "string",
  10464. "enum": ["resource"]
  10465. },
  10466. "clientName": {
  10467. "type": "string"
  10468. },
  10469. "uri": {
  10470. "type": "string"
  10471. }
  10472. },
  10473. "required": ["text", "type", "clientName", "uri"],
  10474. "additionalProperties": false
  10475. },
  10476. "FilePartSource": {
  10477. "anyOf": [
  10478. {
  10479. "$ref": "#/components/schemas/FileSource"
  10480. },
  10481. {
  10482. "$ref": "#/components/schemas/SymbolSource"
  10483. },
  10484. {
  10485. "$ref": "#/components/schemas/ResourceSource"
  10486. }
  10487. ]
  10488. },
  10489. "FilePart": {
  10490. "type": "object",
  10491. "properties": {
  10492. "id": {
  10493. "type": "string",
  10494. "pattern": "^prt"
  10495. },
  10496. "sessionID": {
  10497. "type": "string",
  10498. "pattern": "^ses"
  10499. },
  10500. "messageID": {
  10501. "type": "string",
  10502. "pattern": "^msg"
  10503. },
  10504. "type": {
  10505. "type": "string",
  10506. "enum": ["file"]
  10507. },
  10508. "mime": {
  10509. "type": "string"
  10510. },
  10511. "filename": {
  10512. "type": "string"
  10513. },
  10514. "url": {
  10515. "type": "string"
  10516. },
  10517. "source": {
  10518. "$ref": "#/components/schemas/FilePartSource"
  10519. }
  10520. },
  10521. "required": ["id", "sessionID", "messageID", "type", "mime", "url"],
  10522. "additionalProperties": false
  10523. },
  10524. "ToolStatePending": {
  10525. "type": "object",
  10526. "properties": {
  10527. "status": {
  10528. "type": "string",
  10529. "enum": ["pending"]
  10530. },
  10531. "input": {
  10532. "type": "object"
  10533. },
  10534. "raw": {
  10535. "type": "string"
  10536. }
  10537. },
  10538. "required": ["status", "input", "raw"],
  10539. "additionalProperties": false
  10540. },
  10541. "ToolStateRunning": {
  10542. "type": "object",
  10543. "properties": {
  10544. "status": {
  10545. "type": "string",
  10546. "enum": ["running"]
  10547. },
  10548. "input": {
  10549. "type": "object"
  10550. },
  10551. "title": {
  10552. "type": "string"
  10553. },
  10554. "metadata": {
  10555. "type": "object"
  10556. },
  10557. "time": {
  10558. "type": "object",
  10559. "properties": {
  10560. "start": {
  10561. "type": "integer",
  10562. "minimum": 0
  10563. }
  10564. },
  10565. "required": ["start"],
  10566. "additionalProperties": false
  10567. }
  10568. },
  10569. "required": ["status", "input", "time"],
  10570. "additionalProperties": false
  10571. },
  10572. "ToolStateCompleted": {
  10573. "type": "object",
  10574. "properties": {
  10575. "status": {
  10576. "type": "string",
  10577. "enum": ["completed"]
  10578. },
  10579. "input": {
  10580. "type": "object"
  10581. },
  10582. "output": {
  10583. "type": "string"
  10584. },
  10585. "title": {
  10586. "type": "string"
  10587. },
  10588. "metadata": {
  10589. "type": "object"
  10590. },
  10591. "time": {
  10592. "type": "object",
  10593. "properties": {
  10594. "start": {
  10595. "type": "integer",
  10596. "minimum": 0
  10597. },
  10598. "end": {
  10599. "type": "integer",
  10600. "minimum": 0
  10601. },
  10602. "compacted": {
  10603. "type": "integer",
  10604. "minimum": 0
  10605. }
  10606. },
  10607. "required": ["start", "end"],
  10608. "additionalProperties": false
  10609. },
  10610. "attachments": {
  10611. "type": "array",
  10612. "items": {
  10613. "$ref": "#/components/schemas/FilePart"
  10614. }
  10615. }
  10616. },
  10617. "required": ["status", "input", "output", "title", "metadata", "time"],
  10618. "additionalProperties": false
  10619. },
  10620. "ToolStateError": {
  10621. "type": "object",
  10622. "properties": {
  10623. "status": {
  10624. "type": "string",
  10625. "enum": ["error"]
  10626. },
  10627. "input": {
  10628. "type": "object"
  10629. },
  10630. "error": {
  10631. "type": "string"
  10632. },
  10633. "metadata": {
  10634. "type": "object"
  10635. },
  10636. "time": {
  10637. "type": "object",
  10638. "properties": {
  10639. "start": {
  10640. "type": "integer",
  10641. "minimum": 0
  10642. },
  10643. "end": {
  10644. "type": "integer",
  10645. "minimum": 0
  10646. }
  10647. },
  10648. "required": ["start", "end"],
  10649. "additionalProperties": false
  10650. }
  10651. },
  10652. "required": ["status", "input", "error", "time"],
  10653. "additionalProperties": false
  10654. },
  10655. "ToolState": {
  10656. "anyOf": [
  10657. {
  10658. "$ref": "#/components/schemas/ToolStatePending"
  10659. },
  10660. {
  10661. "$ref": "#/components/schemas/ToolStateRunning"
  10662. },
  10663. {
  10664. "$ref": "#/components/schemas/ToolStateCompleted"
  10665. },
  10666. {
  10667. "$ref": "#/components/schemas/ToolStateError"
  10668. }
  10669. ]
  10670. },
  10671. "ToolPart": {
  10672. "type": "object",
  10673. "properties": {
  10674. "id": {
  10675. "type": "string",
  10676. "pattern": "^prt"
  10677. },
  10678. "sessionID": {
  10679. "type": "string",
  10680. "pattern": "^ses"
  10681. },
  10682. "messageID": {
  10683. "type": "string",
  10684. "pattern": "^msg"
  10685. },
  10686. "type": {
  10687. "type": "string",
  10688. "enum": ["tool"]
  10689. },
  10690. "callID": {
  10691. "type": "string"
  10692. },
  10693. "tool": {
  10694. "type": "string"
  10695. },
  10696. "state": {
  10697. "$ref": "#/components/schemas/ToolState"
  10698. },
  10699. "metadata": {
  10700. "type": "object"
  10701. }
  10702. },
  10703. "required": ["id", "sessionID", "messageID", "type", "callID", "tool", "state"],
  10704. "additionalProperties": false
  10705. },
  10706. "StepStartPart": {
  10707. "type": "object",
  10708. "properties": {
  10709. "id": {
  10710. "type": "string",
  10711. "pattern": "^prt"
  10712. },
  10713. "sessionID": {
  10714. "type": "string",
  10715. "pattern": "^ses"
  10716. },
  10717. "messageID": {
  10718. "type": "string",
  10719. "pattern": "^msg"
  10720. },
  10721. "type": {
  10722. "type": "string",
  10723. "enum": ["step-start"]
  10724. },
  10725. "snapshot": {
  10726. "type": "string"
  10727. }
  10728. },
  10729. "required": ["id", "sessionID", "messageID", "type"],
  10730. "additionalProperties": false
  10731. },
  10732. "StepFinishPart": {
  10733. "type": "object",
  10734. "properties": {
  10735. "id": {
  10736. "type": "string",
  10737. "pattern": "^prt"
  10738. },
  10739. "sessionID": {
  10740. "type": "string",
  10741. "pattern": "^ses"
  10742. },
  10743. "messageID": {
  10744. "type": "string",
  10745. "pattern": "^msg"
  10746. },
  10747. "type": {
  10748. "type": "string",
  10749. "enum": ["step-finish"]
  10750. },
  10751. "reason": {
  10752. "type": "string"
  10753. },
  10754. "snapshot": {
  10755. "type": "string"
  10756. },
  10757. "cost": {
  10758. "type": "number"
  10759. },
  10760. "tokens": {
  10761. "type": "object",
  10762. "properties": {
  10763. "total": {
  10764. "type": "number"
  10765. },
  10766. "input": {
  10767. "type": "number"
  10768. },
  10769. "output": {
  10770. "type": "number"
  10771. },
  10772. "reasoning": {
  10773. "type": "number"
  10774. },
  10775. "cache": {
  10776. "type": "object",
  10777. "properties": {
  10778. "read": {
  10779. "type": "number"
  10780. },
  10781. "write": {
  10782. "type": "number"
  10783. }
  10784. },
  10785. "required": ["read", "write"],
  10786. "additionalProperties": false
  10787. }
  10788. },
  10789. "required": ["input", "output", "reasoning", "cache"],
  10790. "additionalProperties": false
  10791. }
  10792. },
  10793. "required": ["id", "sessionID", "messageID", "type", "reason", "cost", "tokens"],
  10794. "additionalProperties": false
  10795. },
  10796. "SnapshotPart": {
  10797. "type": "object",
  10798. "properties": {
  10799. "id": {
  10800. "type": "string",
  10801. "pattern": "^prt"
  10802. },
  10803. "sessionID": {
  10804. "type": "string",
  10805. "pattern": "^ses"
  10806. },
  10807. "messageID": {
  10808. "type": "string",
  10809. "pattern": "^msg"
  10810. },
  10811. "type": {
  10812. "type": "string",
  10813. "enum": ["snapshot"]
  10814. },
  10815. "snapshot": {
  10816. "type": "string"
  10817. }
  10818. },
  10819. "required": ["id", "sessionID", "messageID", "type", "snapshot"],
  10820. "additionalProperties": false
  10821. },
  10822. "PatchPart": {
  10823. "type": "object",
  10824. "properties": {
  10825. "id": {
  10826. "type": "string",
  10827. "pattern": "^prt"
  10828. },
  10829. "sessionID": {
  10830. "type": "string",
  10831. "pattern": "^ses"
  10832. },
  10833. "messageID": {
  10834. "type": "string",
  10835. "pattern": "^msg"
  10836. },
  10837. "type": {
  10838. "type": "string",
  10839. "enum": ["patch"]
  10840. },
  10841. "hash": {
  10842. "type": "string"
  10843. },
  10844. "files": {
  10845. "type": "array",
  10846. "items": {
  10847. "type": "string"
  10848. }
  10849. }
  10850. },
  10851. "required": ["id", "sessionID", "messageID", "type", "hash", "files"],
  10852. "additionalProperties": false
  10853. },
  10854. "AgentPart": {
  10855. "type": "object",
  10856. "properties": {
  10857. "id": {
  10858. "type": "string",
  10859. "pattern": "^prt"
  10860. },
  10861. "sessionID": {
  10862. "type": "string",
  10863. "pattern": "^ses"
  10864. },
  10865. "messageID": {
  10866. "type": "string",
  10867. "pattern": "^msg"
  10868. },
  10869. "type": {
  10870. "type": "string",
  10871. "enum": ["agent"]
  10872. },
  10873. "name": {
  10874. "type": "string"
  10875. },
  10876. "source": {
  10877. "type": "object",
  10878. "properties": {
  10879. "value": {
  10880. "type": "string"
  10881. },
  10882. "start": {
  10883. "type": "integer",
  10884. "minimum": 0
  10885. },
  10886. "end": {
  10887. "type": "integer",
  10888. "minimum": 0
  10889. }
  10890. },
  10891. "required": ["value", "start", "end"],
  10892. "additionalProperties": false
  10893. }
  10894. },
  10895. "required": ["id", "sessionID", "messageID", "type", "name"],
  10896. "additionalProperties": false
  10897. },
  10898. "RetryPart": {
  10899. "type": "object",
  10900. "properties": {
  10901. "id": {
  10902. "type": "string",
  10903. "pattern": "^prt"
  10904. },
  10905. "sessionID": {
  10906. "type": "string",
  10907. "pattern": "^ses"
  10908. },
  10909. "messageID": {
  10910. "type": "string",
  10911. "pattern": "^msg"
  10912. },
  10913. "type": {
  10914. "type": "string",
  10915. "enum": ["retry"]
  10916. },
  10917. "attempt": {
  10918. "type": "integer",
  10919. "minimum": 0
  10920. },
  10921. "error": {
  10922. "$ref": "#/components/schemas/APIError"
  10923. },
  10924. "time": {
  10925. "type": "object",
  10926. "properties": {
  10927. "created": {
  10928. "type": "integer",
  10929. "minimum": 0
  10930. }
  10931. },
  10932. "required": ["created"],
  10933. "additionalProperties": false
  10934. }
  10935. },
  10936. "required": ["id", "sessionID", "messageID", "type", "attempt", "error", "time"],
  10937. "additionalProperties": false
  10938. },
  10939. "CompactionPart": {
  10940. "type": "object",
  10941. "properties": {
  10942. "id": {
  10943. "type": "string",
  10944. "pattern": "^prt"
  10945. },
  10946. "sessionID": {
  10947. "type": "string",
  10948. "pattern": "^ses"
  10949. },
  10950. "messageID": {
  10951. "type": "string",
  10952. "pattern": "^msg"
  10953. },
  10954. "type": {
  10955. "type": "string",
  10956. "enum": ["compaction"]
  10957. },
  10958. "auto": {
  10959. "type": "boolean"
  10960. },
  10961. "overflow": {
  10962. "type": "boolean"
  10963. },
  10964. "tail_start_id": {
  10965. "type": "string",
  10966. "pattern": "^msg"
  10967. }
  10968. },
  10969. "required": ["id", "sessionID", "messageID", "type", "auto"],
  10970. "additionalProperties": false
  10971. },
  10972. "Part": {
  10973. "anyOf": [
  10974. {
  10975. "$ref": "#/components/schemas/TextPart"
  10976. },
  10977. {
  10978. "$ref": "#/components/schemas/SubtaskPart"
  10979. },
  10980. {
  10981. "$ref": "#/components/schemas/ReasoningPart"
  10982. },
  10983. {
  10984. "$ref": "#/components/schemas/FilePart"
  10985. },
  10986. {
  10987. "$ref": "#/components/schemas/ToolPart"
  10988. },
  10989. {
  10990. "$ref": "#/components/schemas/StepStartPart"
  10991. },
  10992. {
  10993. "$ref": "#/components/schemas/StepFinishPart"
  10994. },
  10995. {
  10996. "$ref": "#/components/schemas/SnapshotPart"
  10997. },
  10998. {
  10999. "$ref": "#/components/schemas/PatchPart"
  11000. },
  11001. {
  11002. "$ref": "#/components/schemas/AgentPart"
  11003. },
  11004. {
  11005. "$ref": "#/components/schemas/RetryPart"
  11006. },
  11007. {
  11008. "$ref": "#/components/schemas/CompactionPart"
  11009. }
  11010. ]
  11011. },
  11012. "PermissionAction": {
  11013. "type": "string",
  11014. "enum": ["allow", "deny", "ask"]
  11015. },
  11016. "PermissionRule": {
  11017. "type": "object",
  11018. "properties": {
  11019. "permission": {
  11020. "type": "string"
  11021. },
  11022. "pattern": {
  11023. "type": "string"
  11024. },
  11025. "action": {
  11026. "$ref": "#/components/schemas/PermissionAction"
  11027. }
  11028. },
  11029. "required": ["permission", "pattern", "action"],
  11030. "additionalProperties": false
  11031. },
  11032. "PermissionRuleset": {
  11033. "type": "array",
  11034. "items": {
  11035. "$ref": "#/components/schemas/PermissionRule"
  11036. }
  11037. },
  11038. "Session": {
  11039. "type": "object",
  11040. "properties": {
  11041. "id": {
  11042. "type": "string",
  11043. "pattern": "^ses"
  11044. },
  11045. "slug": {
  11046. "type": "string"
  11047. },
  11048. "projectID": {
  11049. "type": "string"
  11050. },
  11051. "workspaceID": {
  11052. "type": "string",
  11053. "pattern": "^wrk"
  11054. },
  11055. "directory": {
  11056. "type": "string"
  11057. },
  11058. "path": {
  11059. "type": "string"
  11060. },
  11061. "parentID": {
  11062. "type": "string",
  11063. "pattern": "^ses"
  11064. },
  11065. "summary": {
  11066. "type": "object",
  11067. "properties": {
  11068. "additions": {
  11069. "type": "number"
  11070. },
  11071. "deletions": {
  11072. "type": "number"
  11073. },
  11074. "files": {
  11075. "type": "number"
  11076. },
  11077. "diffs": {
  11078. "type": "array",
  11079. "items": {
  11080. "$ref": "#/components/schemas/SnapshotFileDiff"
  11081. }
  11082. }
  11083. },
  11084. "required": ["additions", "deletions", "files"],
  11085. "additionalProperties": false
  11086. },
  11087. "cost": {
  11088. "type": "number"
  11089. },
  11090. "tokens": {
  11091. "type": "object",
  11092. "properties": {
  11093. "input": {
  11094. "type": "number"
  11095. },
  11096. "output": {
  11097. "type": "number"
  11098. },
  11099. "reasoning": {
  11100. "type": "number"
  11101. },
  11102. "cache": {
  11103. "type": "object",
  11104. "properties": {
  11105. "read": {
  11106. "type": "number"
  11107. },
  11108. "write": {
  11109. "type": "number"
  11110. }
  11111. },
  11112. "required": ["read", "write"],
  11113. "additionalProperties": false
  11114. }
  11115. },
  11116. "required": ["input", "output", "reasoning", "cache"],
  11117. "additionalProperties": false
  11118. },
  11119. "share": {
  11120. "type": "object",
  11121. "properties": {
  11122. "url": {
  11123. "type": "string"
  11124. }
  11125. },
  11126. "required": ["url"],
  11127. "additionalProperties": false
  11128. },
  11129. "title": {
  11130. "type": "string"
  11131. },
  11132. "agent": {
  11133. "type": "string"
  11134. },
  11135. "model": {
  11136. "type": "object",
  11137. "properties": {
  11138. "id": {
  11139. "type": "string"
  11140. },
  11141. "providerID": {
  11142. "type": "string"
  11143. },
  11144. "variant": {
  11145. "type": "string"
  11146. }
  11147. },
  11148. "required": ["id", "providerID"],
  11149. "additionalProperties": false
  11150. },
  11151. "version": {
  11152. "type": "string"
  11153. },
  11154. "time": {
  11155. "type": "object",
  11156. "properties": {
  11157. "created": {
  11158. "type": "integer",
  11159. "minimum": 0
  11160. },
  11161. "updated": {
  11162. "type": "integer",
  11163. "minimum": 0
  11164. },
  11165. "compacting": {
  11166. "type": "integer",
  11167. "minimum": 0
  11168. },
  11169. "archived": {
  11170. "type": "number"
  11171. }
  11172. },
  11173. "required": ["created", "updated"],
  11174. "additionalProperties": false
  11175. },
  11176. "permission": {
  11177. "$ref": "#/components/schemas/PermissionRuleset"
  11178. },
  11179. "revert": {
  11180. "type": "object",
  11181. "properties": {
  11182. "messageID": {
  11183. "type": "string",
  11184. "pattern": "^msg"
  11185. },
  11186. "partID": {
  11187. "type": "string",
  11188. "pattern": "^prt"
  11189. },
  11190. "snapshot": {
  11191. "type": "string"
  11192. },
  11193. "diff": {
  11194. "type": "string"
  11195. }
  11196. },
  11197. "required": ["messageID"],
  11198. "additionalProperties": false
  11199. }
  11200. },
  11201. "required": ["id", "slug", "projectID", "directory", "title", "version", "time"],
  11202. "additionalProperties": false
  11203. },
  11204. "Prompt": {
  11205. "type": "object",
  11206. "properties": {
  11207. "text": {
  11208. "type": "string"
  11209. },
  11210. "files": {
  11211. "type": "array",
  11212. "items": {
  11213. "$ref": "#/components/schemas/PromptFileAttachment"
  11214. }
  11215. },
  11216. "agents": {
  11217. "type": "array",
  11218. "items": {
  11219. "$ref": "#/components/schemas/PromptAgentAttachment"
  11220. }
  11221. },
  11222. "references": {
  11223. "type": "array",
  11224. "items": {
  11225. "$ref": "#/components/schemas/PromptReferenceAttachment"
  11226. }
  11227. }
  11228. },
  11229. "required": ["text"],
  11230. "additionalProperties": false
  11231. },
  11232. "GlobalEvent": {
  11233. "type": "object",
  11234. "properties": {
  11235. "directory": {
  11236. "type": "string"
  11237. },
  11238. "project": {
  11239. "type": "string"
  11240. },
  11241. "workspace": {
  11242. "type": "string"
  11243. },
  11244. "payload": {
  11245. "anyOf": [
  11246. {
  11247. "$ref": "#/components/schemas/EventServerInstanceDisposed"
  11248. },
  11249. {
  11250. "$ref": "#/components/schemas/EventFileEdited"
  11251. },
  11252. {
  11253. "$ref": "#/components/schemas/EventFileWatcherUpdated"
  11254. },
  11255. {
  11256. "$ref": "#/components/schemas/EventLspClientDiagnostics"
  11257. },
  11258. {
  11259. "$ref": "#/components/schemas/EventLspUpdated"
  11260. },
  11261. {
  11262. "$ref": "#/components/schemas/EventMessagePartDelta"
  11263. },
  11264. {
  11265. "$ref": "#/components/schemas/EventPermissionAsked"
  11266. },
  11267. {
  11268. "$ref": "#/components/schemas/EventPermissionReplied"
  11269. },
  11270. {
  11271. "$ref": "#/components/schemas/EventSessionDiff"
  11272. },
  11273. {
  11274. "$ref": "#/components/schemas/EventSessionError"
  11275. },
  11276. {
  11277. "$ref": "#/components/schemas/EventQuestionAsked"
  11278. },
  11279. {
  11280. "$ref": "#/components/schemas/EventQuestionReplied"
  11281. },
  11282. {
  11283. "$ref": "#/components/schemas/EventQuestionRejected"
  11284. },
  11285. {
  11286. "$ref": "#/components/schemas/EventTodoUpdated"
  11287. },
  11288. {
  11289. "$ref": "#/components/schemas/EventSessionStatus"
  11290. },
  11291. {
  11292. "$ref": "#/components/schemas/EventSessionIdle"
  11293. },
  11294. {
  11295. "$ref": "#/components/schemas/EventSessionCompacted"
  11296. },
  11297. {
  11298. "$ref": "#/components/schemas/Event.tui.prompt.append"
  11299. },
  11300. {
  11301. "$ref": "#/components/schemas/Event.tui.command.execute"
  11302. },
  11303. {
  11304. "$ref": "#/components/schemas/Event.tui.toast.show"
  11305. },
  11306. {
  11307. "$ref": "#/components/schemas/Event.tui.session.select"
  11308. },
  11309. {
  11310. "$ref": "#/components/schemas/EventMcpToolsChanged"
  11311. },
  11312. {
  11313. "$ref": "#/components/schemas/EventMcpBrowserOpenFailed"
  11314. },
  11315. {
  11316. "$ref": "#/components/schemas/EventCommandExecuted"
  11317. },
  11318. {
  11319. "$ref": "#/components/schemas/EventProjectUpdated"
  11320. },
  11321. {
  11322. "$ref": "#/components/schemas/EventVcsBranchUpdated"
  11323. },
  11324. {
  11325. "$ref": "#/components/schemas/EventWorkspaceReady"
  11326. },
  11327. {
  11328. "$ref": "#/components/schemas/EventWorkspaceFailed"
  11329. },
  11330. {
  11331. "$ref": "#/components/schemas/EventWorkspaceStatus"
  11332. },
  11333. {
  11334. "$ref": "#/components/schemas/EventWorktreeReady"
  11335. },
  11336. {
  11337. "$ref": "#/components/schemas/EventWorktreeFailed"
  11338. },
  11339. {
  11340. "$ref": "#/components/schemas/EventPtyCreated"
  11341. },
  11342. {
  11343. "$ref": "#/components/schemas/EventPtyUpdated"
  11344. },
  11345. {
  11346. "$ref": "#/components/schemas/EventPtyExited"
  11347. },
  11348. {
  11349. "$ref": "#/components/schemas/EventPtyDeleted"
  11350. },
  11351. {
  11352. "$ref": "#/components/schemas/EventInstallationUpdated"
  11353. },
  11354. {
  11355. "$ref": "#/components/schemas/EventInstallationUpdate-available"
  11356. },
  11357. {
  11358. "$ref": "#/components/schemas/EventServerConnected"
  11359. },
  11360. {
  11361. "$ref": "#/components/schemas/EventGlobalDisposed"
  11362. },
  11363. {
  11364. "$ref": "#/components/schemas/SyncEventMessageUpdated"
  11365. },
  11366. {
  11367. "$ref": "#/components/schemas/SyncEventMessageRemoved"
  11368. },
  11369. {
  11370. "$ref": "#/components/schemas/SyncEventMessagePartUpdated"
  11371. },
  11372. {
  11373. "$ref": "#/components/schemas/SyncEventMessagePartRemoved"
  11374. },
  11375. {
  11376. "$ref": "#/components/schemas/SyncEventSessionCreated"
  11377. },
  11378. {
  11379. "$ref": "#/components/schemas/SyncEventSessionUpdated"
  11380. },
  11381. {
  11382. "$ref": "#/components/schemas/SyncEventSessionDeleted"
  11383. },
  11384. {
  11385. "$ref": "#/components/schemas/SyncEventSessionNextAgentSwitched"
  11386. },
  11387. {
  11388. "$ref": "#/components/schemas/SyncEventSessionNextModelSwitched"
  11389. },
  11390. {
  11391. "$ref": "#/components/schemas/SyncEventSessionNextPrompted"
  11392. },
  11393. {
  11394. "$ref": "#/components/schemas/SyncEventSessionNextSynthetic"
  11395. },
  11396. {
  11397. "$ref": "#/components/schemas/SyncEventSessionNextShellStarted"
  11398. },
  11399. {
  11400. "$ref": "#/components/schemas/SyncEventSessionNextShellEnded"
  11401. },
  11402. {
  11403. "$ref": "#/components/schemas/SyncEventSessionNextStepStarted"
  11404. },
  11405. {
  11406. "$ref": "#/components/schemas/SyncEventSessionNextStepEnded"
  11407. },
  11408. {
  11409. "$ref": "#/components/schemas/SyncEventSessionNextStepFailed"
  11410. },
  11411. {
  11412. "$ref": "#/components/schemas/SyncEventSessionNextTextStarted"
  11413. },
  11414. {
  11415. "$ref": "#/components/schemas/SyncEventSessionNextTextDelta"
  11416. },
  11417. {
  11418. "$ref": "#/components/schemas/SyncEventSessionNextTextEnded"
  11419. },
  11420. {
  11421. "$ref": "#/components/schemas/SyncEventSessionNextReasoningStarted"
  11422. },
  11423. {
  11424. "$ref": "#/components/schemas/SyncEventSessionNextReasoningDelta"
  11425. },
  11426. {
  11427. "$ref": "#/components/schemas/SyncEventSessionNextReasoningEnded"
  11428. },
  11429. {
  11430. "$ref": "#/components/schemas/SyncEventSessionNextToolInputStarted"
  11431. },
  11432. {
  11433. "$ref": "#/components/schemas/SyncEventSessionNextToolInputDelta"
  11434. },
  11435. {
  11436. "$ref": "#/components/schemas/SyncEventSessionNextToolInputEnded"
  11437. },
  11438. {
  11439. "$ref": "#/components/schemas/SyncEventSessionNextToolCalled"
  11440. },
  11441. {
  11442. "$ref": "#/components/schemas/SyncEventSessionNextToolProgress"
  11443. },
  11444. {
  11445. "$ref": "#/components/schemas/SyncEventSessionNextToolSuccess"
  11446. },
  11447. {
  11448. "$ref": "#/components/schemas/SyncEventSessionNextToolFailed"
  11449. },
  11450. {
  11451. "$ref": "#/components/schemas/SyncEventSessionNextRetried"
  11452. },
  11453. {
  11454. "$ref": "#/components/schemas/SyncEventSessionNextCompactionStarted"
  11455. },
  11456. {
  11457. "$ref": "#/components/schemas/SyncEventSessionNextCompactionDelta"
  11458. },
  11459. {
  11460. "$ref": "#/components/schemas/SyncEventSessionNextCompactionEnded"
  11461. }
  11462. ]
  11463. }
  11464. },
  11465. "required": ["directory", "payload"],
  11466. "additionalProperties": false
  11467. },
  11468. "LogLevel": {
  11469. "type": "string",
  11470. "enum": ["DEBUG", "INFO", "WARN", "ERROR"],
  11471. "description": "Log level"
  11472. },
  11473. "ServerConfig": {
  11474. "type": "object",
  11475. "properties": {
  11476. "port": {
  11477. "type": "integer",
  11478. "exclusiveMinimum": 0
  11479. },
  11480. "hostname": {
  11481. "type": "string"
  11482. },
  11483. "mdns": {
  11484. "type": "boolean"
  11485. },
  11486. "mdnsDomain": {
  11487. "type": "string"
  11488. },
  11489. "cors": {
  11490. "type": "array",
  11491. "items": {
  11492. "type": "string"
  11493. }
  11494. }
  11495. },
  11496. "additionalProperties": false,
  11497. "description": "Server configuration for opencode serve and web commands"
  11498. },
  11499. "ReferenceConfigEntry": {
  11500. "anyOf": [
  11501. {
  11502. "type": "string"
  11503. },
  11504. {
  11505. "type": "object",
  11506. "properties": {
  11507. "repository": {
  11508. "type": "string",
  11509. "description": "Git repository URL, host/path reference, or GitHub owner/repo shorthand"
  11510. },
  11511. "branch": {
  11512. "type": "string"
  11513. }
  11514. },
  11515. "required": ["repository"],
  11516. "additionalProperties": false
  11517. },
  11518. {
  11519. "type": "object",
  11520. "properties": {
  11521. "path": {
  11522. "type": "string",
  11523. "description": "Absolute path, ~/ path, or workspace-relative path to a local reference directory"
  11524. }
  11525. },
  11526. "required": ["path"],
  11527. "additionalProperties": false
  11528. }
  11529. ]
  11530. },
  11531. "ReferenceConfig": {
  11532. "type": "object",
  11533. "additionalProperties": {
  11534. "$ref": "#/components/schemas/ReferenceConfigEntry"
  11535. }
  11536. },
  11537. "PermissionActionConfig": {
  11538. "type": "string",
  11539. "enum": ["ask", "allow", "deny"]
  11540. },
  11541. "PermissionObjectConfig": {
  11542. "type": "object",
  11543. "additionalProperties": {
  11544. "$ref": "#/components/schemas/PermissionActionConfig"
  11545. }
  11546. },
  11547. "PermissionRuleConfig": {
  11548. "anyOf": [
  11549. {
  11550. "$ref": "#/components/schemas/PermissionActionConfig"
  11551. },
  11552. {
  11553. "$ref": "#/components/schemas/PermissionObjectConfig"
  11554. }
  11555. ]
  11556. },
  11557. "PermissionConfig": {
  11558. "anyOf": [
  11559. {
  11560. "$ref": "#/components/schemas/PermissionActionConfig"
  11561. },
  11562. {
  11563. "type": "object",
  11564. "properties": {
  11565. "read": {
  11566. "$ref": "#/components/schemas/PermissionRuleConfig"
  11567. },
  11568. "edit": {
  11569. "$ref": "#/components/schemas/PermissionRuleConfig"
  11570. },
  11571. "glob": {
  11572. "$ref": "#/components/schemas/PermissionRuleConfig"
  11573. },
  11574. "grep": {
  11575. "$ref": "#/components/schemas/PermissionRuleConfig"
  11576. },
  11577. "list": {
  11578. "$ref": "#/components/schemas/PermissionRuleConfig"
  11579. },
  11580. "bash": {
  11581. "$ref": "#/components/schemas/PermissionRuleConfig"
  11582. },
  11583. "task": {
  11584. "$ref": "#/components/schemas/PermissionRuleConfig"
  11585. },
  11586. "external_directory": {
  11587. "$ref": "#/components/schemas/PermissionRuleConfig"
  11588. },
  11589. "todowrite": {
  11590. "$ref": "#/components/schemas/PermissionActionConfig"
  11591. },
  11592. "question": {
  11593. "$ref": "#/components/schemas/PermissionActionConfig"
  11594. },
  11595. "webfetch": {
  11596. "$ref": "#/components/schemas/PermissionActionConfig"
  11597. },
  11598. "websearch": {
  11599. "$ref": "#/components/schemas/PermissionActionConfig"
  11600. },
  11601. "repo_clone": {
  11602. "$ref": "#/components/schemas/PermissionRuleConfig"
  11603. },
  11604. "repo_overview": {
  11605. "$ref": "#/components/schemas/PermissionRuleConfig"
  11606. },
  11607. "lsp": {
  11608. "$ref": "#/components/schemas/PermissionRuleConfig"
  11609. },
  11610. "doom_loop": {
  11611. "$ref": "#/components/schemas/PermissionActionConfig"
  11612. },
  11613. "skill": {
  11614. "$ref": "#/components/schemas/PermissionRuleConfig"
  11615. }
  11616. },
  11617. "additionalProperties": {
  11618. "$ref": "#/components/schemas/PermissionRuleConfig"
  11619. }
  11620. }
  11621. ]
  11622. },
  11623. "AgentConfig": {
  11624. "type": "object",
  11625. "properties": {
  11626. "model": {
  11627. "type": "string"
  11628. },
  11629. "variant": {
  11630. "type": "string"
  11631. },
  11632. "temperature": {
  11633. "type": "number"
  11634. },
  11635. "top_p": {
  11636. "type": "number"
  11637. },
  11638. "prompt": {
  11639. "type": "string"
  11640. },
  11641. "tools": {
  11642. "type": "object",
  11643. "additionalProperties": {
  11644. "type": "boolean"
  11645. }
  11646. },
  11647. "disable": {
  11648. "type": "boolean"
  11649. },
  11650. "description": {
  11651. "type": "string"
  11652. },
  11653. "mode": {
  11654. "type": "string",
  11655. "enum": ["subagent", "primary", "all"]
  11656. },
  11657. "hidden": {
  11658. "type": "boolean"
  11659. },
  11660. "options": {
  11661. "type": "object"
  11662. },
  11663. "color": {
  11664. "anyOf": [
  11665. {
  11666. "type": "string",
  11667. "pattern": "^#[0-9a-fA-F]{6}$"
  11668. },
  11669. {
  11670. "type": "string",
  11671. "enum": ["primary", "secondary", "accent", "success", "warning", "error", "info"]
  11672. }
  11673. ],
  11674. "description": "Hex color code (e.g., #FF5733) or theme color (e.g., primary)"
  11675. },
  11676. "steps": {
  11677. "type": "integer",
  11678. "exclusiveMinimum": 0
  11679. },
  11680. "maxSteps": {
  11681. "type": "integer",
  11682. "exclusiveMinimum": 0
  11683. },
  11684. "permission": {
  11685. "$ref": "#/components/schemas/PermissionConfig"
  11686. }
  11687. },
  11688. "additionalProperties": {}
  11689. },
  11690. "ProviderConfig": {
  11691. "type": "object",
  11692. "properties": {
  11693. "api": {
  11694. "type": "string"
  11695. },
  11696. "name": {
  11697. "type": "string"
  11698. },
  11699. "env": {
  11700. "type": "array",
  11701. "items": {
  11702. "type": "string"
  11703. }
  11704. },
  11705. "id": {
  11706. "type": "string"
  11707. },
  11708. "npm": {
  11709. "type": "string"
  11710. },
  11711. "whitelist": {
  11712. "type": "array",
  11713. "items": {
  11714. "type": "string"
  11715. }
  11716. },
  11717. "blacklist": {
  11718. "type": "array",
  11719. "items": {
  11720. "type": "string"
  11721. }
  11722. },
  11723. "options": {
  11724. "type": "object",
  11725. "properties": {
  11726. "apiKey": {
  11727. "type": "string"
  11728. },
  11729. "baseURL": {
  11730. "type": "string"
  11731. },
  11732. "enterpriseUrl": {
  11733. "type": "string"
  11734. },
  11735. "setCacheKey": {
  11736. "type": "boolean"
  11737. },
  11738. "timeout": {
  11739. "anyOf": [
  11740. {
  11741. "type": "integer",
  11742. "exclusiveMinimum": 0
  11743. },
  11744. {
  11745. "type": "boolean",
  11746. "enum": [false]
  11747. }
  11748. ],
  11749. "description": "Timeout in milliseconds for requests to this provider. Default is 300000 (5 minutes). Set to false to disable timeout."
  11750. },
  11751. "chunkTimeout": {
  11752. "type": "integer",
  11753. "exclusiveMinimum": 0
  11754. }
  11755. },
  11756. "additionalProperties": {}
  11757. },
  11758. "models": {
  11759. "type": "object",
  11760. "additionalProperties": {
  11761. "type": "object",
  11762. "properties": {
  11763. "id": {
  11764. "type": "string"
  11765. },
  11766. "name": {
  11767. "type": "string"
  11768. },
  11769. "family": {
  11770. "type": "string"
  11771. },
  11772. "release_date": {
  11773. "type": "string"
  11774. },
  11775. "attachment": {
  11776. "type": "boolean"
  11777. },
  11778. "reasoning": {
  11779. "type": "boolean"
  11780. },
  11781. "temperature": {
  11782. "type": "boolean"
  11783. },
  11784. "tool_call": {
  11785. "type": "boolean"
  11786. },
  11787. "interleaved": {
  11788. "anyOf": [
  11789. {
  11790. "type": "boolean",
  11791. "enum": [true]
  11792. },
  11793. {
  11794. "type": "object",
  11795. "properties": {
  11796. "field": {
  11797. "type": "string",
  11798. "enum": ["reasoning_content", "reasoning_details"]
  11799. }
  11800. },
  11801. "required": ["field"],
  11802. "additionalProperties": false
  11803. }
  11804. ]
  11805. },
  11806. "cost": {
  11807. "type": "object",
  11808. "properties": {
  11809. "input": {
  11810. "type": "number"
  11811. },
  11812. "output": {
  11813. "type": "number"
  11814. },
  11815. "cache_read": {
  11816. "type": "number"
  11817. },
  11818. "cache_write": {
  11819. "type": "number"
  11820. },
  11821. "context_over_200k": {
  11822. "type": "object",
  11823. "properties": {
  11824. "input": {
  11825. "type": "number"
  11826. },
  11827. "output": {
  11828. "type": "number"
  11829. },
  11830. "cache_read": {
  11831. "type": "number"
  11832. },
  11833. "cache_write": {
  11834. "type": "number"
  11835. }
  11836. },
  11837. "required": ["input", "output"],
  11838. "additionalProperties": false
  11839. }
  11840. },
  11841. "required": ["input", "output"],
  11842. "additionalProperties": false
  11843. },
  11844. "limit": {
  11845. "type": "object",
  11846. "properties": {
  11847. "context": {
  11848. "type": "number"
  11849. },
  11850. "input": {
  11851. "type": "number"
  11852. },
  11853. "output": {
  11854. "type": "number"
  11855. }
  11856. },
  11857. "required": ["context", "output"],
  11858. "additionalProperties": false
  11859. },
  11860. "modalities": {
  11861. "type": "object",
  11862. "properties": {
  11863. "input": {
  11864. "type": "array",
  11865. "items": {
  11866. "type": "string",
  11867. "enum": ["text", "audio", "image", "video", "pdf"]
  11868. }
  11869. },
  11870. "output": {
  11871. "type": "array",
  11872. "items": {
  11873. "type": "string",
  11874. "enum": ["text", "audio", "image", "video", "pdf"]
  11875. }
  11876. }
  11877. },
  11878. "required": ["input", "output"],
  11879. "additionalProperties": false
  11880. },
  11881. "experimental": {
  11882. "type": "boolean"
  11883. },
  11884. "status": {
  11885. "type": "string",
  11886. "enum": ["alpha", "beta", "deprecated", "active"]
  11887. },
  11888. "provider": {
  11889. "type": "object",
  11890. "properties": {
  11891. "npm": {
  11892. "type": "string"
  11893. },
  11894. "api": {
  11895. "type": "string"
  11896. }
  11897. },
  11898. "additionalProperties": false
  11899. },
  11900. "options": {
  11901. "type": "object"
  11902. },
  11903. "headers": {
  11904. "type": "object",
  11905. "additionalProperties": {
  11906. "type": "string"
  11907. }
  11908. },
  11909. "variants": {
  11910. "type": "object",
  11911. "additionalProperties": {
  11912. "type": "object",
  11913. "properties": {
  11914. "disabled": {
  11915. "type": "boolean"
  11916. }
  11917. },
  11918. "additionalProperties": {}
  11919. },
  11920. "description": "Variant-specific configuration"
  11921. }
  11922. },
  11923. "additionalProperties": false
  11924. }
  11925. }
  11926. },
  11927. "additionalProperties": false
  11928. },
  11929. "McpLocalConfig": {
  11930. "type": "object",
  11931. "properties": {
  11932. "type": {
  11933. "type": "string",
  11934. "enum": ["local"],
  11935. "description": "Type of MCP server connection"
  11936. },
  11937. "command": {
  11938. "type": "array",
  11939. "items": {
  11940. "type": "string"
  11941. },
  11942. "description": "Command and arguments to run the MCP server"
  11943. },
  11944. "environment": {
  11945. "type": "object",
  11946. "additionalProperties": {
  11947. "type": "string"
  11948. }
  11949. },
  11950. "enabled": {
  11951. "type": "boolean"
  11952. },
  11953. "timeout": {
  11954. "type": "integer",
  11955. "exclusiveMinimum": 0
  11956. }
  11957. },
  11958. "required": ["type", "command"],
  11959. "additionalProperties": false
  11960. },
  11961. "McpOAuthConfig": {
  11962. "type": "object",
  11963. "properties": {
  11964. "clientId": {
  11965. "type": "string"
  11966. },
  11967. "clientSecret": {
  11968. "type": "string"
  11969. },
  11970. "scope": {
  11971. "type": "string"
  11972. },
  11973. "redirectUri": {
  11974. "type": "string"
  11975. }
  11976. },
  11977. "additionalProperties": false
  11978. },
  11979. "McpRemoteConfig": {
  11980. "type": "object",
  11981. "properties": {
  11982. "type": {
  11983. "type": "string",
  11984. "enum": ["remote"],
  11985. "description": "Type of MCP server connection"
  11986. },
  11987. "url": {
  11988. "type": "string",
  11989. "description": "URL of the remote MCP server"
  11990. },
  11991. "enabled": {
  11992. "type": "boolean"
  11993. },
  11994. "headers": {
  11995. "type": "object",
  11996. "additionalProperties": {
  11997. "type": "string"
  11998. }
  11999. },
  12000. "oauth": {
  12001. "anyOf": [
  12002. {
  12003. "$ref": "#/components/schemas/McpOAuthConfig"
  12004. },
  12005. {
  12006. "type": "boolean",
  12007. "enum": [false]
  12008. }
  12009. ],
  12010. "description": "OAuth authentication configuration for the MCP server. Set to false to disable OAuth auto-detection."
  12011. },
  12012. "timeout": {
  12013. "type": "integer",
  12014. "exclusiveMinimum": 0
  12015. }
  12016. },
  12017. "required": ["type", "url"],
  12018. "additionalProperties": false
  12019. },
  12020. "LayoutConfig": {
  12021. "type": "string",
  12022. "enum": ["auto", "stretch"],
  12023. "description": "@deprecated Always uses stretch layout."
  12024. },
  12025. "ImageAttachmentConfig": {
  12026. "type": "object",
  12027. "properties": {
  12028. "auto_resize": {
  12029. "type": "boolean"
  12030. },
  12031. "max_width": {
  12032. "type": "integer",
  12033. "exclusiveMinimum": 0
  12034. },
  12035. "max_height": {
  12036. "type": "integer",
  12037. "exclusiveMinimum": 0
  12038. },
  12039. "max_base64_bytes": {
  12040. "type": "integer",
  12041. "exclusiveMinimum": 0
  12042. }
  12043. },
  12044. "additionalProperties": false
  12045. },
  12046. "AttachmentConfig": {
  12047. "type": "object",
  12048. "properties": {
  12049. "image": {
  12050. "$ref": "#/components/schemas/ImageAttachmentConfig"
  12051. }
  12052. },
  12053. "additionalProperties": false
  12054. },
  12055. "Config": {
  12056. "type": "object",
  12057. "properties": {
  12058. "$schema": {
  12059. "type": "string"
  12060. },
  12061. "shell": {
  12062. "type": "string"
  12063. },
  12064. "logLevel": {
  12065. "$ref": "#/components/schemas/LogLevel"
  12066. },
  12067. "server": {
  12068. "$ref": "#/components/schemas/ServerConfig"
  12069. },
  12070. "command": {
  12071. "type": "object",
  12072. "additionalProperties": {
  12073. "type": "object",
  12074. "properties": {
  12075. "template": {
  12076. "type": "string"
  12077. },
  12078. "description": {
  12079. "type": "string"
  12080. },
  12081. "agent": {
  12082. "type": "string"
  12083. },
  12084. "model": {
  12085. "type": "string"
  12086. },
  12087. "subtask": {
  12088. "type": "boolean"
  12089. }
  12090. },
  12091. "required": ["template"],
  12092. "additionalProperties": false
  12093. }
  12094. },
  12095. "skills": {
  12096. "type": "object",
  12097. "properties": {
  12098. "paths": {
  12099. "type": "array",
  12100. "items": {
  12101. "type": "string"
  12102. }
  12103. },
  12104. "urls": {
  12105. "type": "array",
  12106. "items": {
  12107. "type": "string"
  12108. }
  12109. }
  12110. },
  12111. "additionalProperties": false
  12112. },
  12113. "reference": {
  12114. "$ref": "#/components/schemas/ReferenceConfig"
  12115. },
  12116. "watcher": {
  12117. "type": "object",
  12118. "properties": {
  12119. "ignore": {
  12120. "type": "array",
  12121. "items": {
  12122. "type": "string"
  12123. }
  12124. }
  12125. },
  12126. "additionalProperties": false
  12127. },
  12128. "snapshot": {
  12129. "type": "boolean"
  12130. },
  12131. "plugin": {
  12132. "type": "array",
  12133. "items": {
  12134. "anyOf": [
  12135. {
  12136. "type": "string"
  12137. },
  12138. {
  12139. "type": "array",
  12140. "prefixItems": [
  12141. {
  12142. "type": "string"
  12143. },
  12144. {
  12145. "type": "object"
  12146. }
  12147. ],
  12148. "maxItems": 2,
  12149. "minItems": 2
  12150. }
  12151. ]
  12152. }
  12153. },
  12154. "share": {
  12155. "type": "string",
  12156. "enum": ["manual", "auto", "disabled"]
  12157. },
  12158. "autoshare": {
  12159. "type": "boolean"
  12160. },
  12161. "autoupdate": {
  12162. "anyOf": [
  12163. {
  12164. "type": "boolean"
  12165. },
  12166. {
  12167. "type": "string",
  12168. "enum": ["notify"]
  12169. }
  12170. ],
  12171. "description": "Automatically update to the latest version. Set to true to auto-update, false to disable, or 'notify' to show update notifications"
  12172. },
  12173. "disabled_providers": {
  12174. "type": "array",
  12175. "items": {
  12176. "type": "string"
  12177. }
  12178. },
  12179. "enabled_providers": {
  12180. "type": "array",
  12181. "items": {
  12182. "type": "string"
  12183. }
  12184. },
  12185. "model": {
  12186. "type": "string"
  12187. },
  12188. "small_model": {
  12189. "type": "string"
  12190. },
  12191. "default_agent": {
  12192. "type": "string"
  12193. },
  12194. "username": {
  12195. "type": "string"
  12196. },
  12197. "mode": {
  12198. "type": "object",
  12199. "properties": {
  12200. "build": {
  12201. "$ref": "#/components/schemas/AgentConfig"
  12202. },
  12203. "plan": {
  12204. "$ref": "#/components/schemas/AgentConfig"
  12205. }
  12206. },
  12207. "additionalProperties": {
  12208. "$ref": "#/components/schemas/AgentConfig"
  12209. }
  12210. },
  12211. "agent": {
  12212. "type": "object",
  12213. "properties": {
  12214. "plan": {
  12215. "$ref": "#/components/schemas/AgentConfig"
  12216. },
  12217. "build": {
  12218. "$ref": "#/components/schemas/AgentConfig"
  12219. },
  12220. "general": {
  12221. "$ref": "#/components/schemas/AgentConfig"
  12222. },
  12223. "explore": {
  12224. "$ref": "#/components/schemas/AgentConfig"
  12225. },
  12226. "scout": {
  12227. "$ref": "#/components/schemas/AgentConfig"
  12228. },
  12229. "title": {
  12230. "$ref": "#/components/schemas/AgentConfig"
  12231. },
  12232. "summary": {
  12233. "$ref": "#/components/schemas/AgentConfig"
  12234. },
  12235. "compaction": {
  12236. "$ref": "#/components/schemas/AgentConfig"
  12237. }
  12238. },
  12239. "additionalProperties": {
  12240. "$ref": "#/components/schemas/AgentConfig"
  12241. }
  12242. },
  12243. "provider": {
  12244. "type": "object",
  12245. "additionalProperties": {
  12246. "$ref": "#/components/schemas/ProviderConfig"
  12247. }
  12248. },
  12249. "mcp": {
  12250. "type": "object",
  12251. "additionalProperties": {
  12252. "anyOf": [
  12253. {
  12254. "$ref": "#/components/schemas/McpLocalConfig"
  12255. },
  12256. {
  12257. "$ref": "#/components/schemas/McpRemoteConfig"
  12258. },
  12259. {
  12260. "type": "object",
  12261. "properties": {
  12262. "enabled": {
  12263. "type": "boolean"
  12264. }
  12265. },
  12266. "required": ["enabled"],
  12267. "additionalProperties": false
  12268. }
  12269. ]
  12270. }
  12271. },
  12272. "formatter": {
  12273. "anyOf": [
  12274. {
  12275. "type": "boolean"
  12276. },
  12277. {
  12278. "type": "object",
  12279. "additionalProperties": {
  12280. "type": "object",
  12281. "properties": {
  12282. "disabled": {
  12283. "type": "boolean"
  12284. },
  12285. "command": {
  12286. "type": "array",
  12287. "items": {
  12288. "type": "string"
  12289. }
  12290. },
  12291. "environment": {
  12292. "type": "object",
  12293. "additionalProperties": {
  12294. "type": "string"
  12295. }
  12296. },
  12297. "extensions": {
  12298. "type": "array",
  12299. "items": {
  12300. "type": "string"
  12301. }
  12302. }
  12303. },
  12304. "additionalProperties": false
  12305. }
  12306. }
  12307. ],
  12308. "description": "Enable or configure formatters. Omit or set to false to disable, true to enable built-ins, or an object to enable built-ins with overrides."
  12309. },
  12310. "lsp": {
  12311. "anyOf": [
  12312. {
  12313. "type": "boolean"
  12314. },
  12315. {
  12316. "type": "object",
  12317. "additionalProperties": {
  12318. "anyOf": [
  12319. {
  12320. "type": "object",
  12321. "properties": {
  12322. "disabled": {
  12323. "type": "boolean",
  12324. "enum": [true]
  12325. }
  12326. },
  12327. "required": ["disabled"],
  12328. "additionalProperties": false
  12329. },
  12330. {
  12331. "type": "object",
  12332. "properties": {
  12333. "command": {
  12334. "type": "array",
  12335. "items": {
  12336. "type": "string"
  12337. }
  12338. },
  12339. "extensions": {
  12340. "type": "array",
  12341. "items": {
  12342. "type": "string"
  12343. }
  12344. },
  12345. "disabled": {
  12346. "type": "boolean"
  12347. },
  12348. "env": {
  12349. "type": "object",
  12350. "additionalProperties": {
  12351. "type": "string"
  12352. }
  12353. },
  12354. "initialization": {
  12355. "type": "object"
  12356. }
  12357. },
  12358. "required": ["command"],
  12359. "additionalProperties": false
  12360. }
  12361. ]
  12362. }
  12363. }
  12364. ],
  12365. "description": "Enable or configure LSP servers. Omit or set to false to disable, true to enable built-ins, or an object to enable built-ins with overrides."
  12366. },
  12367. "instructions": {
  12368. "type": "array",
  12369. "items": {
  12370. "type": "string"
  12371. }
  12372. },
  12373. "layout": {
  12374. "$ref": "#/components/schemas/LayoutConfig"
  12375. },
  12376. "permission": {
  12377. "$ref": "#/components/schemas/PermissionConfig"
  12378. },
  12379. "tools": {
  12380. "type": "object",
  12381. "additionalProperties": {
  12382. "type": "boolean"
  12383. }
  12384. },
  12385. "attachment": {
  12386. "$ref": "#/components/schemas/AttachmentConfig"
  12387. },
  12388. "enterprise": {
  12389. "type": "object",
  12390. "properties": {
  12391. "url": {
  12392. "type": "string"
  12393. }
  12394. },
  12395. "additionalProperties": false
  12396. },
  12397. "tool_output": {
  12398. "type": "object",
  12399. "properties": {
  12400. "max_lines": {
  12401. "type": "integer",
  12402. "exclusiveMinimum": 0
  12403. },
  12404. "max_bytes": {
  12405. "type": "integer",
  12406. "exclusiveMinimum": 0
  12407. }
  12408. },
  12409. "additionalProperties": false
  12410. },
  12411. "compaction": {
  12412. "type": "object",
  12413. "properties": {
  12414. "auto": {
  12415. "type": "boolean"
  12416. },
  12417. "prune": {
  12418. "type": "boolean"
  12419. },
  12420. "tail_turns": {
  12421. "type": "integer",
  12422. "minimum": 0
  12423. },
  12424. "preserve_recent_tokens": {
  12425. "type": "integer",
  12426. "minimum": 0
  12427. },
  12428. "reserved": {
  12429. "type": "integer",
  12430. "minimum": 0
  12431. }
  12432. },
  12433. "additionalProperties": false
  12434. },
  12435. "experimental": {
  12436. "type": "object",
  12437. "properties": {
  12438. "disable_paste_summary": {
  12439. "type": "boolean"
  12440. },
  12441. "batch_tool": {
  12442. "type": "boolean"
  12443. },
  12444. "openTelemetry": {
  12445. "type": "boolean"
  12446. },
  12447. "primary_tools": {
  12448. "type": "array",
  12449. "items": {
  12450. "type": "string"
  12451. }
  12452. },
  12453. "continue_loop_on_deny": {
  12454. "type": "boolean"
  12455. },
  12456. "mcp_timeout": {
  12457. "type": "integer",
  12458. "exclusiveMinimum": 0
  12459. }
  12460. },
  12461. "additionalProperties": false
  12462. }
  12463. },
  12464. "additionalProperties": false
  12465. },
  12466. "Model": {
  12467. "type": "object",
  12468. "properties": {
  12469. "id": {
  12470. "type": "string"
  12471. },
  12472. "providerID": {
  12473. "type": "string"
  12474. },
  12475. "api": {
  12476. "type": "object",
  12477. "properties": {
  12478. "id": {
  12479. "type": "string"
  12480. },
  12481. "url": {
  12482. "type": "string"
  12483. },
  12484. "npm": {
  12485. "type": "string"
  12486. }
  12487. },
  12488. "required": ["id", "url", "npm"],
  12489. "additionalProperties": false
  12490. },
  12491. "name": {
  12492. "type": "string"
  12493. },
  12494. "family": {
  12495. "type": "string"
  12496. },
  12497. "capabilities": {
  12498. "type": "object",
  12499. "properties": {
  12500. "temperature": {
  12501. "type": "boolean"
  12502. },
  12503. "reasoning": {
  12504. "type": "boolean"
  12505. },
  12506. "attachment": {
  12507. "type": "boolean"
  12508. },
  12509. "toolcall": {
  12510. "type": "boolean"
  12511. },
  12512. "input": {
  12513. "type": "object",
  12514. "properties": {
  12515. "text": {
  12516. "type": "boolean"
  12517. },
  12518. "audio": {
  12519. "type": "boolean"
  12520. },
  12521. "image": {
  12522. "type": "boolean"
  12523. },
  12524. "video": {
  12525. "type": "boolean"
  12526. },
  12527. "pdf": {
  12528. "type": "boolean"
  12529. }
  12530. },
  12531. "required": ["text", "audio", "image", "video", "pdf"],
  12532. "additionalProperties": false
  12533. },
  12534. "output": {
  12535. "type": "object",
  12536. "properties": {
  12537. "text": {
  12538. "type": "boolean"
  12539. },
  12540. "audio": {
  12541. "type": "boolean"
  12542. },
  12543. "image": {
  12544. "type": "boolean"
  12545. },
  12546. "video": {
  12547. "type": "boolean"
  12548. },
  12549. "pdf": {
  12550. "type": "boolean"
  12551. }
  12552. },
  12553. "required": ["text", "audio", "image", "video", "pdf"],
  12554. "additionalProperties": false
  12555. },
  12556. "interleaved": {
  12557. "anyOf": [
  12558. {
  12559. "type": "boolean"
  12560. },
  12561. {
  12562. "type": "object",
  12563. "properties": {
  12564. "field": {
  12565. "type": "string",
  12566. "enum": ["reasoning_content", "reasoning_details"]
  12567. }
  12568. },
  12569. "required": ["field"],
  12570. "additionalProperties": false
  12571. }
  12572. ]
  12573. }
  12574. },
  12575. "required": ["temperature", "reasoning", "attachment", "toolcall", "input", "output", "interleaved"],
  12576. "additionalProperties": false
  12577. },
  12578. "cost": {
  12579. "type": "object",
  12580. "properties": {
  12581. "input": {
  12582. "type": "number"
  12583. },
  12584. "output": {
  12585. "type": "number"
  12586. },
  12587. "cache": {
  12588. "type": "object",
  12589. "properties": {
  12590. "read": {
  12591. "type": "number"
  12592. },
  12593. "write": {
  12594. "type": "number"
  12595. }
  12596. },
  12597. "required": ["read", "write"],
  12598. "additionalProperties": false
  12599. },
  12600. "tiers": {
  12601. "type": "array",
  12602. "items": {
  12603. "type": "object",
  12604. "properties": {
  12605. "input": {
  12606. "type": "number"
  12607. },
  12608. "output": {
  12609. "type": "number"
  12610. },
  12611. "cache": {
  12612. "type": "object",
  12613. "properties": {
  12614. "read": {
  12615. "type": "number"
  12616. },
  12617. "write": {
  12618. "type": "number"
  12619. }
  12620. },
  12621. "required": ["read", "write"],
  12622. "additionalProperties": false
  12623. },
  12624. "tier": {
  12625. "type": "object",
  12626. "properties": {
  12627. "type": {
  12628. "type": "string",
  12629. "enum": ["context"]
  12630. },
  12631. "size": {
  12632. "type": "number"
  12633. }
  12634. },
  12635. "required": ["type", "size"],
  12636. "additionalProperties": false
  12637. }
  12638. },
  12639. "required": ["input", "output", "cache", "tier"],
  12640. "additionalProperties": false
  12641. }
  12642. },
  12643. "experimentalOver200K": {
  12644. "type": "object",
  12645. "properties": {
  12646. "input": {
  12647. "type": "number"
  12648. },
  12649. "output": {
  12650. "type": "number"
  12651. },
  12652. "cache": {
  12653. "type": "object",
  12654. "properties": {
  12655. "read": {
  12656. "type": "number"
  12657. },
  12658. "write": {
  12659. "type": "number"
  12660. }
  12661. },
  12662. "required": ["read", "write"],
  12663. "additionalProperties": false
  12664. }
  12665. },
  12666. "required": ["input", "output", "cache"],
  12667. "additionalProperties": false
  12668. }
  12669. },
  12670. "required": ["input", "output", "cache"],
  12671. "additionalProperties": false
  12672. },
  12673. "limit": {
  12674. "type": "object",
  12675. "properties": {
  12676. "context": {
  12677. "type": "number"
  12678. },
  12679. "input": {
  12680. "type": "number"
  12681. },
  12682. "output": {
  12683. "type": "number"
  12684. }
  12685. },
  12686. "required": ["context", "output"],
  12687. "additionalProperties": false
  12688. },
  12689. "status": {
  12690. "type": "string",
  12691. "enum": ["alpha", "beta", "deprecated", "active"]
  12692. },
  12693. "options": {
  12694. "type": "object"
  12695. },
  12696. "headers": {
  12697. "type": "object",
  12698. "additionalProperties": {
  12699. "type": "string"
  12700. }
  12701. },
  12702. "release_date": {
  12703. "type": "string"
  12704. },
  12705. "variants": {
  12706. "type": "object",
  12707. "additionalProperties": {
  12708. "type": "object"
  12709. }
  12710. }
  12711. },
  12712. "required": [
  12713. "id",
  12714. "providerID",
  12715. "api",
  12716. "name",
  12717. "capabilities",
  12718. "cost",
  12719. "limit",
  12720. "status",
  12721. "options",
  12722. "headers",
  12723. "release_date"
  12724. ],
  12725. "additionalProperties": false
  12726. },
  12727. "Provider": {
  12728. "type": "object",
  12729. "properties": {
  12730. "id": {
  12731. "type": "string"
  12732. },
  12733. "name": {
  12734. "type": "string"
  12735. },
  12736. "source": {
  12737. "type": "string",
  12738. "enum": ["env", "config", "custom", "api"]
  12739. },
  12740. "env": {
  12741. "type": "array",
  12742. "items": {
  12743. "type": "string"
  12744. }
  12745. },
  12746. "key": {
  12747. "type": "string"
  12748. },
  12749. "options": {
  12750. "type": "object"
  12751. },
  12752. "models": {
  12753. "type": "object",
  12754. "additionalProperties": {
  12755. "$ref": "#/components/schemas/Model"
  12756. }
  12757. }
  12758. },
  12759. "required": ["id", "name", "source", "env", "options", "models"],
  12760. "additionalProperties": false
  12761. },
  12762. "ConsoleState": {
  12763. "type": "object",
  12764. "properties": {
  12765. "consoleManagedProviders": {
  12766. "type": "array",
  12767. "items": {
  12768. "type": "string"
  12769. }
  12770. },
  12771. "activeOrgName": {
  12772. "type": "string"
  12773. },
  12774. "switchableOrgCount": {
  12775. "type": "integer",
  12776. "minimum": 0
  12777. }
  12778. },
  12779. "required": ["consoleManagedProviders", "switchableOrgCount"],
  12780. "additionalProperties": false
  12781. },
  12782. "effect_HttpApiError_InternalServerError": {
  12783. "type": "object",
  12784. "properties": {
  12785. "_tag": {
  12786. "type": "string",
  12787. "enum": ["InternalServerError"]
  12788. }
  12789. },
  12790. "required": ["_tag"],
  12791. "additionalProperties": false
  12792. },
  12793. "ToolListItem": {
  12794. "type": "object",
  12795. "properties": {
  12796. "id": {
  12797. "type": "string"
  12798. },
  12799. "description": {
  12800. "type": "string"
  12801. },
  12802. "parameters": {}
  12803. },
  12804. "required": ["id", "description", "parameters"],
  12805. "additionalProperties": false
  12806. },
  12807. "ToolList": {
  12808. "type": "array",
  12809. "items": {
  12810. "$ref": "#/components/schemas/ToolListItem"
  12811. }
  12812. },
  12813. "ToolIDs": {
  12814. "type": "array",
  12815. "items": {
  12816. "type": "string"
  12817. }
  12818. },
  12819. "WorktreeError": {
  12820. "type": "object",
  12821. "properties": {
  12822. "name": {
  12823. "type": "string",
  12824. "enum": [
  12825. "WorktreeNotGitError",
  12826. "WorktreeNameGenerationFailedError",
  12827. "WorktreeCreateFailedError",
  12828. "WorktreeStartCommandFailedError",
  12829. "WorktreeRemoveFailedError",
  12830. "WorktreeResetFailedError",
  12831. "WorktreeListFailedError"
  12832. ]
  12833. },
  12834. "data": {
  12835. "type": "object",
  12836. "properties": {
  12837. "message": {
  12838. "type": "string"
  12839. }
  12840. },
  12841. "required": ["message"],
  12842. "additionalProperties": false
  12843. }
  12844. },
  12845. "required": ["name", "data"],
  12846. "additionalProperties": false
  12847. },
  12848. "WorktreeCreateInput": {
  12849. "type": "object",
  12850. "properties": {
  12851. "name": {
  12852. "type": "string"
  12853. },
  12854. "startCommand": {
  12855. "type": "string",
  12856. "description": "Additional startup script to run after the project's start command"
  12857. }
  12858. },
  12859. "additionalProperties": false
  12860. },
  12861. "Worktree": {
  12862. "type": "object",
  12863. "properties": {
  12864. "name": {
  12865. "type": "string"
  12866. },
  12867. "branch": {
  12868. "type": "string"
  12869. },
  12870. "directory": {
  12871. "type": "string"
  12872. }
  12873. },
  12874. "required": ["name", "directory"],
  12875. "additionalProperties": false
  12876. },
  12877. "WorktreeRemoveInput": {
  12878. "type": "object",
  12879. "properties": {
  12880. "directory": {
  12881. "type": "string"
  12882. }
  12883. },
  12884. "required": ["directory"],
  12885. "additionalProperties": false
  12886. },
  12887. "WorktreeResetInput": {
  12888. "type": "object",
  12889. "properties": {
  12890. "directory": {
  12891. "type": "string"
  12892. }
  12893. },
  12894. "required": ["directory"],
  12895. "additionalProperties": false
  12896. },
  12897. "ProjectSummary": {
  12898. "type": "object",
  12899. "properties": {
  12900. "id": {
  12901. "type": "string"
  12902. },
  12903. "name": {
  12904. "type": "string"
  12905. },
  12906. "worktree": {
  12907. "type": "string"
  12908. }
  12909. },
  12910. "required": ["id", "worktree"],
  12911. "additionalProperties": false
  12912. },
  12913. "GlobalSession": {
  12914. "type": "object",
  12915. "properties": {
  12916. "id": {
  12917. "type": "string",
  12918. "pattern": "^ses"
  12919. },
  12920. "slug": {
  12921. "type": "string"
  12922. },
  12923. "projectID": {
  12924. "type": "string"
  12925. },
  12926. "workspaceID": {
  12927. "type": "string",
  12928. "pattern": "^wrk"
  12929. },
  12930. "directory": {
  12931. "type": "string"
  12932. },
  12933. "path": {
  12934. "type": "string"
  12935. },
  12936. "parentID": {
  12937. "type": "string",
  12938. "pattern": "^ses"
  12939. },
  12940. "summary": {
  12941. "type": "object",
  12942. "properties": {
  12943. "additions": {
  12944. "type": "number"
  12945. },
  12946. "deletions": {
  12947. "type": "number"
  12948. },
  12949. "files": {
  12950. "type": "number"
  12951. },
  12952. "diffs": {
  12953. "type": "array",
  12954. "items": {
  12955. "$ref": "#/components/schemas/SnapshotFileDiff"
  12956. }
  12957. }
  12958. },
  12959. "required": ["additions", "deletions", "files"],
  12960. "additionalProperties": false
  12961. },
  12962. "cost": {
  12963. "type": "number"
  12964. },
  12965. "tokens": {
  12966. "type": "object",
  12967. "properties": {
  12968. "input": {
  12969. "type": "number"
  12970. },
  12971. "output": {
  12972. "type": "number"
  12973. },
  12974. "reasoning": {
  12975. "type": "number"
  12976. },
  12977. "cache": {
  12978. "type": "object",
  12979. "properties": {
  12980. "read": {
  12981. "type": "number"
  12982. },
  12983. "write": {
  12984. "type": "number"
  12985. }
  12986. },
  12987. "required": ["read", "write"],
  12988. "additionalProperties": false
  12989. }
  12990. },
  12991. "required": ["input", "output", "reasoning", "cache"],
  12992. "additionalProperties": false
  12993. },
  12994. "share": {
  12995. "type": "object",
  12996. "properties": {
  12997. "url": {
  12998. "type": "string"
  12999. }
  13000. },
  13001. "required": ["url"],
  13002. "additionalProperties": false
  13003. },
  13004. "title": {
  13005. "type": "string"
  13006. },
  13007. "agent": {
  13008. "type": "string"
  13009. },
  13010. "model": {
  13011. "type": "object",
  13012. "properties": {
  13013. "id": {
  13014. "type": "string"
  13015. },
  13016. "providerID": {
  13017. "type": "string"
  13018. },
  13019. "variant": {
  13020. "type": "string"
  13021. }
  13022. },
  13023. "required": ["id", "providerID"],
  13024. "additionalProperties": false
  13025. },
  13026. "version": {
  13027. "type": "string"
  13028. },
  13029. "time": {
  13030. "type": "object",
  13031. "properties": {
  13032. "created": {
  13033. "type": "integer",
  13034. "minimum": 0
  13035. },
  13036. "updated": {
  13037. "type": "integer",
  13038. "minimum": 0
  13039. },
  13040. "compacting": {
  13041. "type": "integer",
  13042. "minimum": 0
  13043. },
  13044. "archived": {
  13045. "type": "number"
  13046. }
  13047. },
  13048. "required": ["created", "updated"],
  13049. "additionalProperties": false
  13050. },
  13051. "permission": {
  13052. "$ref": "#/components/schemas/PermissionRuleset"
  13053. },
  13054. "revert": {
  13055. "type": "object",
  13056. "properties": {
  13057. "messageID": {
  13058. "type": "string",
  13059. "pattern": "^msg"
  13060. },
  13061. "partID": {
  13062. "type": "string",
  13063. "pattern": "^prt"
  13064. },
  13065. "snapshot": {
  13066. "type": "string"
  13067. },
  13068. "diff": {
  13069. "type": "string"
  13070. }
  13071. },
  13072. "required": ["messageID"],
  13073. "additionalProperties": false
  13074. },
  13075. "project": {
  13076. "anyOf": [
  13077. {
  13078. "$ref": "#/components/schemas/ProjectSummary"
  13079. },
  13080. {
  13081. "type": "null"
  13082. }
  13083. ]
  13084. }
  13085. },
  13086. "required": ["id", "slug", "projectID", "directory", "title", "version", "time", "project"],
  13087. "additionalProperties": false
  13088. },
  13089. "McpResource": {
  13090. "type": "object",
  13091. "properties": {
  13092. "name": {
  13093. "type": "string"
  13094. },
  13095. "uri": {
  13096. "type": "string"
  13097. },
  13098. "description": {
  13099. "type": "string"
  13100. },
  13101. "mimeType": {
  13102. "type": "string"
  13103. },
  13104. "client": {
  13105. "type": "string"
  13106. }
  13107. },
  13108. "required": ["name", "uri", "client"],
  13109. "additionalProperties": false
  13110. },
  13111. "Symbol": {
  13112. "type": "object",
  13113. "properties": {
  13114. "name": {
  13115. "type": "string"
  13116. },
  13117. "kind": {
  13118. "type": "integer",
  13119. "minimum": 0
  13120. },
  13121. "location": {
  13122. "type": "object",
  13123. "properties": {
  13124. "uri": {
  13125. "type": "string"
  13126. },
  13127. "range": {
  13128. "$ref": "#/components/schemas/Range"
  13129. }
  13130. },
  13131. "required": ["uri", "range"],
  13132. "additionalProperties": false
  13133. }
  13134. },
  13135. "required": ["name", "kind", "location"],
  13136. "additionalProperties": false
  13137. },
  13138. "FileNode": {
  13139. "type": "object",
  13140. "properties": {
  13141. "name": {
  13142. "type": "string"
  13143. },
  13144. "path": {
  13145. "type": "string"
  13146. },
  13147. "absolute": {
  13148. "type": "string"
  13149. },
  13150. "type": {
  13151. "type": "string",
  13152. "enum": ["file", "directory"]
  13153. },
  13154. "ignored": {
  13155. "type": "boolean"
  13156. }
  13157. },
  13158. "required": ["name", "path", "absolute", "type", "ignored"],
  13159. "additionalProperties": false
  13160. },
  13161. "FileContent": {
  13162. "type": "object",
  13163. "properties": {
  13164. "type": {
  13165. "type": "string",
  13166. "enum": ["text", "binary"]
  13167. },
  13168. "content": {
  13169. "type": "string"
  13170. },
  13171. "diff": {
  13172. "type": "string"
  13173. },
  13174. "patch": {
  13175. "type": "object",
  13176. "properties": {
  13177. "oldFileName": {
  13178. "type": "string"
  13179. },
  13180. "newFileName": {
  13181. "type": "string"
  13182. },
  13183. "oldHeader": {
  13184. "type": "string"
  13185. },
  13186. "newHeader": {
  13187. "type": "string"
  13188. },
  13189. "hunks": {
  13190. "type": "array",
  13191. "items": {
  13192. "type": "object",
  13193. "properties": {
  13194. "oldStart": {
  13195. "type": "integer",
  13196. "minimum": 0
  13197. },
  13198. "oldLines": {
  13199. "type": "integer",
  13200. "minimum": 0
  13201. },
  13202. "newStart": {
  13203. "type": "integer",
  13204. "minimum": 0
  13205. },
  13206. "newLines": {
  13207. "type": "integer",
  13208. "minimum": 0
  13209. },
  13210. "lines": {
  13211. "type": "array",
  13212. "items": {
  13213. "type": "string"
  13214. }
  13215. }
  13216. },
  13217. "required": ["oldStart", "oldLines", "newStart", "newLines", "lines"],
  13218. "additionalProperties": false
  13219. }
  13220. },
  13221. "index": {
  13222. "type": "string"
  13223. }
  13224. },
  13225. "required": ["oldFileName", "newFileName", "hunks"],
  13226. "additionalProperties": false
  13227. },
  13228. "encoding": {
  13229. "type": "string",
  13230. "enum": ["base64"]
  13231. },
  13232. "mimeType": {
  13233. "type": "string"
  13234. }
  13235. },
  13236. "required": ["type", "content"],
  13237. "additionalProperties": false
  13238. },
  13239. "File": {
  13240. "type": "object",
  13241. "properties": {
  13242. "path": {
  13243. "type": "string"
  13244. },
  13245. "added": {
  13246. "type": "integer",
  13247. "minimum": 0
  13248. },
  13249. "removed": {
  13250. "type": "integer",
  13251. "minimum": 0
  13252. },
  13253. "status": {
  13254. "type": "string",
  13255. "enum": ["added", "deleted", "modified"]
  13256. }
  13257. },
  13258. "required": ["path", "added", "removed", "status"],
  13259. "additionalProperties": false
  13260. },
  13261. "Path": {
  13262. "type": "object",
  13263. "properties": {
  13264. "home": {
  13265. "type": "string"
  13266. },
  13267. "state": {
  13268. "type": "string"
  13269. },
  13270. "config": {
  13271. "type": "string"
  13272. },
  13273. "worktree": {
  13274. "type": "string"
  13275. },
  13276. "directory": {
  13277. "type": "string"
  13278. }
  13279. },
  13280. "required": ["home", "state", "config", "worktree", "directory"],
  13281. "additionalProperties": false
  13282. },
  13283. "VcsInfo": {
  13284. "type": "object",
  13285. "properties": {
  13286. "branch": {
  13287. "type": "string"
  13288. },
  13289. "default_branch": {
  13290. "type": "string"
  13291. }
  13292. },
  13293. "additionalProperties": false
  13294. },
  13295. "VcsFileStatus": {
  13296. "type": "object",
  13297. "properties": {
  13298. "file": {
  13299. "type": "string"
  13300. },
  13301. "additions": {
  13302. "type": "number"
  13303. },
  13304. "deletions": {
  13305. "type": "number"
  13306. },
  13307. "status": {
  13308. "type": "string",
  13309. "enum": ["added", "deleted", "modified"]
  13310. }
  13311. },
  13312. "required": ["file", "additions", "deletions", "status"],
  13313. "additionalProperties": false
  13314. },
  13315. "VcsFileDiff": {
  13316. "type": "object",
  13317. "properties": {
  13318. "file": {
  13319. "type": "string"
  13320. },
  13321. "patch": {
  13322. "type": "string"
  13323. },
  13324. "additions": {
  13325. "type": "number"
  13326. },
  13327. "deletions": {
  13328. "type": "number"
  13329. },
  13330. "status": {
  13331. "type": "string",
  13332. "enum": ["added", "deleted", "modified"]
  13333. }
  13334. },
  13335. "required": ["file", "additions", "deletions"],
  13336. "additionalProperties": false
  13337. },
  13338. "VcsApplyError": {
  13339. "type": "object",
  13340. "properties": {
  13341. "name": {
  13342. "type": "string",
  13343. "enum": ["VcsApplyError"]
  13344. },
  13345. "data": {
  13346. "type": "object",
  13347. "properties": {
  13348. "message": {
  13349. "type": "string"
  13350. },
  13351. "reason": {
  13352. "type": "string",
  13353. "enum": ["non-git", "not-clean"]
  13354. }
  13355. },
  13356. "required": ["message", "reason"],
  13357. "additionalProperties": false
  13358. }
  13359. },
  13360. "required": ["name", "data"],
  13361. "additionalProperties": false
  13362. },
  13363. "Command": {
  13364. "type": "object",
  13365. "properties": {
  13366. "name": {
  13367. "type": "string"
  13368. },
  13369. "description": {
  13370. "type": "string"
  13371. },
  13372. "agent": {
  13373. "type": "string"
  13374. },
  13375. "model": {
  13376. "type": "string"
  13377. },
  13378. "source": {
  13379. "type": "string",
  13380. "enum": ["command", "mcp", "skill"]
  13381. },
  13382. "template": {
  13383. "type": "string"
  13384. },
  13385. "subtask": {
  13386. "type": "boolean"
  13387. },
  13388. "hints": {
  13389. "type": "array",
  13390. "items": {
  13391. "type": "string"
  13392. }
  13393. }
  13394. },
  13395. "required": ["name", "template", "hints"],
  13396. "additionalProperties": false
  13397. },
  13398. "Agent": {
  13399. "type": "object",
  13400. "properties": {
  13401. "name": {
  13402. "type": "string"
  13403. },
  13404. "description": {
  13405. "type": "string"
  13406. },
  13407. "mode": {
  13408. "type": "string",
  13409. "enum": ["subagent", "primary", "all"]
  13410. },
  13411. "native": {
  13412. "type": "boolean"
  13413. },
  13414. "hidden": {
  13415. "type": "boolean"
  13416. },
  13417. "topP": {
  13418. "type": "number"
  13419. },
  13420. "temperature": {
  13421. "type": "number"
  13422. },
  13423. "color": {
  13424. "type": "string"
  13425. },
  13426. "permission": {
  13427. "$ref": "#/components/schemas/PermissionRuleset"
  13428. },
  13429. "model": {
  13430. "type": "object",
  13431. "properties": {
  13432. "modelID": {
  13433. "type": "string"
  13434. },
  13435. "providerID": {
  13436. "type": "string"
  13437. }
  13438. },
  13439. "required": ["modelID", "providerID"],
  13440. "additionalProperties": false
  13441. },
  13442. "variant": {
  13443. "type": "string"
  13444. },
  13445. "prompt": {
  13446. "type": "string"
  13447. },
  13448. "options": {
  13449. "type": "object"
  13450. },
  13451. "steps": {
  13452. "type": "number"
  13453. }
  13454. },
  13455. "required": ["name", "mode", "permission", "options"],
  13456. "additionalProperties": false
  13457. },
  13458. "LSPStatus": {
  13459. "type": "object",
  13460. "properties": {
  13461. "id": {
  13462. "type": "string"
  13463. },
  13464. "name": {
  13465. "type": "string"
  13466. },
  13467. "root": {
  13468. "type": "string"
  13469. },
  13470. "status": {
  13471. "type": "string",
  13472. "enum": ["connected", "error"]
  13473. }
  13474. },
  13475. "required": ["id", "name", "root", "status"],
  13476. "additionalProperties": false
  13477. },
  13478. "FormatterStatus": {
  13479. "type": "object",
  13480. "properties": {
  13481. "name": {
  13482. "type": "string"
  13483. },
  13484. "extensions": {
  13485. "type": "array",
  13486. "items": {
  13487. "type": "string"
  13488. }
  13489. },
  13490. "enabled": {
  13491. "type": "boolean"
  13492. }
  13493. },
  13494. "required": ["name", "extensions", "enabled"],
  13495. "additionalProperties": false
  13496. },
  13497. "MCPStatusConnected": {
  13498. "type": "object",
  13499. "properties": {
  13500. "status": {
  13501. "type": "string",
  13502. "enum": ["connected"]
  13503. }
  13504. },
  13505. "required": ["status"],
  13506. "additionalProperties": false
  13507. },
  13508. "MCPStatusDisabled": {
  13509. "type": "object",
  13510. "properties": {
  13511. "status": {
  13512. "type": "string",
  13513. "enum": ["disabled"]
  13514. }
  13515. },
  13516. "required": ["status"],
  13517. "additionalProperties": false
  13518. },
  13519. "MCPStatusFailed": {
  13520. "type": "object",
  13521. "properties": {
  13522. "status": {
  13523. "type": "string",
  13524. "enum": ["failed"]
  13525. },
  13526. "error": {
  13527. "type": "string"
  13528. }
  13529. },
  13530. "required": ["status", "error"],
  13531. "additionalProperties": false
  13532. },
  13533. "MCPStatusNeedsAuth": {
  13534. "type": "object",
  13535. "properties": {
  13536. "status": {
  13537. "type": "string",
  13538. "enum": ["needs_auth"]
  13539. }
  13540. },
  13541. "required": ["status"],
  13542. "additionalProperties": false
  13543. },
  13544. "MCPStatusNeedsClientRegistration": {
  13545. "type": "object",
  13546. "properties": {
  13547. "status": {
  13548. "type": "string",
  13549. "enum": ["needs_client_registration"]
  13550. },
  13551. "error": {
  13552. "type": "string"
  13553. }
  13554. },
  13555. "required": ["status", "error"],
  13556. "additionalProperties": false
  13557. },
  13558. "MCPStatus": {
  13559. "anyOf": [
  13560. {
  13561. "$ref": "#/components/schemas/MCPStatusConnected"
  13562. },
  13563. {
  13564. "$ref": "#/components/schemas/MCPStatusDisabled"
  13565. },
  13566. {
  13567. "$ref": "#/components/schemas/MCPStatusFailed"
  13568. },
  13569. {
  13570. "$ref": "#/components/schemas/MCPStatusNeedsAuth"
  13571. },
  13572. {
  13573. "$ref": "#/components/schemas/MCPStatusNeedsClientRegistration"
  13574. }
  13575. ]
  13576. },
  13577. "McpUnsupportedOAuthError": {
  13578. "type": "object",
  13579. "properties": {
  13580. "error": {
  13581. "type": "string"
  13582. }
  13583. },
  13584. "required": ["error"],
  13585. "additionalProperties": false
  13586. },
  13587. "NotFoundError": {
  13588. "type": "object",
  13589. "required": ["name", "data"],
  13590. "properties": {
  13591. "name": {
  13592. "type": "string",
  13593. "enum": ["NotFoundError"]
  13594. },
  13595. "data": {
  13596. "type": "object",
  13597. "required": ["message"],
  13598. "properties": {
  13599. "message": {
  13600. "type": "string"
  13601. }
  13602. }
  13603. }
  13604. }
  13605. },
  13606. "effect_HttpApiError_Forbidden": {
  13607. "type": "object",
  13608. "properties": {
  13609. "_tag": {
  13610. "type": "string",
  13611. "enum": ["Forbidden"]
  13612. }
  13613. },
  13614. "required": ["_tag"],
  13615. "additionalProperties": false
  13616. },
  13617. "ProviderAuthMethod": {
  13618. "type": "object",
  13619. "properties": {
  13620. "type": {
  13621. "type": "string",
  13622. "enum": ["oauth", "api"]
  13623. },
  13624. "label": {
  13625. "type": "string"
  13626. },
  13627. "prompts": {
  13628. "type": "array",
  13629. "items": {
  13630. "anyOf": [
  13631. {
  13632. "type": "object",
  13633. "properties": {
  13634. "type": {
  13635. "type": "string",
  13636. "enum": ["text"]
  13637. },
  13638. "key": {
  13639. "type": "string"
  13640. },
  13641. "message": {
  13642. "type": "string"
  13643. },
  13644. "placeholder": {
  13645. "type": "string"
  13646. },
  13647. "when": {
  13648. "type": "object",
  13649. "properties": {
  13650. "key": {
  13651. "type": "string"
  13652. },
  13653. "op": {
  13654. "type": "string",
  13655. "enum": ["eq", "neq"]
  13656. },
  13657. "value": {
  13658. "type": "string"
  13659. }
  13660. },
  13661. "required": ["key", "op", "value"],
  13662. "additionalProperties": false
  13663. }
  13664. },
  13665. "required": ["type", "key", "message"],
  13666. "additionalProperties": false
  13667. },
  13668. {
  13669. "type": "object",
  13670. "properties": {
  13671. "type": {
  13672. "type": "string",
  13673. "enum": ["select"]
  13674. },
  13675. "key": {
  13676. "type": "string"
  13677. },
  13678. "message": {
  13679. "type": "string"
  13680. },
  13681. "options": {
  13682. "type": "array",
  13683. "items": {
  13684. "type": "object",
  13685. "properties": {
  13686. "label": {
  13687. "type": "string"
  13688. },
  13689. "value": {
  13690. "type": "string"
  13691. },
  13692. "hint": {
  13693. "type": "string"
  13694. }
  13695. },
  13696. "required": ["label", "value"],
  13697. "additionalProperties": false
  13698. }
  13699. },
  13700. "when": {
  13701. "type": "object",
  13702. "properties": {
  13703. "key": {
  13704. "type": "string"
  13705. },
  13706. "op": {
  13707. "type": "string",
  13708. "enum": ["eq", "neq"]
  13709. },
  13710. "value": {
  13711. "type": "string"
  13712. }
  13713. },
  13714. "required": ["key", "op", "value"],
  13715. "additionalProperties": false
  13716. }
  13717. },
  13718. "required": ["type", "key", "message", "options"],
  13719. "additionalProperties": false
  13720. }
  13721. ]
  13722. }
  13723. }
  13724. },
  13725. "required": ["type", "label"],
  13726. "additionalProperties": false
  13727. },
  13728. "ProviderAuthAuthorization": {
  13729. "type": "object",
  13730. "properties": {
  13731. "url": {
  13732. "type": "string"
  13733. },
  13734. "method": {
  13735. "type": "string",
  13736. "enum": ["auto", "code"]
  13737. },
  13738. "instructions": {
  13739. "type": "string"
  13740. }
  13741. },
  13742. "required": ["url", "method", "instructions"],
  13743. "additionalProperties": false
  13744. },
  13745. "ProviderAuthError1": {
  13746. "type": "object",
  13747. "properties": {
  13748. "name": {
  13749. "type": "string",
  13750. "enum": [
  13751. "BadRequest",
  13752. "ProviderAuthOauthMissing",
  13753. "ProviderAuthOauthCodeMissing",
  13754. "ProviderAuthOauthCallbackFailed",
  13755. "ProviderAuthValidationFailed"
  13756. ]
  13757. },
  13758. "data": {
  13759. "type": "object",
  13760. "properties": {
  13761. "providerID": {
  13762. "type": "string"
  13763. },
  13764. "field": {
  13765. "type": "string"
  13766. },
  13767. "message": {
  13768. "type": "string"
  13769. },
  13770. "kind": {
  13771. "type": "string"
  13772. }
  13773. },
  13774. "additionalProperties": false
  13775. }
  13776. },
  13777. "required": ["name", "data"],
  13778. "additionalProperties": false
  13779. },
  13780. "TextPartInput": {
  13781. "type": "object",
  13782. "properties": {
  13783. "id": {
  13784. "type": "string",
  13785. "pattern": "^prt"
  13786. },
  13787. "type": {
  13788. "type": "string",
  13789. "enum": ["text"]
  13790. },
  13791. "text": {
  13792. "type": "string"
  13793. },
  13794. "synthetic": {
  13795. "type": "boolean"
  13796. },
  13797. "ignored": {
  13798. "type": "boolean"
  13799. },
  13800. "time": {
  13801. "type": "object",
  13802. "properties": {
  13803. "start": {
  13804. "type": "integer",
  13805. "minimum": 0
  13806. },
  13807. "end": {
  13808. "type": "integer",
  13809. "minimum": 0
  13810. }
  13811. },
  13812. "required": ["start"],
  13813. "additionalProperties": false
  13814. },
  13815. "metadata": {
  13816. "type": "object"
  13817. }
  13818. },
  13819. "required": ["type", "text"],
  13820. "additionalProperties": false
  13821. },
  13822. "FilePartInput": {
  13823. "type": "object",
  13824. "properties": {
  13825. "id": {
  13826. "type": "string",
  13827. "pattern": "^prt"
  13828. },
  13829. "type": {
  13830. "type": "string",
  13831. "enum": ["file"]
  13832. },
  13833. "mime": {
  13834. "type": "string"
  13835. },
  13836. "filename": {
  13837. "type": "string"
  13838. },
  13839. "url": {
  13840. "type": "string"
  13841. },
  13842. "source": {
  13843. "$ref": "#/components/schemas/FilePartSource"
  13844. }
  13845. },
  13846. "required": ["type", "mime", "url"],
  13847. "additionalProperties": false
  13848. },
  13849. "AgentPartInput": {
  13850. "type": "object",
  13851. "properties": {
  13852. "id": {
  13853. "type": "string",
  13854. "pattern": "^prt"
  13855. },
  13856. "type": {
  13857. "type": "string",
  13858. "enum": ["agent"]
  13859. },
  13860. "name": {
  13861. "type": "string"
  13862. },
  13863. "source": {
  13864. "type": "object",
  13865. "properties": {
  13866. "value": {
  13867. "type": "string"
  13868. },
  13869. "start": {
  13870. "type": "integer",
  13871. "minimum": 0
  13872. },
  13873. "end": {
  13874. "type": "integer",
  13875. "minimum": 0
  13876. }
  13877. },
  13878. "required": ["value", "start", "end"],
  13879. "additionalProperties": false
  13880. }
  13881. },
  13882. "required": ["type", "name"],
  13883. "additionalProperties": false
  13884. },
  13885. "SubtaskPartInput": {
  13886. "type": "object",
  13887. "properties": {
  13888. "id": {
  13889. "type": "string",
  13890. "pattern": "^prt"
  13891. },
  13892. "type": {
  13893. "type": "string",
  13894. "enum": ["subtask"]
  13895. },
  13896. "prompt": {
  13897. "type": "string"
  13898. },
  13899. "description": {
  13900. "type": "string"
  13901. },
  13902. "agent": {
  13903. "type": "string"
  13904. },
  13905. "model": {
  13906. "type": "object",
  13907. "properties": {
  13908. "providerID": {
  13909. "type": "string"
  13910. },
  13911. "modelID": {
  13912. "type": "string"
  13913. }
  13914. },
  13915. "required": ["providerID", "modelID"],
  13916. "additionalProperties": false
  13917. },
  13918. "command": {
  13919. "type": "string"
  13920. }
  13921. },
  13922. "required": ["type", "prompt", "description", "agent"],
  13923. "additionalProperties": false
  13924. },
  13925. "V2SessionsResponse": {
  13926. "type": "object",
  13927. "properties": {
  13928. "items": {
  13929. "type": "array",
  13930. "items": {
  13931. "$ref": "#/components/schemas/SessionInfo"
  13932. }
  13933. },
  13934. "cursor": {
  13935. "type": "object",
  13936. "properties": {
  13937. "previous": {
  13938. "type": "string"
  13939. },
  13940. "next": {
  13941. "type": "string"
  13942. }
  13943. },
  13944. "additionalProperties": false
  13945. }
  13946. },
  13947. "required": ["items", "cursor"],
  13948. "additionalProperties": false
  13949. },
  13950. "V2SessionMessagesResponse": {
  13951. "type": "object",
  13952. "properties": {
  13953. "items": {
  13954. "type": "array",
  13955. "items": {
  13956. "$ref": "#/components/schemas/SessionMessage"
  13957. }
  13958. },
  13959. "cursor": {
  13960. "type": "object",
  13961. "properties": {
  13962. "previous": {
  13963. "type": "string"
  13964. },
  13965. "next": {
  13966. "type": "string"
  13967. }
  13968. },
  13969. "additionalProperties": false
  13970. }
  13971. },
  13972. "required": ["items", "cursor"],
  13973. "additionalProperties": false
  13974. },
  13975. "EventTuiPromptAppend": {
  13976. "type": "object",
  13977. "properties": {
  13978. "type": {
  13979. "type": "string",
  13980. "enum": ["tui.prompt.append"]
  13981. },
  13982. "properties": {
  13983. "type": "object",
  13984. "properties": {
  13985. "text": {
  13986. "type": "string"
  13987. }
  13988. },
  13989. "required": ["text"],
  13990. "additionalProperties": false
  13991. }
  13992. },
  13993. "required": ["type", "properties"],
  13994. "additionalProperties": false
  13995. },
  13996. "EventTuiCommandExecute": {
  13997. "type": "object",
  13998. "properties": {
  13999. "type": {
  14000. "type": "string",
  14001. "enum": ["tui.command.execute"]
  14002. },
  14003. "properties": {
  14004. "type": "object",
  14005. "properties": {
  14006. "command": {
  14007. "anyOf": [
  14008. {
  14009. "type": "string",
  14010. "enum": [
  14011. "session.list",
  14012. "session.new",
  14013. "session.share",
  14014. "session.interrupt",
  14015. "session.compact",
  14016. "session.page.up",
  14017. "session.page.down",
  14018. "session.line.up",
  14019. "session.line.down",
  14020. "session.half.page.up",
  14021. "session.half.page.down",
  14022. "session.first",
  14023. "session.last",
  14024. "prompt.clear",
  14025. "prompt.submit",
  14026. "agent.cycle"
  14027. ]
  14028. },
  14029. {
  14030. "type": "string"
  14031. }
  14032. ]
  14033. }
  14034. },
  14035. "required": ["command"],
  14036. "additionalProperties": false
  14037. }
  14038. },
  14039. "required": ["type", "properties"],
  14040. "additionalProperties": false
  14041. },
  14042. "EventTuiToastShow": {
  14043. "type": "object",
  14044. "properties": {
  14045. "type": {
  14046. "type": "string",
  14047. "enum": ["tui.toast.show"]
  14048. },
  14049. "properties": {
  14050. "type": "object",
  14051. "properties": {
  14052. "title": {
  14053. "type": "string"
  14054. },
  14055. "message": {
  14056. "type": "string"
  14057. },
  14058. "variant": {
  14059. "type": "string",
  14060. "enum": ["info", "success", "warning", "error"]
  14061. },
  14062. "duration": {
  14063. "type": "integer",
  14064. "exclusiveMinimum": 0
  14065. }
  14066. },
  14067. "required": ["message", "variant"],
  14068. "additionalProperties": false
  14069. }
  14070. },
  14071. "required": ["type", "properties"],
  14072. "additionalProperties": false
  14073. },
  14074. "EventTuiSessionSelect": {
  14075. "type": "object",
  14076. "properties": {
  14077. "type": {
  14078. "type": "string",
  14079. "enum": ["tui.session.select"]
  14080. },
  14081. "properties": {
  14082. "type": "object",
  14083. "properties": {
  14084. "sessionID": {
  14085. "type": "string",
  14086. "pattern": "^ses",
  14087. "description": "Session ID to navigate to"
  14088. }
  14089. },
  14090. "required": ["sessionID"],
  14091. "additionalProperties": false
  14092. }
  14093. },
  14094. "required": ["type", "properties"],
  14095. "additionalProperties": false
  14096. },
  14097. "Workspace": {
  14098. "type": "object",
  14099. "properties": {
  14100. "id": {
  14101. "type": "string",
  14102. "pattern": "^wrk"
  14103. },
  14104. "type": {
  14105. "type": "string"
  14106. },
  14107. "name": {
  14108. "type": "string"
  14109. },
  14110. "branch": {
  14111. "anyOf": [
  14112. {
  14113. "type": "string"
  14114. },
  14115. {
  14116. "type": "null"
  14117. }
  14118. ]
  14119. },
  14120. "directory": {
  14121. "anyOf": [
  14122. {
  14123. "type": "string"
  14124. },
  14125. {
  14126. "type": "null"
  14127. }
  14128. ]
  14129. },
  14130. "extra": {
  14131. "anyOf": [
  14132. {},
  14133. {
  14134. "type": "null"
  14135. }
  14136. ]
  14137. },
  14138. "projectID": {
  14139. "type": "string"
  14140. },
  14141. "timeUsed": {
  14142. "anyOf": [
  14143. {
  14144. "type": "number"
  14145. },
  14146. {
  14147. "type": "string",
  14148. "enum": ["NaN"]
  14149. },
  14150. {
  14151. "type": "string",
  14152. "enum": ["Infinity"]
  14153. },
  14154. {
  14155. "type": "string",
  14156. "enum": ["-Infinity"]
  14157. },
  14158. {
  14159. "type": "string",
  14160. "enum": ["Infinity", "-Infinity", "NaN"]
  14161. }
  14162. ]
  14163. }
  14164. },
  14165. "required": ["id", "type", "name", "projectID", "timeUsed"],
  14166. "additionalProperties": false
  14167. },
  14168. "WorkspaceWarpError": {
  14169. "type": "object",
  14170. "properties": {
  14171. "name": {
  14172. "type": "string",
  14173. "enum": ["WorkspaceWarpError"]
  14174. },
  14175. "data": {
  14176. "type": "object",
  14177. "properties": {
  14178. "message": {
  14179. "type": "string"
  14180. }
  14181. },
  14182. "required": ["message"],
  14183. "additionalProperties": false
  14184. }
  14185. },
  14186. "required": ["name", "data"],
  14187. "additionalProperties": false
  14188. },
  14189. "SyncEventMessageUpdated": {
  14190. "type": "object",
  14191. "properties": {
  14192. "type": {
  14193. "type": "string",
  14194. "enum": ["sync"]
  14195. },
  14196. "name": {
  14197. "type": "string",
  14198. "enum": ["message.updated.1"]
  14199. },
  14200. "id": {
  14201. "type": "string"
  14202. },
  14203. "seq": {
  14204. "type": "number"
  14205. },
  14206. "aggregateID": {
  14207. "type": "string",
  14208. "enum": ["sessionID"]
  14209. },
  14210. "data": {
  14211. "type": "object",
  14212. "properties": {
  14213. "sessionID": {
  14214. "type": "string",
  14215. "pattern": "^ses"
  14216. },
  14217. "info": {
  14218. "$ref": "#/components/schemas/Message"
  14219. }
  14220. },
  14221. "required": ["sessionID", "info"],
  14222. "additionalProperties": false
  14223. }
  14224. },
  14225. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14226. "additionalProperties": false
  14227. },
  14228. "SyncEventMessageRemoved": {
  14229. "type": "object",
  14230. "properties": {
  14231. "type": {
  14232. "type": "string",
  14233. "enum": ["sync"]
  14234. },
  14235. "name": {
  14236. "type": "string",
  14237. "enum": ["message.removed.1"]
  14238. },
  14239. "id": {
  14240. "type": "string"
  14241. },
  14242. "seq": {
  14243. "type": "number"
  14244. },
  14245. "aggregateID": {
  14246. "type": "string",
  14247. "enum": ["sessionID"]
  14248. },
  14249. "data": {
  14250. "type": "object",
  14251. "properties": {
  14252. "sessionID": {
  14253. "type": "string",
  14254. "pattern": "^ses"
  14255. },
  14256. "messageID": {
  14257. "type": "string",
  14258. "pattern": "^msg"
  14259. }
  14260. },
  14261. "required": ["sessionID", "messageID"],
  14262. "additionalProperties": false
  14263. }
  14264. },
  14265. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14266. "additionalProperties": false
  14267. },
  14268. "SyncEventMessagePartUpdated": {
  14269. "type": "object",
  14270. "properties": {
  14271. "type": {
  14272. "type": "string",
  14273. "enum": ["sync"]
  14274. },
  14275. "name": {
  14276. "type": "string",
  14277. "enum": ["message.part.updated.1"]
  14278. },
  14279. "id": {
  14280. "type": "string"
  14281. },
  14282. "seq": {
  14283. "type": "number"
  14284. },
  14285. "aggregateID": {
  14286. "type": "string",
  14287. "enum": ["sessionID"]
  14288. },
  14289. "data": {
  14290. "type": "object",
  14291. "properties": {
  14292. "sessionID": {
  14293. "type": "string",
  14294. "pattern": "^ses"
  14295. },
  14296. "part": {
  14297. "$ref": "#/components/schemas/Part"
  14298. },
  14299. "time": {
  14300. "type": "integer",
  14301. "minimum": 0
  14302. }
  14303. },
  14304. "required": ["sessionID", "part", "time"],
  14305. "additionalProperties": false
  14306. }
  14307. },
  14308. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14309. "additionalProperties": false
  14310. },
  14311. "SyncEventMessagePartRemoved": {
  14312. "type": "object",
  14313. "properties": {
  14314. "type": {
  14315. "type": "string",
  14316. "enum": ["sync"]
  14317. },
  14318. "name": {
  14319. "type": "string",
  14320. "enum": ["message.part.removed.1"]
  14321. },
  14322. "id": {
  14323. "type": "string"
  14324. },
  14325. "seq": {
  14326. "type": "number"
  14327. },
  14328. "aggregateID": {
  14329. "type": "string",
  14330. "enum": ["sessionID"]
  14331. },
  14332. "data": {
  14333. "type": "object",
  14334. "properties": {
  14335. "sessionID": {
  14336. "type": "string",
  14337. "pattern": "^ses"
  14338. },
  14339. "messageID": {
  14340. "type": "string",
  14341. "pattern": "^msg"
  14342. },
  14343. "partID": {
  14344. "type": "string",
  14345. "pattern": "^prt"
  14346. }
  14347. },
  14348. "required": ["sessionID", "messageID", "partID"],
  14349. "additionalProperties": false
  14350. }
  14351. },
  14352. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14353. "additionalProperties": false
  14354. },
  14355. "SyncEventSessionCreated": {
  14356. "type": "object",
  14357. "properties": {
  14358. "type": {
  14359. "type": "string",
  14360. "enum": ["sync"]
  14361. },
  14362. "name": {
  14363. "type": "string",
  14364. "enum": ["session.created.1"]
  14365. },
  14366. "id": {
  14367. "type": "string"
  14368. },
  14369. "seq": {
  14370. "type": "number"
  14371. },
  14372. "aggregateID": {
  14373. "type": "string",
  14374. "enum": ["sessionID"]
  14375. },
  14376. "data": {
  14377. "type": "object",
  14378. "properties": {
  14379. "sessionID": {
  14380. "type": "string",
  14381. "pattern": "^ses"
  14382. },
  14383. "info": {
  14384. "$ref": "#/components/schemas/Session"
  14385. }
  14386. },
  14387. "required": ["sessionID", "info"],
  14388. "additionalProperties": false
  14389. }
  14390. },
  14391. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14392. "additionalProperties": false
  14393. },
  14394. "SyncEventSessionUpdated": {
  14395. "type": "object",
  14396. "properties": {
  14397. "type": {
  14398. "type": "string",
  14399. "enum": ["sync"]
  14400. },
  14401. "name": {
  14402. "type": "string",
  14403. "enum": ["session.updated.1"]
  14404. },
  14405. "id": {
  14406. "type": "string"
  14407. },
  14408. "seq": {
  14409. "type": "number"
  14410. },
  14411. "aggregateID": {
  14412. "type": "string",
  14413. "enum": ["sessionID"]
  14414. },
  14415. "data": {
  14416. "type": "object",
  14417. "properties": {
  14418. "sessionID": {
  14419. "type": "string",
  14420. "pattern": "^ses"
  14421. },
  14422. "info": {
  14423. "type": "object",
  14424. "properties": {
  14425. "id": {
  14426. "anyOf": [
  14427. {
  14428. "type": "string",
  14429. "pattern": "^ses"
  14430. },
  14431. {
  14432. "type": "null"
  14433. }
  14434. ]
  14435. },
  14436. "slug": {
  14437. "anyOf": [
  14438. {
  14439. "type": "string"
  14440. },
  14441. {
  14442. "type": "null"
  14443. }
  14444. ]
  14445. },
  14446. "projectID": {
  14447. "anyOf": [
  14448. {
  14449. "type": "string"
  14450. },
  14451. {
  14452. "type": "null"
  14453. }
  14454. ]
  14455. },
  14456. "workspaceID": {
  14457. "anyOf": [
  14458. {
  14459. "type": "string",
  14460. "pattern": "^wrk"
  14461. },
  14462. {
  14463. "type": "null"
  14464. }
  14465. ]
  14466. },
  14467. "directory": {
  14468. "anyOf": [
  14469. {
  14470. "type": "string"
  14471. },
  14472. {
  14473. "type": "null"
  14474. }
  14475. ]
  14476. },
  14477. "path": {
  14478. "anyOf": [
  14479. {
  14480. "type": "string"
  14481. },
  14482. {
  14483. "type": "null"
  14484. }
  14485. ]
  14486. },
  14487. "parentID": {
  14488. "anyOf": [
  14489. {
  14490. "type": "string",
  14491. "pattern": "^ses"
  14492. },
  14493. {
  14494. "type": "null"
  14495. }
  14496. ]
  14497. },
  14498. "summary": {
  14499. "anyOf": [
  14500. {
  14501. "type": "object",
  14502. "properties": {
  14503. "additions": {
  14504. "type": "number"
  14505. },
  14506. "deletions": {
  14507. "type": "number"
  14508. },
  14509. "files": {
  14510. "type": "number"
  14511. },
  14512. "diffs": {
  14513. "type": "array",
  14514. "items": {
  14515. "$ref": "#/components/schemas/SnapshotFileDiff"
  14516. }
  14517. }
  14518. },
  14519. "required": ["additions", "deletions", "files"],
  14520. "additionalProperties": false
  14521. },
  14522. {
  14523. "type": "null"
  14524. }
  14525. ]
  14526. },
  14527. "cost": {
  14528. "anyOf": [
  14529. {
  14530. "type": "number"
  14531. },
  14532. {
  14533. "type": "null"
  14534. }
  14535. ]
  14536. },
  14537. "tokens": {
  14538. "anyOf": [
  14539. {
  14540. "type": "object",
  14541. "properties": {
  14542. "input": {
  14543. "type": "number"
  14544. },
  14545. "output": {
  14546. "type": "number"
  14547. },
  14548. "reasoning": {
  14549. "type": "number"
  14550. },
  14551. "cache": {
  14552. "type": "object",
  14553. "properties": {
  14554. "read": {
  14555. "type": "number"
  14556. },
  14557. "write": {
  14558. "type": "number"
  14559. }
  14560. },
  14561. "required": ["read", "write"],
  14562. "additionalProperties": false
  14563. }
  14564. },
  14565. "required": ["input", "output", "reasoning", "cache"],
  14566. "additionalProperties": false
  14567. },
  14568. {
  14569. "type": "null"
  14570. }
  14571. ]
  14572. },
  14573. "share": {
  14574. "type": "object",
  14575. "properties": {
  14576. "url": {
  14577. "anyOf": [
  14578. {
  14579. "type": "string"
  14580. },
  14581. {
  14582. "type": "null"
  14583. }
  14584. ]
  14585. }
  14586. },
  14587. "additionalProperties": false
  14588. },
  14589. "title": {
  14590. "anyOf": [
  14591. {
  14592. "type": "string"
  14593. },
  14594. {
  14595. "type": "null"
  14596. }
  14597. ]
  14598. },
  14599. "agent": {
  14600. "anyOf": [
  14601. {
  14602. "type": "string"
  14603. },
  14604. {
  14605. "type": "null"
  14606. }
  14607. ]
  14608. },
  14609. "model": {
  14610. "anyOf": [
  14611. {
  14612. "type": "object",
  14613. "properties": {
  14614. "id": {
  14615. "type": "string"
  14616. },
  14617. "providerID": {
  14618. "type": "string"
  14619. },
  14620. "variant": {
  14621. "type": "string"
  14622. }
  14623. },
  14624. "required": ["id", "providerID"],
  14625. "additionalProperties": false
  14626. },
  14627. {
  14628. "type": "null"
  14629. }
  14630. ]
  14631. },
  14632. "version": {
  14633. "anyOf": [
  14634. {
  14635. "type": "string"
  14636. },
  14637. {
  14638. "type": "null"
  14639. }
  14640. ]
  14641. },
  14642. "time": {
  14643. "type": "object",
  14644. "properties": {
  14645. "created": {
  14646. "anyOf": [
  14647. {
  14648. "type": "integer",
  14649. "minimum": 0
  14650. },
  14651. {
  14652. "type": "null"
  14653. }
  14654. ]
  14655. },
  14656. "updated": {
  14657. "anyOf": [
  14658. {
  14659. "type": "integer",
  14660. "minimum": 0
  14661. },
  14662. {
  14663. "type": "null"
  14664. }
  14665. ]
  14666. },
  14667. "compacting": {
  14668. "anyOf": [
  14669. {
  14670. "type": "integer",
  14671. "minimum": 0
  14672. },
  14673. {
  14674. "type": "null"
  14675. }
  14676. ]
  14677. },
  14678. "archived": {
  14679. "anyOf": [
  14680. {
  14681. "type": "number"
  14682. },
  14683. {
  14684. "type": "null"
  14685. }
  14686. ]
  14687. }
  14688. },
  14689. "additionalProperties": false
  14690. },
  14691. "permission": {
  14692. "anyOf": [
  14693. {
  14694. "$ref": "#/components/schemas/PermissionRuleset"
  14695. },
  14696. {
  14697. "type": "null"
  14698. }
  14699. ]
  14700. },
  14701. "revert": {
  14702. "anyOf": [
  14703. {
  14704. "type": "object",
  14705. "properties": {
  14706. "messageID": {
  14707. "type": "string",
  14708. "pattern": "^msg"
  14709. },
  14710. "partID": {
  14711. "type": "string",
  14712. "pattern": "^prt"
  14713. },
  14714. "snapshot": {
  14715. "type": "string"
  14716. },
  14717. "diff": {
  14718. "type": "string"
  14719. }
  14720. },
  14721. "required": ["messageID"],
  14722. "additionalProperties": false
  14723. },
  14724. {
  14725. "type": "null"
  14726. }
  14727. ]
  14728. }
  14729. },
  14730. "additionalProperties": false
  14731. }
  14732. },
  14733. "required": ["sessionID", "info"],
  14734. "additionalProperties": false
  14735. }
  14736. },
  14737. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14738. "additionalProperties": false
  14739. },
  14740. "SyncEventSessionDeleted": {
  14741. "type": "object",
  14742. "properties": {
  14743. "type": {
  14744. "type": "string",
  14745. "enum": ["sync"]
  14746. },
  14747. "name": {
  14748. "type": "string",
  14749. "enum": ["session.deleted.1"]
  14750. },
  14751. "id": {
  14752. "type": "string"
  14753. },
  14754. "seq": {
  14755. "type": "number"
  14756. },
  14757. "aggregateID": {
  14758. "type": "string",
  14759. "enum": ["sessionID"]
  14760. },
  14761. "data": {
  14762. "type": "object",
  14763. "properties": {
  14764. "sessionID": {
  14765. "type": "string",
  14766. "pattern": "^ses"
  14767. },
  14768. "info": {
  14769. "$ref": "#/components/schemas/Session"
  14770. }
  14771. },
  14772. "required": ["sessionID", "info"],
  14773. "additionalProperties": false
  14774. }
  14775. },
  14776. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14777. "additionalProperties": false
  14778. },
  14779. "SyncEventSessionNextAgentSwitched": {
  14780. "type": "object",
  14781. "properties": {
  14782. "type": {
  14783. "type": "string",
  14784. "enum": ["sync"]
  14785. },
  14786. "name": {
  14787. "type": "string",
  14788. "enum": ["session.next.agent.switched.1"]
  14789. },
  14790. "id": {
  14791. "type": "string"
  14792. },
  14793. "seq": {
  14794. "type": "number"
  14795. },
  14796. "aggregateID": {
  14797. "type": "string",
  14798. "enum": ["sessionID"]
  14799. },
  14800. "data": {
  14801. "type": "object",
  14802. "properties": {
  14803. "timestamp": {
  14804. "type": "number"
  14805. },
  14806. "sessionID": {
  14807. "type": "string",
  14808. "pattern": "^ses"
  14809. },
  14810. "agent": {
  14811. "type": "string"
  14812. }
  14813. },
  14814. "required": ["timestamp", "sessionID", "agent"],
  14815. "additionalProperties": false
  14816. }
  14817. },
  14818. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14819. "additionalProperties": false
  14820. },
  14821. "SyncEventSessionNextModelSwitched": {
  14822. "type": "object",
  14823. "properties": {
  14824. "type": {
  14825. "type": "string",
  14826. "enum": ["sync"]
  14827. },
  14828. "name": {
  14829. "type": "string",
  14830. "enum": ["session.next.model.switched.1"]
  14831. },
  14832. "id": {
  14833. "type": "string"
  14834. },
  14835. "seq": {
  14836. "type": "number"
  14837. },
  14838. "aggregateID": {
  14839. "type": "string",
  14840. "enum": ["sessionID"]
  14841. },
  14842. "data": {
  14843. "type": "object",
  14844. "properties": {
  14845. "timestamp": {
  14846. "type": "number"
  14847. },
  14848. "sessionID": {
  14849. "type": "string",
  14850. "pattern": "^ses"
  14851. },
  14852. "model": {
  14853. "type": "object",
  14854. "properties": {
  14855. "id": {
  14856. "type": "string"
  14857. },
  14858. "providerID": {
  14859. "type": "string"
  14860. },
  14861. "variant": {
  14862. "type": "string"
  14863. }
  14864. },
  14865. "required": ["id", "providerID", "variant"],
  14866. "additionalProperties": false
  14867. }
  14868. },
  14869. "required": ["timestamp", "sessionID", "model"],
  14870. "additionalProperties": false
  14871. }
  14872. },
  14873. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14874. "additionalProperties": false
  14875. },
  14876. "SyncEventSessionNextPrompted": {
  14877. "type": "object",
  14878. "properties": {
  14879. "type": {
  14880. "type": "string",
  14881. "enum": ["sync"]
  14882. },
  14883. "name": {
  14884. "type": "string",
  14885. "enum": ["session.next.prompted.1"]
  14886. },
  14887. "id": {
  14888. "type": "string"
  14889. },
  14890. "seq": {
  14891. "type": "number"
  14892. },
  14893. "aggregateID": {
  14894. "type": "string",
  14895. "enum": ["sessionID"]
  14896. },
  14897. "data": {
  14898. "type": "object",
  14899. "properties": {
  14900. "timestamp": {
  14901. "type": "number"
  14902. },
  14903. "sessionID": {
  14904. "type": "string",
  14905. "pattern": "^ses"
  14906. },
  14907. "prompt": {
  14908. "$ref": "#/components/schemas/Prompt"
  14909. }
  14910. },
  14911. "required": ["timestamp", "sessionID", "prompt"],
  14912. "additionalProperties": false
  14913. }
  14914. },
  14915. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14916. "additionalProperties": false
  14917. },
  14918. "SyncEventSessionNextSynthetic": {
  14919. "type": "object",
  14920. "properties": {
  14921. "type": {
  14922. "type": "string",
  14923. "enum": ["sync"]
  14924. },
  14925. "name": {
  14926. "type": "string",
  14927. "enum": ["session.next.synthetic.1"]
  14928. },
  14929. "id": {
  14930. "type": "string"
  14931. },
  14932. "seq": {
  14933. "type": "number"
  14934. },
  14935. "aggregateID": {
  14936. "type": "string",
  14937. "enum": ["sessionID"]
  14938. },
  14939. "data": {
  14940. "type": "object",
  14941. "properties": {
  14942. "timestamp": {
  14943. "type": "number"
  14944. },
  14945. "sessionID": {
  14946. "type": "string",
  14947. "pattern": "^ses"
  14948. },
  14949. "text": {
  14950. "type": "string"
  14951. }
  14952. },
  14953. "required": ["timestamp", "sessionID", "text"],
  14954. "additionalProperties": false
  14955. }
  14956. },
  14957. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  14958. "additionalProperties": false
  14959. },
  14960. "SyncEventSessionNextShellStarted": {
  14961. "type": "object",
  14962. "properties": {
  14963. "type": {
  14964. "type": "string",
  14965. "enum": ["sync"]
  14966. },
  14967. "name": {
  14968. "type": "string",
  14969. "enum": ["session.next.shell.started.1"]
  14970. },
  14971. "id": {
  14972. "type": "string"
  14973. },
  14974. "seq": {
  14975. "type": "number"
  14976. },
  14977. "aggregateID": {
  14978. "type": "string",
  14979. "enum": ["sessionID"]
  14980. },
  14981. "data": {
  14982. "type": "object",
  14983. "properties": {
  14984. "timestamp": {
  14985. "type": "number"
  14986. },
  14987. "sessionID": {
  14988. "type": "string",
  14989. "pattern": "^ses"
  14990. },
  14991. "callID": {
  14992. "type": "string"
  14993. },
  14994. "command": {
  14995. "type": "string"
  14996. }
  14997. },
  14998. "required": ["timestamp", "sessionID", "callID", "command"],
  14999. "additionalProperties": false
  15000. }
  15001. },
  15002. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15003. "additionalProperties": false
  15004. },
  15005. "SyncEventSessionNextShellEnded": {
  15006. "type": "object",
  15007. "properties": {
  15008. "type": {
  15009. "type": "string",
  15010. "enum": ["sync"]
  15011. },
  15012. "name": {
  15013. "type": "string",
  15014. "enum": ["session.next.shell.ended.1"]
  15015. },
  15016. "id": {
  15017. "type": "string"
  15018. },
  15019. "seq": {
  15020. "type": "number"
  15021. },
  15022. "aggregateID": {
  15023. "type": "string",
  15024. "enum": ["sessionID"]
  15025. },
  15026. "data": {
  15027. "type": "object",
  15028. "properties": {
  15029. "timestamp": {
  15030. "type": "number"
  15031. },
  15032. "sessionID": {
  15033. "type": "string",
  15034. "pattern": "^ses"
  15035. },
  15036. "callID": {
  15037. "type": "string"
  15038. },
  15039. "output": {
  15040. "type": "string"
  15041. }
  15042. },
  15043. "required": ["timestamp", "sessionID", "callID", "output"],
  15044. "additionalProperties": false
  15045. }
  15046. },
  15047. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15048. "additionalProperties": false
  15049. },
  15050. "SyncEventSessionNextStepStarted": {
  15051. "type": "object",
  15052. "properties": {
  15053. "type": {
  15054. "type": "string",
  15055. "enum": ["sync"]
  15056. },
  15057. "name": {
  15058. "type": "string",
  15059. "enum": ["session.next.step.started.1"]
  15060. },
  15061. "id": {
  15062. "type": "string"
  15063. },
  15064. "seq": {
  15065. "type": "number"
  15066. },
  15067. "aggregateID": {
  15068. "type": "string",
  15069. "enum": ["sessionID"]
  15070. },
  15071. "data": {
  15072. "type": "object",
  15073. "properties": {
  15074. "timestamp": {
  15075. "type": "number"
  15076. },
  15077. "sessionID": {
  15078. "type": "string",
  15079. "pattern": "^ses"
  15080. },
  15081. "agent": {
  15082. "type": "string"
  15083. },
  15084. "model": {
  15085. "type": "object",
  15086. "properties": {
  15087. "id": {
  15088. "type": "string"
  15089. },
  15090. "providerID": {
  15091. "type": "string"
  15092. },
  15093. "variant": {
  15094. "type": "string"
  15095. }
  15096. },
  15097. "required": ["id", "providerID", "variant"],
  15098. "additionalProperties": false
  15099. },
  15100. "snapshot": {
  15101. "type": "string"
  15102. }
  15103. },
  15104. "required": ["timestamp", "sessionID", "agent", "model"],
  15105. "additionalProperties": false
  15106. }
  15107. },
  15108. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15109. "additionalProperties": false
  15110. },
  15111. "SyncEventSessionNextStepEnded": {
  15112. "type": "object",
  15113. "properties": {
  15114. "type": {
  15115. "type": "string",
  15116. "enum": ["sync"]
  15117. },
  15118. "name": {
  15119. "type": "string",
  15120. "enum": ["session.next.step.ended.1"]
  15121. },
  15122. "id": {
  15123. "type": "string"
  15124. },
  15125. "seq": {
  15126. "type": "number"
  15127. },
  15128. "aggregateID": {
  15129. "type": "string",
  15130. "enum": ["sessionID"]
  15131. },
  15132. "data": {
  15133. "type": "object",
  15134. "properties": {
  15135. "timestamp": {
  15136. "type": "number"
  15137. },
  15138. "sessionID": {
  15139. "type": "string",
  15140. "pattern": "^ses"
  15141. },
  15142. "finish": {
  15143. "type": "string"
  15144. },
  15145. "cost": {
  15146. "type": "number"
  15147. },
  15148. "tokens": {
  15149. "type": "object",
  15150. "properties": {
  15151. "input": {
  15152. "type": "number"
  15153. },
  15154. "output": {
  15155. "type": "number"
  15156. },
  15157. "reasoning": {
  15158. "type": "number"
  15159. },
  15160. "cache": {
  15161. "type": "object",
  15162. "properties": {
  15163. "read": {
  15164. "type": "number"
  15165. },
  15166. "write": {
  15167. "type": "number"
  15168. }
  15169. },
  15170. "required": ["read", "write"],
  15171. "additionalProperties": false
  15172. }
  15173. },
  15174. "required": ["input", "output", "reasoning", "cache"],
  15175. "additionalProperties": false
  15176. },
  15177. "snapshot": {
  15178. "type": "string"
  15179. }
  15180. },
  15181. "required": ["timestamp", "sessionID", "finish", "cost", "tokens"],
  15182. "additionalProperties": false
  15183. }
  15184. },
  15185. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15186. "additionalProperties": false
  15187. },
  15188. "SyncEventSessionNextStepFailed": {
  15189. "type": "object",
  15190. "properties": {
  15191. "type": {
  15192. "type": "string",
  15193. "enum": ["sync"]
  15194. },
  15195. "name": {
  15196. "type": "string",
  15197. "enum": ["session.next.step.failed.1"]
  15198. },
  15199. "id": {
  15200. "type": "string"
  15201. },
  15202. "seq": {
  15203. "type": "number"
  15204. },
  15205. "aggregateID": {
  15206. "type": "string",
  15207. "enum": ["sessionID"]
  15208. },
  15209. "data": {
  15210. "type": "object",
  15211. "properties": {
  15212. "timestamp": {
  15213. "type": "number"
  15214. },
  15215. "sessionID": {
  15216. "type": "string",
  15217. "pattern": "^ses"
  15218. },
  15219. "error": {
  15220. "$ref": "#/components/schemas/SessionErrorUnknown"
  15221. }
  15222. },
  15223. "required": ["timestamp", "sessionID", "error"],
  15224. "additionalProperties": false
  15225. }
  15226. },
  15227. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15228. "additionalProperties": false
  15229. },
  15230. "SyncEventSessionNextTextStarted": {
  15231. "type": "object",
  15232. "properties": {
  15233. "type": {
  15234. "type": "string",
  15235. "enum": ["sync"]
  15236. },
  15237. "name": {
  15238. "type": "string",
  15239. "enum": ["session.next.text.started.1"]
  15240. },
  15241. "id": {
  15242. "type": "string"
  15243. },
  15244. "seq": {
  15245. "type": "number"
  15246. },
  15247. "aggregateID": {
  15248. "type": "string",
  15249. "enum": ["sessionID"]
  15250. },
  15251. "data": {
  15252. "type": "object",
  15253. "properties": {
  15254. "timestamp": {
  15255. "type": "number"
  15256. },
  15257. "sessionID": {
  15258. "type": "string",
  15259. "pattern": "^ses"
  15260. }
  15261. },
  15262. "required": ["timestamp", "sessionID"],
  15263. "additionalProperties": false
  15264. }
  15265. },
  15266. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15267. "additionalProperties": false
  15268. },
  15269. "SyncEventSessionNextTextDelta": {
  15270. "type": "object",
  15271. "properties": {
  15272. "type": {
  15273. "type": "string",
  15274. "enum": ["sync"]
  15275. },
  15276. "name": {
  15277. "type": "string",
  15278. "enum": ["session.next.text.delta.1"]
  15279. },
  15280. "id": {
  15281. "type": "string"
  15282. },
  15283. "seq": {
  15284. "type": "number"
  15285. },
  15286. "aggregateID": {
  15287. "type": "string",
  15288. "enum": ["sessionID"]
  15289. },
  15290. "data": {
  15291. "type": "object",
  15292. "properties": {
  15293. "timestamp": {
  15294. "type": "number"
  15295. },
  15296. "sessionID": {
  15297. "type": "string",
  15298. "pattern": "^ses"
  15299. },
  15300. "delta": {
  15301. "type": "string"
  15302. }
  15303. },
  15304. "required": ["timestamp", "sessionID", "delta"],
  15305. "additionalProperties": false
  15306. }
  15307. },
  15308. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15309. "additionalProperties": false
  15310. },
  15311. "SyncEventSessionNextTextEnded": {
  15312. "type": "object",
  15313. "properties": {
  15314. "type": {
  15315. "type": "string",
  15316. "enum": ["sync"]
  15317. },
  15318. "name": {
  15319. "type": "string",
  15320. "enum": ["session.next.text.ended.1"]
  15321. },
  15322. "id": {
  15323. "type": "string"
  15324. },
  15325. "seq": {
  15326. "type": "number"
  15327. },
  15328. "aggregateID": {
  15329. "type": "string",
  15330. "enum": ["sessionID"]
  15331. },
  15332. "data": {
  15333. "type": "object",
  15334. "properties": {
  15335. "timestamp": {
  15336. "type": "number"
  15337. },
  15338. "sessionID": {
  15339. "type": "string",
  15340. "pattern": "^ses"
  15341. },
  15342. "text": {
  15343. "type": "string"
  15344. }
  15345. },
  15346. "required": ["timestamp", "sessionID", "text"],
  15347. "additionalProperties": false
  15348. }
  15349. },
  15350. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15351. "additionalProperties": false
  15352. },
  15353. "SyncEventSessionNextReasoningStarted": {
  15354. "type": "object",
  15355. "properties": {
  15356. "type": {
  15357. "type": "string",
  15358. "enum": ["sync"]
  15359. },
  15360. "name": {
  15361. "type": "string",
  15362. "enum": ["session.next.reasoning.started.1"]
  15363. },
  15364. "id": {
  15365. "type": "string"
  15366. },
  15367. "seq": {
  15368. "type": "number"
  15369. },
  15370. "aggregateID": {
  15371. "type": "string",
  15372. "enum": ["sessionID"]
  15373. },
  15374. "data": {
  15375. "type": "object",
  15376. "properties": {
  15377. "timestamp": {
  15378. "type": "number"
  15379. },
  15380. "sessionID": {
  15381. "type": "string",
  15382. "pattern": "^ses"
  15383. },
  15384. "reasoningID": {
  15385. "type": "string"
  15386. }
  15387. },
  15388. "required": ["timestamp", "sessionID", "reasoningID"],
  15389. "additionalProperties": false
  15390. }
  15391. },
  15392. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15393. "additionalProperties": false
  15394. },
  15395. "SyncEventSessionNextReasoningDelta": {
  15396. "type": "object",
  15397. "properties": {
  15398. "type": {
  15399. "type": "string",
  15400. "enum": ["sync"]
  15401. },
  15402. "name": {
  15403. "type": "string",
  15404. "enum": ["session.next.reasoning.delta.1"]
  15405. },
  15406. "id": {
  15407. "type": "string"
  15408. },
  15409. "seq": {
  15410. "type": "number"
  15411. },
  15412. "aggregateID": {
  15413. "type": "string",
  15414. "enum": ["sessionID"]
  15415. },
  15416. "data": {
  15417. "type": "object",
  15418. "properties": {
  15419. "timestamp": {
  15420. "type": "number"
  15421. },
  15422. "sessionID": {
  15423. "type": "string",
  15424. "pattern": "^ses"
  15425. },
  15426. "reasoningID": {
  15427. "type": "string"
  15428. },
  15429. "delta": {
  15430. "type": "string"
  15431. }
  15432. },
  15433. "required": ["timestamp", "sessionID", "reasoningID", "delta"],
  15434. "additionalProperties": false
  15435. }
  15436. },
  15437. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15438. "additionalProperties": false
  15439. },
  15440. "SyncEventSessionNextReasoningEnded": {
  15441. "type": "object",
  15442. "properties": {
  15443. "type": {
  15444. "type": "string",
  15445. "enum": ["sync"]
  15446. },
  15447. "name": {
  15448. "type": "string",
  15449. "enum": ["session.next.reasoning.ended.1"]
  15450. },
  15451. "id": {
  15452. "type": "string"
  15453. },
  15454. "seq": {
  15455. "type": "number"
  15456. },
  15457. "aggregateID": {
  15458. "type": "string",
  15459. "enum": ["sessionID"]
  15460. },
  15461. "data": {
  15462. "type": "object",
  15463. "properties": {
  15464. "timestamp": {
  15465. "type": "number"
  15466. },
  15467. "sessionID": {
  15468. "type": "string",
  15469. "pattern": "^ses"
  15470. },
  15471. "reasoningID": {
  15472. "type": "string"
  15473. },
  15474. "text": {
  15475. "type": "string"
  15476. }
  15477. },
  15478. "required": ["timestamp", "sessionID", "reasoningID", "text"],
  15479. "additionalProperties": false
  15480. }
  15481. },
  15482. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15483. "additionalProperties": false
  15484. },
  15485. "SyncEventSessionNextToolInputStarted": {
  15486. "type": "object",
  15487. "properties": {
  15488. "type": {
  15489. "type": "string",
  15490. "enum": ["sync"]
  15491. },
  15492. "name": {
  15493. "type": "string",
  15494. "enum": ["session.next.tool.input.started.1"]
  15495. },
  15496. "id": {
  15497. "type": "string"
  15498. },
  15499. "seq": {
  15500. "type": "number"
  15501. },
  15502. "aggregateID": {
  15503. "type": "string",
  15504. "enum": ["sessionID"]
  15505. },
  15506. "data": {
  15507. "type": "object",
  15508. "properties": {
  15509. "timestamp": {
  15510. "type": "number"
  15511. },
  15512. "sessionID": {
  15513. "type": "string",
  15514. "pattern": "^ses"
  15515. },
  15516. "callID": {
  15517. "type": "string"
  15518. },
  15519. "name": {
  15520. "type": "string"
  15521. }
  15522. },
  15523. "required": ["timestamp", "sessionID", "callID", "name"],
  15524. "additionalProperties": false
  15525. }
  15526. },
  15527. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15528. "additionalProperties": false
  15529. },
  15530. "SyncEventSessionNextToolInputDelta": {
  15531. "type": "object",
  15532. "properties": {
  15533. "type": {
  15534. "type": "string",
  15535. "enum": ["sync"]
  15536. },
  15537. "name": {
  15538. "type": "string",
  15539. "enum": ["session.next.tool.input.delta.1"]
  15540. },
  15541. "id": {
  15542. "type": "string"
  15543. },
  15544. "seq": {
  15545. "type": "number"
  15546. },
  15547. "aggregateID": {
  15548. "type": "string",
  15549. "enum": ["sessionID"]
  15550. },
  15551. "data": {
  15552. "type": "object",
  15553. "properties": {
  15554. "timestamp": {
  15555. "type": "number"
  15556. },
  15557. "sessionID": {
  15558. "type": "string",
  15559. "pattern": "^ses"
  15560. },
  15561. "callID": {
  15562. "type": "string"
  15563. },
  15564. "delta": {
  15565. "type": "string"
  15566. }
  15567. },
  15568. "required": ["timestamp", "sessionID", "callID", "delta"],
  15569. "additionalProperties": false
  15570. }
  15571. },
  15572. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15573. "additionalProperties": false
  15574. },
  15575. "SyncEventSessionNextToolInputEnded": {
  15576. "type": "object",
  15577. "properties": {
  15578. "type": {
  15579. "type": "string",
  15580. "enum": ["sync"]
  15581. },
  15582. "name": {
  15583. "type": "string",
  15584. "enum": ["session.next.tool.input.ended.1"]
  15585. },
  15586. "id": {
  15587. "type": "string"
  15588. },
  15589. "seq": {
  15590. "type": "number"
  15591. },
  15592. "aggregateID": {
  15593. "type": "string",
  15594. "enum": ["sessionID"]
  15595. },
  15596. "data": {
  15597. "type": "object",
  15598. "properties": {
  15599. "timestamp": {
  15600. "type": "number"
  15601. },
  15602. "sessionID": {
  15603. "type": "string",
  15604. "pattern": "^ses"
  15605. },
  15606. "callID": {
  15607. "type": "string"
  15608. },
  15609. "text": {
  15610. "type": "string"
  15611. }
  15612. },
  15613. "required": ["timestamp", "sessionID", "callID", "text"],
  15614. "additionalProperties": false
  15615. }
  15616. },
  15617. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15618. "additionalProperties": false
  15619. },
  15620. "SyncEventSessionNextToolCalled": {
  15621. "type": "object",
  15622. "properties": {
  15623. "type": {
  15624. "type": "string",
  15625. "enum": ["sync"]
  15626. },
  15627. "name": {
  15628. "type": "string",
  15629. "enum": ["session.next.tool.called.1"]
  15630. },
  15631. "id": {
  15632. "type": "string"
  15633. },
  15634. "seq": {
  15635. "type": "number"
  15636. },
  15637. "aggregateID": {
  15638. "type": "string",
  15639. "enum": ["sessionID"]
  15640. },
  15641. "data": {
  15642. "type": "object",
  15643. "properties": {
  15644. "timestamp": {
  15645. "type": "number"
  15646. },
  15647. "sessionID": {
  15648. "type": "string",
  15649. "pattern": "^ses"
  15650. },
  15651. "callID": {
  15652. "type": "string"
  15653. },
  15654. "tool": {
  15655. "type": "string"
  15656. },
  15657. "input": {
  15658. "type": "object"
  15659. },
  15660. "provider": {
  15661. "type": "object",
  15662. "properties": {
  15663. "executed": {
  15664. "type": "boolean"
  15665. },
  15666. "metadata": {
  15667. "type": "object"
  15668. }
  15669. },
  15670. "required": ["executed"],
  15671. "additionalProperties": false
  15672. }
  15673. },
  15674. "required": ["timestamp", "sessionID", "callID", "tool", "input", "provider"],
  15675. "additionalProperties": false
  15676. }
  15677. },
  15678. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15679. "additionalProperties": false
  15680. },
  15681. "SyncEventSessionNextToolProgress": {
  15682. "type": "object",
  15683. "properties": {
  15684. "type": {
  15685. "type": "string",
  15686. "enum": ["sync"]
  15687. },
  15688. "name": {
  15689. "type": "string",
  15690. "enum": ["session.next.tool.progress.1"]
  15691. },
  15692. "id": {
  15693. "type": "string"
  15694. },
  15695. "seq": {
  15696. "type": "number"
  15697. },
  15698. "aggregateID": {
  15699. "type": "string",
  15700. "enum": ["sessionID"]
  15701. },
  15702. "data": {
  15703. "type": "object",
  15704. "properties": {
  15705. "timestamp": {
  15706. "type": "number"
  15707. },
  15708. "sessionID": {
  15709. "type": "string",
  15710. "pattern": "^ses"
  15711. },
  15712. "callID": {
  15713. "type": "string"
  15714. },
  15715. "structured": {
  15716. "type": "object"
  15717. },
  15718. "content": {
  15719. "type": "array",
  15720. "items": {
  15721. "anyOf": [
  15722. {
  15723. "$ref": "#/components/schemas/ToolTextContent"
  15724. },
  15725. {
  15726. "$ref": "#/components/schemas/ToolFileContent"
  15727. }
  15728. ]
  15729. }
  15730. }
  15731. },
  15732. "required": ["timestamp", "sessionID", "callID", "structured", "content"],
  15733. "additionalProperties": false
  15734. }
  15735. },
  15736. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15737. "additionalProperties": false
  15738. },
  15739. "SyncEventSessionNextToolSuccess": {
  15740. "type": "object",
  15741. "properties": {
  15742. "type": {
  15743. "type": "string",
  15744. "enum": ["sync"]
  15745. },
  15746. "name": {
  15747. "type": "string",
  15748. "enum": ["session.next.tool.success.1"]
  15749. },
  15750. "id": {
  15751. "type": "string"
  15752. },
  15753. "seq": {
  15754. "type": "number"
  15755. },
  15756. "aggregateID": {
  15757. "type": "string",
  15758. "enum": ["sessionID"]
  15759. },
  15760. "data": {
  15761. "type": "object",
  15762. "properties": {
  15763. "timestamp": {
  15764. "type": "number"
  15765. },
  15766. "sessionID": {
  15767. "type": "string",
  15768. "pattern": "^ses"
  15769. },
  15770. "callID": {
  15771. "type": "string"
  15772. },
  15773. "structured": {
  15774. "type": "object"
  15775. },
  15776. "content": {
  15777. "type": "array",
  15778. "items": {
  15779. "anyOf": [
  15780. {
  15781. "$ref": "#/components/schemas/ToolTextContent"
  15782. },
  15783. {
  15784. "$ref": "#/components/schemas/ToolFileContent"
  15785. }
  15786. ]
  15787. }
  15788. },
  15789. "provider": {
  15790. "type": "object",
  15791. "properties": {
  15792. "executed": {
  15793. "type": "boolean"
  15794. },
  15795. "metadata": {
  15796. "type": "object"
  15797. }
  15798. },
  15799. "required": ["executed"],
  15800. "additionalProperties": false
  15801. }
  15802. },
  15803. "required": ["timestamp", "sessionID", "callID", "structured", "content", "provider"],
  15804. "additionalProperties": false
  15805. }
  15806. },
  15807. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15808. "additionalProperties": false
  15809. },
  15810. "SyncEventSessionNextToolFailed": {
  15811. "type": "object",
  15812. "properties": {
  15813. "type": {
  15814. "type": "string",
  15815. "enum": ["sync"]
  15816. },
  15817. "name": {
  15818. "type": "string",
  15819. "enum": ["session.next.tool.failed.1"]
  15820. },
  15821. "id": {
  15822. "type": "string"
  15823. },
  15824. "seq": {
  15825. "type": "number"
  15826. },
  15827. "aggregateID": {
  15828. "type": "string",
  15829. "enum": ["sessionID"]
  15830. },
  15831. "data": {
  15832. "type": "object",
  15833. "properties": {
  15834. "timestamp": {
  15835. "type": "number"
  15836. },
  15837. "sessionID": {
  15838. "type": "string",
  15839. "pattern": "^ses"
  15840. },
  15841. "callID": {
  15842. "type": "string"
  15843. },
  15844. "error": {
  15845. "$ref": "#/components/schemas/SessionErrorUnknown"
  15846. },
  15847. "provider": {
  15848. "type": "object",
  15849. "properties": {
  15850. "executed": {
  15851. "type": "boolean"
  15852. },
  15853. "metadata": {
  15854. "type": "object"
  15855. }
  15856. },
  15857. "required": ["executed"],
  15858. "additionalProperties": false
  15859. }
  15860. },
  15861. "required": ["timestamp", "sessionID", "callID", "error", "provider"],
  15862. "additionalProperties": false
  15863. }
  15864. },
  15865. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15866. "additionalProperties": false
  15867. },
  15868. "SyncEventSessionNextRetried": {
  15869. "type": "object",
  15870. "properties": {
  15871. "type": {
  15872. "type": "string",
  15873. "enum": ["sync"]
  15874. },
  15875. "name": {
  15876. "type": "string",
  15877. "enum": ["session.next.retried.1"]
  15878. },
  15879. "id": {
  15880. "type": "string"
  15881. },
  15882. "seq": {
  15883. "type": "number"
  15884. },
  15885. "aggregateID": {
  15886. "type": "string",
  15887. "enum": ["sessionID"]
  15888. },
  15889. "data": {
  15890. "type": "object",
  15891. "properties": {
  15892. "timestamp": {
  15893. "type": "number"
  15894. },
  15895. "sessionID": {
  15896. "type": "string",
  15897. "pattern": "^ses"
  15898. },
  15899. "attempt": {
  15900. "type": "number"
  15901. },
  15902. "error": {
  15903. "$ref": "#/components/schemas/SessionNextRetry_error"
  15904. }
  15905. },
  15906. "required": ["timestamp", "sessionID", "attempt", "error"],
  15907. "additionalProperties": false
  15908. }
  15909. },
  15910. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15911. "additionalProperties": false
  15912. },
  15913. "SyncEventSessionNextCompactionStarted": {
  15914. "type": "object",
  15915. "properties": {
  15916. "type": {
  15917. "type": "string",
  15918. "enum": ["sync"]
  15919. },
  15920. "name": {
  15921. "type": "string",
  15922. "enum": ["session.next.compaction.started.1"]
  15923. },
  15924. "id": {
  15925. "type": "string"
  15926. },
  15927. "seq": {
  15928. "type": "number"
  15929. },
  15930. "aggregateID": {
  15931. "type": "string",
  15932. "enum": ["sessionID"]
  15933. },
  15934. "data": {
  15935. "type": "object",
  15936. "properties": {
  15937. "timestamp": {
  15938. "type": "number"
  15939. },
  15940. "sessionID": {
  15941. "type": "string",
  15942. "pattern": "^ses"
  15943. },
  15944. "reason": {
  15945. "type": "string",
  15946. "enum": ["auto", "manual"]
  15947. }
  15948. },
  15949. "required": ["timestamp", "sessionID", "reason"],
  15950. "additionalProperties": false
  15951. }
  15952. },
  15953. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15954. "additionalProperties": false
  15955. },
  15956. "SyncEventSessionNextCompactionDelta": {
  15957. "type": "object",
  15958. "properties": {
  15959. "type": {
  15960. "type": "string",
  15961. "enum": ["sync"]
  15962. },
  15963. "name": {
  15964. "type": "string",
  15965. "enum": ["session.next.compaction.delta.1"]
  15966. },
  15967. "id": {
  15968. "type": "string"
  15969. },
  15970. "seq": {
  15971. "type": "number"
  15972. },
  15973. "aggregateID": {
  15974. "type": "string",
  15975. "enum": ["sessionID"]
  15976. },
  15977. "data": {
  15978. "type": "object",
  15979. "properties": {
  15980. "timestamp": {
  15981. "type": "number"
  15982. },
  15983. "sessionID": {
  15984. "type": "string",
  15985. "pattern": "^ses"
  15986. },
  15987. "text": {
  15988. "type": "string"
  15989. }
  15990. },
  15991. "required": ["timestamp", "sessionID", "text"],
  15992. "additionalProperties": false
  15993. }
  15994. },
  15995. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  15996. "additionalProperties": false
  15997. },
  15998. "SyncEventSessionNextCompactionEnded": {
  15999. "type": "object",
  16000. "properties": {
  16001. "type": {
  16002. "type": "string",
  16003. "enum": ["sync"]
  16004. },
  16005. "name": {
  16006. "type": "string",
  16007. "enum": ["session.next.compaction.ended.1"]
  16008. },
  16009. "id": {
  16010. "type": "string"
  16011. },
  16012. "seq": {
  16013. "type": "number"
  16014. },
  16015. "aggregateID": {
  16016. "type": "string",
  16017. "enum": ["sessionID"]
  16018. },
  16019. "data": {
  16020. "type": "object",
  16021. "properties": {
  16022. "timestamp": {
  16023. "type": "number"
  16024. },
  16025. "sessionID": {
  16026. "type": "string",
  16027. "pattern": "^ses"
  16028. },
  16029. "text": {
  16030. "type": "string"
  16031. },
  16032. "include": {
  16033. "type": "string"
  16034. }
  16035. },
  16036. "required": ["timestamp", "sessionID", "text"],
  16037. "additionalProperties": false
  16038. }
  16039. },
  16040. "required": ["type", "name", "id", "seq", "aggregateID", "data"],
  16041. "additionalProperties": false
  16042. },
  16043. "EventServerInstanceDisposed": {
  16044. "type": "object",
  16045. "properties": {
  16046. "id": {
  16047. "type": "string"
  16048. },
  16049. "type": {
  16050. "type": "string",
  16051. "enum": ["server.instance.disposed"]
  16052. },
  16053. "properties": {
  16054. "type": "object",
  16055. "properties": {
  16056. "directory": {
  16057. "type": "string"
  16058. }
  16059. },
  16060. "required": ["directory"],
  16061. "additionalProperties": false
  16062. }
  16063. },
  16064. "required": ["id", "type", "properties"],
  16065. "additionalProperties": false
  16066. },
  16067. "EventFileEdited": {
  16068. "type": "object",
  16069. "properties": {
  16070. "id": {
  16071. "type": "string"
  16072. },
  16073. "type": {
  16074. "type": "string",
  16075. "enum": ["file.edited"]
  16076. },
  16077. "properties": {
  16078. "type": "object",
  16079. "properties": {
  16080. "file": {
  16081. "type": "string"
  16082. }
  16083. },
  16084. "required": ["file"],
  16085. "additionalProperties": false
  16086. }
  16087. },
  16088. "required": ["id", "type", "properties"],
  16089. "additionalProperties": false
  16090. },
  16091. "EventFileWatcherUpdated": {
  16092. "type": "object",
  16093. "properties": {
  16094. "id": {
  16095. "type": "string"
  16096. },
  16097. "type": {
  16098. "type": "string",
  16099. "enum": ["file.watcher.updated"]
  16100. },
  16101. "properties": {
  16102. "type": "object",
  16103. "properties": {
  16104. "file": {
  16105. "type": "string"
  16106. },
  16107. "event": {
  16108. "type": "string",
  16109. "enum": ["add", "change", "unlink"]
  16110. }
  16111. },
  16112. "required": ["file", "event"],
  16113. "additionalProperties": false
  16114. }
  16115. },
  16116. "required": ["id", "type", "properties"],
  16117. "additionalProperties": false
  16118. },
  16119. "EventLspClientDiagnostics": {
  16120. "type": "object",
  16121. "properties": {
  16122. "id": {
  16123. "type": "string"
  16124. },
  16125. "type": {
  16126. "type": "string",
  16127. "enum": ["lsp.client.diagnostics"]
  16128. },
  16129. "properties": {
  16130. "type": "object",
  16131. "properties": {
  16132. "serverID": {
  16133. "type": "string"
  16134. },
  16135. "path": {
  16136. "type": "string"
  16137. }
  16138. },
  16139. "required": ["serverID", "path"],
  16140. "additionalProperties": false
  16141. }
  16142. },
  16143. "required": ["id", "type", "properties"],
  16144. "additionalProperties": false
  16145. },
  16146. "EventLspUpdated": {
  16147. "type": "object",
  16148. "properties": {
  16149. "id": {
  16150. "type": "string"
  16151. },
  16152. "type": {
  16153. "type": "string",
  16154. "enum": ["lsp.updated"]
  16155. },
  16156. "properties": {
  16157. "type": "object",
  16158. "properties": {}
  16159. }
  16160. },
  16161. "required": ["id", "type", "properties"],
  16162. "additionalProperties": false
  16163. },
  16164. "EventMessagePartDelta": {
  16165. "type": "object",
  16166. "properties": {
  16167. "id": {
  16168. "type": "string"
  16169. },
  16170. "type": {
  16171. "type": "string",
  16172. "enum": ["message.part.delta"]
  16173. },
  16174. "properties": {
  16175. "type": "object",
  16176. "properties": {
  16177. "sessionID": {
  16178. "type": "string",
  16179. "pattern": "^ses"
  16180. },
  16181. "messageID": {
  16182. "type": "string",
  16183. "pattern": "^msg"
  16184. },
  16185. "partID": {
  16186. "type": "string",
  16187. "pattern": "^prt"
  16188. },
  16189. "field": {
  16190. "type": "string"
  16191. },
  16192. "delta": {
  16193. "type": "string"
  16194. }
  16195. },
  16196. "required": ["sessionID", "messageID", "partID", "field", "delta"],
  16197. "additionalProperties": false
  16198. }
  16199. },
  16200. "required": ["id", "type", "properties"],
  16201. "additionalProperties": false
  16202. },
  16203. "EventPermissionAsked": {
  16204. "type": "object",
  16205. "properties": {
  16206. "id": {
  16207. "type": "string"
  16208. },
  16209. "type": {
  16210. "type": "string",
  16211. "enum": ["permission.asked"]
  16212. },
  16213. "properties": {
  16214. "$ref": "#/components/schemas/PermissionRequest"
  16215. }
  16216. },
  16217. "required": ["id", "type", "properties"],
  16218. "additionalProperties": false
  16219. },
  16220. "EventPermissionReplied": {
  16221. "type": "object",
  16222. "properties": {
  16223. "id": {
  16224. "type": "string"
  16225. },
  16226. "type": {
  16227. "type": "string",
  16228. "enum": ["permission.replied"]
  16229. },
  16230. "properties": {
  16231. "type": "object",
  16232. "properties": {
  16233. "sessionID": {
  16234. "type": "string",
  16235. "pattern": "^ses"
  16236. },
  16237. "requestID": {
  16238. "type": "string",
  16239. "pattern": "^per"
  16240. },
  16241. "reply": {
  16242. "type": "string",
  16243. "enum": ["once", "always", "reject"]
  16244. }
  16245. },
  16246. "required": ["sessionID", "requestID", "reply"],
  16247. "additionalProperties": false
  16248. }
  16249. },
  16250. "required": ["id", "type", "properties"],
  16251. "additionalProperties": false
  16252. },
  16253. "EventSessionDiff": {
  16254. "type": "object",
  16255. "properties": {
  16256. "id": {
  16257. "type": "string"
  16258. },
  16259. "type": {
  16260. "type": "string",
  16261. "enum": ["session.diff"]
  16262. },
  16263. "properties": {
  16264. "type": "object",
  16265. "properties": {
  16266. "sessionID": {
  16267. "type": "string",
  16268. "pattern": "^ses"
  16269. },
  16270. "diff": {
  16271. "type": "array",
  16272. "items": {
  16273. "$ref": "#/components/schemas/SnapshotFileDiff"
  16274. }
  16275. }
  16276. },
  16277. "required": ["sessionID", "diff"],
  16278. "additionalProperties": false
  16279. }
  16280. },
  16281. "required": ["id", "type", "properties"],
  16282. "additionalProperties": false
  16283. },
  16284. "EventSessionError": {
  16285. "type": "object",
  16286. "properties": {
  16287. "id": {
  16288. "type": "string"
  16289. },
  16290. "type": {
  16291. "type": "string",
  16292. "enum": ["session.error"]
  16293. },
  16294. "properties": {
  16295. "type": "object",
  16296. "properties": {
  16297. "sessionID": {
  16298. "type": "string",
  16299. "pattern": "^ses"
  16300. },
  16301. "error": {
  16302. "anyOf": [
  16303. {
  16304. "$ref": "#/components/schemas/ProviderAuthError"
  16305. },
  16306. {
  16307. "$ref": "#/components/schemas/UnknownError"
  16308. },
  16309. {
  16310. "$ref": "#/components/schemas/MessageOutputLengthError"
  16311. },
  16312. {
  16313. "$ref": "#/components/schemas/MessageAbortedError"
  16314. },
  16315. {
  16316. "$ref": "#/components/schemas/StructuredOutputError"
  16317. },
  16318. {
  16319. "$ref": "#/components/schemas/ContextOverflowError"
  16320. },
  16321. {
  16322. "$ref": "#/components/schemas/APIError"
  16323. }
  16324. ]
  16325. }
  16326. },
  16327. "additionalProperties": false
  16328. }
  16329. },
  16330. "required": ["id", "type", "properties"],
  16331. "additionalProperties": false
  16332. },
  16333. "EventQuestionAsked": {
  16334. "type": "object",
  16335. "properties": {
  16336. "id": {
  16337. "type": "string"
  16338. },
  16339. "type": {
  16340. "type": "string",
  16341. "enum": ["question.asked"]
  16342. },
  16343. "properties": {
  16344. "$ref": "#/components/schemas/QuestionRequest"
  16345. }
  16346. },
  16347. "required": ["id", "type", "properties"],
  16348. "additionalProperties": false
  16349. },
  16350. "EventQuestionReplied": {
  16351. "type": "object",
  16352. "properties": {
  16353. "id": {
  16354. "type": "string"
  16355. },
  16356. "type": {
  16357. "type": "string",
  16358. "enum": ["question.replied"]
  16359. },
  16360. "properties": {
  16361. "$ref": "#/components/schemas/QuestionReplied"
  16362. }
  16363. },
  16364. "required": ["id", "type", "properties"],
  16365. "additionalProperties": false
  16366. },
  16367. "EventQuestionRejected": {
  16368. "type": "object",
  16369. "properties": {
  16370. "id": {
  16371. "type": "string"
  16372. },
  16373. "type": {
  16374. "type": "string",
  16375. "enum": ["question.rejected"]
  16376. },
  16377. "properties": {
  16378. "$ref": "#/components/schemas/QuestionRejected"
  16379. }
  16380. },
  16381. "required": ["id", "type", "properties"],
  16382. "additionalProperties": false
  16383. },
  16384. "EventTodoUpdated": {
  16385. "type": "object",
  16386. "properties": {
  16387. "id": {
  16388. "type": "string"
  16389. },
  16390. "type": {
  16391. "type": "string",
  16392. "enum": ["todo.updated"]
  16393. },
  16394. "properties": {
  16395. "type": "object",
  16396. "properties": {
  16397. "sessionID": {
  16398. "type": "string",
  16399. "pattern": "^ses"
  16400. },
  16401. "todos": {
  16402. "type": "array",
  16403. "items": {
  16404. "$ref": "#/components/schemas/Todo"
  16405. }
  16406. }
  16407. },
  16408. "required": ["sessionID", "todos"],
  16409. "additionalProperties": false
  16410. }
  16411. },
  16412. "required": ["id", "type", "properties"],
  16413. "additionalProperties": false
  16414. },
  16415. "EventSessionStatus": {
  16416. "type": "object",
  16417. "properties": {
  16418. "id": {
  16419. "type": "string"
  16420. },
  16421. "type": {
  16422. "type": "string",
  16423. "enum": ["session.status"]
  16424. },
  16425. "properties": {
  16426. "type": "object",
  16427. "properties": {
  16428. "sessionID": {
  16429. "type": "string",
  16430. "pattern": "^ses"
  16431. },
  16432. "status": {
  16433. "$ref": "#/components/schemas/SessionStatus"
  16434. }
  16435. },
  16436. "required": ["sessionID", "status"],
  16437. "additionalProperties": false
  16438. }
  16439. },
  16440. "required": ["id", "type", "properties"],
  16441. "additionalProperties": false
  16442. },
  16443. "EventSessionIdle": {
  16444. "type": "object",
  16445. "properties": {
  16446. "id": {
  16447. "type": "string"
  16448. },
  16449. "type": {
  16450. "type": "string",
  16451. "enum": ["session.idle"]
  16452. },
  16453. "properties": {
  16454. "type": "object",
  16455. "properties": {
  16456. "sessionID": {
  16457. "type": "string",
  16458. "pattern": "^ses"
  16459. }
  16460. },
  16461. "required": ["sessionID"],
  16462. "additionalProperties": false
  16463. }
  16464. },
  16465. "required": ["id", "type", "properties"],
  16466. "additionalProperties": false
  16467. },
  16468. "EventSessionCompacted": {
  16469. "type": "object",
  16470. "properties": {
  16471. "id": {
  16472. "type": "string"
  16473. },
  16474. "type": {
  16475. "type": "string",
  16476. "enum": ["session.compacted"]
  16477. },
  16478. "properties": {
  16479. "type": "object",
  16480. "properties": {
  16481. "sessionID": {
  16482. "type": "string",
  16483. "pattern": "^ses"
  16484. }
  16485. },
  16486. "required": ["sessionID"],
  16487. "additionalProperties": false
  16488. }
  16489. },
  16490. "required": ["id", "type", "properties"],
  16491. "additionalProperties": false
  16492. },
  16493. "EventMcpToolsChanged": {
  16494. "type": "object",
  16495. "properties": {
  16496. "id": {
  16497. "type": "string"
  16498. },
  16499. "type": {
  16500. "type": "string",
  16501. "enum": ["mcp.tools.changed"]
  16502. },
  16503. "properties": {
  16504. "type": "object",
  16505. "properties": {
  16506. "server": {
  16507. "type": "string"
  16508. }
  16509. },
  16510. "required": ["server"],
  16511. "additionalProperties": false
  16512. }
  16513. },
  16514. "required": ["id", "type", "properties"],
  16515. "additionalProperties": false
  16516. },
  16517. "EventMcpBrowserOpenFailed": {
  16518. "type": "object",
  16519. "properties": {
  16520. "id": {
  16521. "type": "string"
  16522. },
  16523. "type": {
  16524. "type": "string",
  16525. "enum": ["mcp.browser.open.failed"]
  16526. },
  16527. "properties": {
  16528. "type": "object",
  16529. "properties": {
  16530. "mcpName": {
  16531. "type": "string"
  16532. },
  16533. "url": {
  16534. "type": "string"
  16535. }
  16536. },
  16537. "required": ["mcpName", "url"],
  16538. "additionalProperties": false
  16539. }
  16540. },
  16541. "required": ["id", "type", "properties"],
  16542. "additionalProperties": false
  16543. },
  16544. "EventCommandExecuted": {
  16545. "type": "object",
  16546. "properties": {
  16547. "id": {
  16548. "type": "string"
  16549. },
  16550. "type": {
  16551. "type": "string",
  16552. "enum": ["command.executed"]
  16553. },
  16554. "properties": {
  16555. "type": "object",
  16556. "properties": {
  16557. "name": {
  16558. "type": "string"
  16559. },
  16560. "sessionID": {
  16561. "type": "string",
  16562. "pattern": "^ses"
  16563. },
  16564. "arguments": {
  16565. "type": "string"
  16566. },
  16567. "messageID": {
  16568. "type": "string",
  16569. "pattern": "^msg"
  16570. }
  16571. },
  16572. "required": ["name", "sessionID", "arguments", "messageID"],
  16573. "additionalProperties": false
  16574. }
  16575. },
  16576. "required": ["id", "type", "properties"],
  16577. "additionalProperties": false
  16578. },
  16579. "EventProjectUpdated": {
  16580. "type": "object",
  16581. "properties": {
  16582. "id": {
  16583. "type": "string"
  16584. },
  16585. "type": {
  16586. "type": "string",
  16587. "enum": ["project.updated"]
  16588. },
  16589. "properties": {
  16590. "$ref": "#/components/schemas/Project"
  16591. }
  16592. },
  16593. "required": ["id", "type", "properties"],
  16594. "additionalProperties": false
  16595. },
  16596. "EventVcsBranchUpdated": {
  16597. "type": "object",
  16598. "properties": {
  16599. "id": {
  16600. "type": "string"
  16601. },
  16602. "type": {
  16603. "type": "string",
  16604. "enum": ["vcs.branch.updated"]
  16605. },
  16606. "properties": {
  16607. "type": "object",
  16608. "properties": {
  16609. "branch": {
  16610. "type": "string"
  16611. }
  16612. },
  16613. "additionalProperties": false
  16614. }
  16615. },
  16616. "required": ["id", "type", "properties"],
  16617. "additionalProperties": false
  16618. },
  16619. "EventWorkspaceReady": {
  16620. "type": "object",
  16621. "properties": {
  16622. "id": {
  16623. "type": "string"
  16624. },
  16625. "type": {
  16626. "type": "string",
  16627. "enum": ["workspace.ready"]
  16628. },
  16629. "properties": {
  16630. "type": "object",
  16631. "properties": {
  16632. "name": {
  16633. "type": "string"
  16634. }
  16635. },
  16636. "required": ["name"],
  16637. "additionalProperties": false
  16638. }
  16639. },
  16640. "required": ["id", "type", "properties"],
  16641. "additionalProperties": false
  16642. },
  16643. "EventWorkspaceFailed": {
  16644. "type": "object",
  16645. "properties": {
  16646. "id": {
  16647. "type": "string"
  16648. },
  16649. "type": {
  16650. "type": "string",
  16651. "enum": ["workspace.failed"]
  16652. },
  16653. "properties": {
  16654. "type": "object",
  16655. "properties": {
  16656. "message": {
  16657. "type": "string"
  16658. }
  16659. },
  16660. "required": ["message"],
  16661. "additionalProperties": false
  16662. }
  16663. },
  16664. "required": ["id", "type", "properties"],
  16665. "additionalProperties": false
  16666. },
  16667. "EventWorkspaceStatus": {
  16668. "type": "object",
  16669. "properties": {
  16670. "id": {
  16671. "type": "string"
  16672. },
  16673. "type": {
  16674. "type": "string",
  16675. "enum": ["workspace.status"]
  16676. },
  16677. "properties": {
  16678. "type": "object",
  16679. "properties": {
  16680. "workspaceID": {
  16681. "type": "string",
  16682. "pattern": "^wrk"
  16683. },
  16684. "status": {
  16685. "type": "string",
  16686. "enum": ["connected", "connecting", "disconnected", "error"]
  16687. }
  16688. },
  16689. "required": ["workspaceID", "status"],
  16690. "additionalProperties": false
  16691. }
  16692. },
  16693. "required": ["id", "type", "properties"],
  16694. "additionalProperties": false
  16695. },
  16696. "EventWorktreeReady": {
  16697. "type": "object",
  16698. "properties": {
  16699. "id": {
  16700. "type": "string"
  16701. },
  16702. "type": {
  16703. "type": "string",
  16704. "enum": ["worktree.ready"]
  16705. },
  16706. "properties": {
  16707. "type": "object",
  16708. "properties": {
  16709. "name": {
  16710. "type": "string"
  16711. },
  16712. "branch": {
  16713. "type": "string"
  16714. }
  16715. },
  16716. "required": ["name"],
  16717. "additionalProperties": false
  16718. }
  16719. },
  16720. "required": ["id", "type", "properties"],
  16721. "additionalProperties": false
  16722. },
  16723. "EventWorktreeFailed": {
  16724. "type": "object",
  16725. "properties": {
  16726. "id": {
  16727. "type": "string"
  16728. },
  16729. "type": {
  16730. "type": "string",
  16731. "enum": ["worktree.failed"]
  16732. },
  16733. "properties": {
  16734. "type": "object",
  16735. "properties": {
  16736. "message": {
  16737. "type": "string"
  16738. }
  16739. },
  16740. "required": ["message"],
  16741. "additionalProperties": false
  16742. }
  16743. },
  16744. "required": ["id", "type", "properties"],
  16745. "additionalProperties": false
  16746. },
  16747. "EventPtyCreated": {
  16748. "type": "object",
  16749. "properties": {
  16750. "id": {
  16751. "type": "string"
  16752. },
  16753. "type": {
  16754. "type": "string",
  16755. "enum": ["pty.created"]
  16756. },
  16757. "properties": {
  16758. "type": "object",
  16759. "properties": {
  16760. "info": {
  16761. "$ref": "#/components/schemas/Pty"
  16762. }
  16763. },
  16764. "required": ["info"],
  16765. "additionalProperties": false
  16766. }
  16767. },
  16768. "required": ["id", "type", "properties"],
  16769. "additionalProperties": false
  16770. },
  16771. "EventPtyUpdated": {
  16772. "type": "object",
  16773. "properties": {
  16774. "id": {
  16775. "type": "string"
  16776. },
  16777. "type": {
  16778. "type": "string",
  16779. "enum": ["pty.updated"]
  16780. },
  16781. "properties": {
  16782. "type": "object",
  16783. "properties": {
  16784. "info": {
  16785. "$ref": "#/components/schemas/Pty"
  16786. }
  16787. },
  16788. "required": ["info"],
  16789. "additionalProperties": false
  16790. }
  16791. },
  16792. "required": ["id", "type", "properties"],
  16793. "additionalProperties": false
  16794. },
  16795. "EventPtyExited": {
  16796. "type": "object",
  16797. "properties": {
  16798. "id": {
  16799. "type": "string"
  16800. },
  16801. "type": {
  16802. "type": "string",
  16803. "enum": ["pty.exited"]
  16804. },
  16805. "properties": {
  16806. "type": "object",
  16807. "properties": {
  16808. "id": {
  16809. "type": "string",
  16810. "pattern": "^pty"
  16811. },
  16812. "exitCode": {
  16813. "type": "integer",
  16814. "minimum": 0
  16815. }
  16816. },
  16817. "required": ["id", "exitCode"],
  16818. "additionalProperties": false
  16819. }
  16820. },
  16821. "required": ["id", "type", "properties"],
  16822. "additionalProperties": false
  16823. },
  16824. "EventPtyDeleted": {
  16825. "type": "object",
  16826. "properties": {
  16827. "id": {
  16828. "type": "string"
  16829. },
  16830. "type": {
  16831. "type": "string",
  16832. "enum": ["pty.deleted"]
  16833. },
  16834. "properties": {
  16835. "type": "object",
  16836. "properties": {
  16837. "id": {
  16838. "type": "string",
  16839. "pattern": "^pty"
  16840. }
  16841. },
  16842. "required": ["id"],
  16843. "additionalProperties": false
  16844. }
  16845. },
  16846. "required": ["id", "type", "properties"],
  16847. "additionalProperties": false
  16848. },
  16849. "EventInstallationUpdated": {
  16850. "type": "object",
  16851. "properties": {
  16852. "id": {
  16853. "type": "string"
  16854. },
  16855. "type": {
  16856. "type": "string",
  16857. "enum": ["installation.updated"]
  16858. },
  16859. "properties": {
  16860. "type": "object",
  16861. "properties": {
  16862. "version": {
  16863. "type": "string"
  16864. }
  16865. },
  16866. "required": ["version"],
  16867. "additionalProperties": false
  16868. }
  16869. },
  16870. "required": ["id", "type", "properties"],
  16871. "additionalProperties": false
  16872. },
  16873. "EventInstallationUpdate-available": {
  16874. "type": "object",
  16875. "properties": {
  16876. "id": {
  16877. "type": "string"
  16878. },
  16879. "type": {
  16880. "type": "string",
  16881. "enum": ["installation.update-available"]
  16882. },
  16883. "properties": {
  16884. "type": "object",
  16885. "properties": {
  16886. "version": {
  16887. "type": "string"
  16888. }
  16889. },
  16890. "required": ["version"],
  16891. "additionalProperties": false
  16892. }
  16893. },
  16894. "required": ["id", "type", "properties"],
  16895. "additionalProperties": false
  16896. },
  16897. "EventServerConnected": {
  16898. "type": "object",
  16899. "properties": {
  16900. "id": {
  16901. "type": "string"
  16902. },
  16903. "type": {
  16904. "type": "string",
  16905. "enum": ["server.connected"]
  16906. },
  16907. "properties": {
  16908. "type": "object",
  16909. "properties": {}
  16910. }
  16911. },
  16912. "required": ["id", "type", "properties"],
  16913. "additionalProperties": false
  16914. },
  16915. "EventGlobalDisposed": {
  16916. "type": "object",
  16917. "properties": {
  16918. "id": {
  16919. "type": "string"
  16920. },
  16921. "type": {
  16922. "type": "string",
  16923. "enum": ["global.disposed"]
  16924. },
  16925. "properties": {
  16926. "type": "object",
  16927. "properties": {}
  16928. }
  16929. },
  16930. "required": ["id", "type", "properties"],
  16931. "additionalProperties": false
  16932. },
  16933. "PromptSource": {
  16934. "type": "object",
  16935. "properties": {
  16936. "start": {
  16937. "type": "number"
  16938. },
  16939. "end": {
  16940. "type": "number"
  16941. },
  16942. "text": {
  16943. "type": "string"
  16944. }
  16945. },
  16946. "required": ["start", "end", "text"],
  16947. "additionalProperties": false
  16948. },
  16949. "PromptFileAttachment": {
  16950. "type": "object",
  16951. "properties": {
  16952. "uri": {
  16953. "type": "string"
  16954. },
  16955. "mime": {
  16956. "type": "string"
  16957. },
  16958. "name": {
  16959. "type": "string"
  16960. },
  16961. "description": {
  16962. "type": "string"
  16963. },
  16964. "source": {
  16965. "$ref": "#/components/schemas/PromptSource"
  16966. }
  16967. },
  16968. "required": ["uri", "mime"],
  16969. "additionalProperties": false
  16970. },
  16971. "PromptAgentAttachment": {
  16972. "type": "object",
  16973. "properties": {
  16974. "name": {
  16975. "type": "string"
  16976. },
  16977. "source": {
  16978. "$ref": "#/components/schemas/PromptSource"
  16979. }
  16980. },
  16981. "required": ["name"],
  16982. "additionalProperties": false
  16983. },
  16984. "PromptReferenceAttachment": {
  16985. "type": "object",
  16986. "properties": {
  16987. "name": {
  16988. "type": "string"
  16989. },
  16990. "kind": {
  16991. "type": "string",
  16992. "enum": ["local", "git", "invalid"]
  16993. },
  16994. "uri": {
  16995. "type": "string"
  16996. },
  16997. "repository": {
  16998. "type": "string"
  16999. },
  17000. "branch": {
  17001. "type": "string"
  17002. },
  17003. "target": {
  17004. "type": "string"
  17005. },
  17006. "targetUri": {
  17007. "type": "string"
  17008. },
  17009. "problem": {
  17010. "type": "string"
  17011. },
  17012. "source": {
  17013. "$ref": "#/components/schemas/PromptSource"
  17014. }
  17015. },
  17016. "required": ["name", "kind"],
  17017. "additionalProperties": false
  17018. },
  17019. "SessionErrorUnknown": {
  17020. "type": "object",
  17021. "properties": {
  17022. "type": {
  17023. "type": "string",
  17024. "enum": ["unknown"]
  17025. },
  17026. "message": {
  17027. "type": "string"
  17028. }
  17029. },
  17030. "required": ["type", "message"],
  17031. "additionalProperties": false
  17032. },
  17033. "ToolTextContent": {
  17034. "type": "object",
  17035. "properties": {
  17036. "type": {
  17037. "type": "string",
  17038. "enum": ["text"]
  17039. },
  17040. "text": {
  17041. "type": "string"
  17042. }
  17043. },
  17044. "required": ["type", "text"],
  17045. "additionalProperties": false
  17046. },
  17047. "ToolFileContent": {
  17048. "type": "object",
  17049. "properties": {
  17050. "type": {
  17051. "type": "string",
  17052. "enum": ["file"]
  17053. },
  17054. "uri": {
  17055. "type": "string"
  17056. },
  17057. "mime": {
  17058. "type": "string"
  17059. },
  17060. "name": {
  17061. "type": "string"
  17062. }
  17063. },
  17064. "required": ["type", "uri", "mime"],
  17065. "additionalProperties": false
  17066. },
  17067. "SessionNextRetry_error": {
  17068. "type": "object",
  17069. "properties": {
  17070. "message": {
  17071. "type": "string"
  17072. },
  17073. "statusCode": {
  17074. "type": "number"
  17075. },
  17076. "isRetryable": {
  17077. "type": "boolean"
  17078. },
  17079. "responseHeaders": {
  17080. "type": "object",
  17081. "additionalProperties": {
  17082. "type": "string"
  17083. }
  17084. },
  17085. "responseBody": {
  17086. "type": "string"
  17087. },
  17088. "metadata": {
  17089. "type": "object",
  17090. "additionalProperties": {
  17091. "type": "string"
  17092. }
  17093. }
  17094. },
  17095. "required": ["message", "isRetryable"],
  17096. "additionalProperties": false
  17097. },
  17098. "SessionInfo": {
  17099. "type": "object",
  17100. "properties": {
  17101. "id": {
  17102. "type": "string",
  17103. "pattern": "^ses"
  17104. },
  17105. "parentID": {
  17106. "type": "string",
  17107. "pattern": "^ses"
  17108. },
  17109. "projectID": {
  17110. "type": "string"
  17111. },
  17112. "workspaceID": {
  17113. "type": "string",
  17114. "pattern": "^wrk"
  17115. },
  17116. "path": {
  17117. "type": "string"
  17118. },
  17119. "agent": {
  17120. "type": "string"
  17121. },
  17122. "model": {
  17123. "type": "object",
  17124. "properties": {
  17125. "id": {
  17126. "type": "string"
  17127. },
  17128. "providerID": {
  17129. "type": "string"
  17130. },
  17131. "variant": {
  17132. "type": "string"
  17133. }
  17134. },
  17135. "required": ["id", "providerID", "variant"],
  17136. "additionalProperties": false
  17137. },
  17138. "cost": {
  17139. "type": "number"
  17140. },
  17141. "tokens": {
  17142. "type": "object",
  17143. "properties": {
  17144. "input": {
  17145. "type": "number"
  17146. },
  17147. "output": {
  17148. "type": "number"
  17149. },
  17150. "reasoning": {
  17151. "type": "number"
  17152. },
  17153. "cache": {
  17154. "type": "object",
  17155. "properties": {
  17156. "read": {
  17157. "type": "number"
  17158. },
  17159. "write": {
  17160. "type": "number"
  17161. }
  17162. },
  17163. "required": ["read", "write"],
  17164. "additionalProperties": false
  17165. }
  17166. },
  17167. "required": ["input", "output", "reasoning", "cache"],
  17168. "additionalProperties": false
  17169. },
  17170. "time": {
  17171. "type": "object",
  17172. "properties": {
  17173. "created": {
  17174. "type": "number"
  17175. },
  17176. "updated": {
  17177. "type": "number"
  17178. },
  17179. "archived": {
  17180. "type": "number"
  17181. }
  17182. },
  17183. "required": ["created", "updated"],
  17184. "additionalProperties": false
  17185. },
  17186. "title": {
  17187. "type": "string"
  17188. }
  17189. },
  17190. "required": ["id", "projectID", "cost", "tokens", "time", "title"],
  17191. "additionalProperties": false
  17192. },
  17193. "SessionDelivery": {
  17194. "type": "string",
  17195. "enum": ["immediate", "deferred"]
  17196. },
  17197. "SessionMessageAgentSwitched": {
  17198. "type": "object",
  17199. "properties": {
  17200. "id": {
  17201. "type": "string"
  17202. },
  17203. "metadata": {
  17204. "type": "object"
  17205. },
  17206. "time": {
  17207. "type": "object",
  17208. "properties": {
  17209. "created": {
  17210. "type": "number"
  17211. }
  17212. },
  17213. "required": ["created"],
  17214. "additionalProperties": false
  17215. },
  17216. "type": {
  17217. "type": "string",
  17218. "enum": ["agent-switched"]
  17219. },
  17220. "agent": {
  17221. "type": "string"
  17222. }
  17223. },
  17224. "required": ["id", "time", "type", "agent"],
  17225. "additionalProperties": false
  17226. },
  17227. "SessionMessageModelSwitched": {
  17228. "type": "object",
  17229. "properties": {
  17230. "id": {
  17231. "type": "string"
  17232. },
  17233. "metadata": {
  17234. "type": "object"
  17235. },
  17236. "time": {
  17237. "type": "object",
  17238. "properties": {
  17239. "created": {
  17240. "type": "number"
  17241. }
  17242. },
  17243. "required": ["created"],
  17244. "additionalProperties": false
  17245. },
  17246. "type": {
  17247. "type": "string",
  17248. "enum": ["model-switched"]
  17249. },
  17250. "model": {
  17251. "type": "object",
  17252. "properties": {
  17253. "id": {
  17254. "type": "string"
  17255. },
  17256. "providerID": {
  17257. "type": "string"
  17258. },
  17259. "variant": {
  17260. "type": "string"
  17261. }
  17262. },
  17263. "required": ["id", "providerID", "variant"],
  17264. "additionalProperties": false
  17265. }
  17266. },
  17267. "required": ["id", "time", "type", "model"],
  17268. "additionalProperties": false
  17269. },
  17270. "SessionMessageUser": {
  17271. "type": "object",
  17272. "properties": {
  17273. "id": {
  17274. "type": "string"
  17275. },
  17276. "metadata": {
  17277. "type": "object"
  17278. },
  17279. "time": {
  17280. "type": "object",
  17281. "properties": {
  17282. "created": {
  17283. "type": "number"
  17284. }
  17285. },
  17286. "required": ["created"],
  17287. "additionalProperties": false
  17288. },
  17289. "text": {
  17290. "type": "string"
  17291. },
  17292. "files": {
  17293. "type": "array",
  17294. "items": {
  17295. "$ref": "#/components/schemas/PromptFileAttachment"
  17296. }
  17297. },
  17298. "agents": {
  17299. "type": "array",
  17300. "items": {
  17301. "$ref": "#/components/schemas/PromptAgentAttachment"
  17302. }
  17303. },
  17304. "references": {
  17305. "type": "array",
  17306. "items": {
  17307. "$ref": "#/components/schemas/PromptReferenceAttachment"
  17308. }
  17309. },
  17310. "type": {
  17311. "type": "string",
  17312. "enum": ["user"]
  17313. }
  17314. },
  17315. "required": ["id", "time", "text", "type"],
  17316. "additionalProperties": false
  17317. },
  17318. "SessionMessageSynthetic": {
  17319. "type": "object",
  17320. "properties": {
  17321. "id": {
  17322. "type": "string"
  17323. },
  17324. "metadata": {
  17325. "type": "object"
  17326. },
  17327. "time": {
  17328. "type": "object",
  17329. "properties": {
  17330. "created": {
  17331. "type": "number"
  17332. }
  17333. },
  17334. "required": ["created"],
  17335. "additionalProperties": false
  17336. },
  17337. "sessionID": {
  17338. "type": "string",
  17339. "pattern": "^ses"
  17340. },
  17341. "text": {
  17342. "type": "string"
  17343. },
  17344. "type": {
  17345. "type": "string",
  17346. "enum": ["synthetic"]
  17347. }
  17348. },
  17349. "required": ["id", "time", "sessionID", "text", "type"],
  17350. "additionalProperties": false
  17351. },
  17352. "SessionMessageShell": {
  17353. "type": "object",
  17354. "properties": {
  17355. "id": {
  17356. "type": "string"
  17357. },
  17358. "metadata": {
  17359. "type": "object"
  17360. },
  17361. "time": {
  17362. "type": "object",
  17363. "properties": {
  17364. "created": {
  17365. "type": "number"
  17366. },
  17367. "completed": {
  17368. "type": "number"
  17369. }
  17370. },
  17371. "required": ["created"],
  17372. "additionalProperties": false
  17373. },
  17374. "type": {
  17375. "type": "string",
  17376. "enum": ["shell"]
  17377. },
  17378. "callID": {
  17379. "type": "string"
  17380. },
  17381. "command": {
  17382. "type": "string"
  17383. },
  17384. "output": {
  17385. "type": "string"
  17386. }
  17387. },
  17388. "required": ["id", "time", "type", "callID", "command", "output"],
  17389. "additionalProperties": false
  17390. },
  17391. "SessionMessageAssistantText": {
  17392. "type": "object",
  17393. "properties": {
  17394. "type": {
  17395. "type": "string",
  17396. "enum": ["text"]
  17397. },
  17398. "text": {
  17399. "type": "string"
  17400. }
  17401. },
  17402. "required": ["type", "text"],
  17403. "additionalProperties": false
  17404. },
  17405. "SessionMessageAssistantReasoning": {
  17406. "type": "object",
  17407. "properties": {
  17408. "type": {
  17409. "type": "string",
  17410. "enum": ["reasoning"]
  17411. },
  17412. "id": {
  17413. "type": "string"
  17414. },
  17415. "text": {
  17416. "type": "string"
  17417. }
  17418. },
  17419. "required": ["type", "id", "text"],
  17420. "additionalProperties": false
  17421. },
  17422. "SessionMessageToolStatePending": {
  17423. "type": "object",
  17424. "properties": {
  17425. "status": {
  17426. "type": "string",
  17427. "enum": ["pending"]
  17428. },
  17429. "input": {
  17430. "type": "string"
  17431. }
  17432. },
  17433. "required": ["status", "input"],
  17434. "additionalProperties": false
  17435. },
  17436. "SessionMessageToolStateRunning": {
  17437. "type": "object",
  17438. "properties": {
  17439. "status": {
  17440. "type": "string",
  17441. "enum": ["running"]
  17442. },
  17443. "input": {
  17444. "type": "object"
  17445. },
  17446. "structured": {
  17447. "type": "object"
  17448. },
  17449. "content": {
  17450. "type": "array",
  17451. "items": {
  17452. "anyOf": [
  17453. {
  17454. "$ref": "#/components/schemas/ToolTextContent"
  17455. },
  17456. {
  17457. "$ref": "#/components/schemas/ToolFileContent"
  17458. }
  17459. ]
  17460. }
  17461. }
  17462. },
  17463. "required": ["status", "input", "structured", "content"],
  17464. "additionalProperties": false
  17465. },
  17466. "SessionMessageToolStateCompleted": {
  17467. "type": "object",
  17468. "properties": {
  17469. "status": {
  17470. "type": "string",
  17471. "enum": ["completed"]
  17472. },
  17473. "input": {
  17474. "type": "object"
  17475. },
  17476. "attachments": {
  17477. "type": "array",
  17478. "items": {
  17479. "$ref": "#/components/schemas/PromptFileAttachment"
  17480. }
  17481. },
  17482. "content": {
  17483. "type": "array",
  17484. "items": {
  17485. "anyOf": [
  17486. {
  17487. "$ref": "#/components/schemas/ToolTextContent"
  17488. },
  17489. {
  17490. "$ref": "#/components/schemas/ToolFileContent"
  17491. }
  17492. ]
  17493. }
  17494. },
  17495. "structured": {
  17496. "type": "object"
  17497. }
  17498. },
  17499. "required": ["status", "input", "content", "structured"],
  17500. "additionalProperties": false
  17501. },
  17502. "SessionMessageToolStateError": {
  17503. "type": "object",
  17504. "properties": {
  17505. "status": {
  17506. "type": "string",
  17507. "enum": ["error"]
  17508. },
  17509. "input": {
  17510. "type": "object"
  17511. },
  17512. "content": {
  17513. "type": "array",
  17514. "items": {
  17515. "anyOf": [
  17516. {
  17517. "$ref": "#/components/schemas/ToolTextContent"
  17518. },
  17519. {
  17520. "$ref": "#/components/schemas/ToolFileContent"
  17521. }
  17522. ]
  17523. }
  17524. },
  17525. "structured": {
  17526. "type": "object"
  17527. },
  17528. "error": {
  17529. "$ref": "#/components/schemas/SessionErrorUnknown"
  17530. }
  17531. },
  17532. "required": ["status", "input", "content", "structured", "error"],
  17533. "additionalProperties": false
  17534. },
  17535. "SessionMessageAssistantTool": {
  17536. "type": "object",
  17537. "properties": {
  17538. "type": {
  17539. "type": "string",
  17540. "enum": ["tool"]
  17541. },
  17542. "id": {
  17543. "type": "string"
  17544. },
  17545. "name": {
  17546. "type": "string"
  17547. },
  17548. "provider": {
  17549. "type": "object",
  17550. "properties": {
  17551. "executed": {
  17552. "type": "boolean"
  17553. },
  17554. "metadata": {
  17555. "type": "object"
  17556. }
  17557. },
  17558. "required": ["executed"],
  17559. "additionalProperties": false
  17560. },
  17561. "state": {
  17562. "anyOf": [
  17563. {
  17564. "$ref": "#/components/schemas/SessionMessageToolStatePending"
  17565. },
  17566. {
  17567. "$ref": "#/components/schemas/SessionMessageToolStateRunning"
  17568. },
  17569. {
  17570. "$ref": "#/components/schemas/SessionMessageToolStateCompleted"
  17571. },
  17572. {
  17573. "$ref": "#/components/schemas/SessionMessageToolStateError"
  17574. }
  17575. ]
  17576. },
  17577. "time": {
  17578. "type": "object",
  17579. "properties": {
  17580. "created": {
  17581. "type": "number"
  17582. },
  17583. "ran": {
  17584. "type": "number"
  17585. },
  17586. "completed": {
  17587. "type": "number"
  17588. },
  17589. "pruned": {
  17590. "type": "number"
  17591. }
  17592. },
  17593. "required": ["created"],
  17594. "additionalProperties": false
  17595. }
  17596. },
  17597. "required": ["type", "id", "name", "state", "time"],
  17598. "additionalProperties": false
  17599. },
  17600. "SessionMessageAssistant": {
  17601. "type": "object",
  17602. "properties": {
  17603. "id": {
  17604. "type": "string"
  17605. },
  17606. "metadata": {
  17607. "type": "object"
  17608. },
  17609. "time": {
  17610. "type": "object",
  17611. "properties": {
  17612. "created": {
  17613. "type": "number"
  17614. },
  17615. "completed": {
  17616. "type": "number"
  17617. }
  17618. },
  17619. "required": ["created"],
  17620. "additionalProperties": false
  17621. },
  17622. "type": {
  17623. "type": "string",
  17624. "enum": ["assistant"]
  17625. },
  17626. "agent": {
  17627. "type": "string"
  17628. },
  17629. "model": {
  17630. "type": "object",
  17631. "properties": {
  17632. "id": {
  17633. "type": "string"
  17634. },
  17635. "providerID": {
  17636. "type": "string"
  17637. },
  17638. "variant": {
  17639. "type": "string"
  17640. }
  17641. },
  17642. "required": ["id", "providerID", "variant"],
  17643. "additionalProperties": false
  17644. },
  17645. "content": {
  17646. "type": "array",
  17647. "items": {
  17648. "anyOf": [
  17649. {
  17650. "$ref": "#/components/schemas/SessionMessageAssistantText"
  17651. },
  17652. {
  17653. "$ref": "#/components/schemas/SessionMessageAssistantReasoning"
  17654. },
  17655. {
  17656. "$ref": "#/components/schemas/SessionMessageAssistantTool"
  17657. }
  17658. ]
  17659. }
  17660. },
  17661. "snapshot": {
  17662. "type": "object",
  17663. "properties": {
  17664. "start": {
  17665. "type": "string"
  17666. },
  17667. "end": {
  17668. "type": "string"
  17669. }
  17670. },
  17671. "additionalProperties": false
  17672. },
  17673. "finish": {
  17674. "type": "string"
  17675. },
  17676. "cost": {
  17677. "type": "number"
  17678. },
  17679. "tokens": {
  17680. "type": "object",
  17681. "properties": {
  17682. "input": {
  17683. "type": "number"
  17684. },
  17685. "output": {
  17686. "type": "number"
  17687. },
  17688. "reasoning": {
  17689. "type": "number"
  17690. },
  17691. "cache": {
  17692. "type": "object",
  17693. "properties": {
  17694. "read": {
  17695. "type": "number"
  17696. },
  17697. "write": {
  17698. "type": "number"
  17699. }
  17700. },
  17701. "required": ["read", "write"],
  17702. "additionalProperties": false
  17703. }
  17704. },
  17705. "required": ["input", "output", "reasoning", "cache"],
  17706. "additionalProperties": false
  17707. },
  17708. "error": {
  17709. "$ref": "#/components/schemas/SessionErrorUnknown"
  17710. }
  17711. },
  17712. "required": ["id", "time", "type", "agent", "model", "content"],
  17713. "additionalProperties": false
  17714. },
  17715. "SessionMessageCompaction": {
  17716. "type": "object",
  17717. "properties": {
  17718. "type": {
  17719. "type": "string",
  17720. "enum": ["compaction"]
  17721. },
  17722. "reason": {
  17723. "type": "string",
  17724. "enum": ["auto", "manual"]
  17725. },
  17726. "summary": {
  17727. "type": "string"
  17728. },
  17729. "include": {
  17730. "type": "string"
  17731. },
  17732. "id": {
  17733. "type": "string"
  17734. },
  17735. "metadata": {
  17736. "type": "object"
  17737. },
  17738. "time": {
  17739. "type": "object",
  17740. "properties": {
  17741. "created": {
  17742. "type": "number"
  17743. }
  17744. },
  17745. "required": ["created"],
  17746. "additionalProperties": false
  17747. }
  17748. },
  17749. "required": ["type", "reason", "summary", "id", "time"],
  17750. "additionalProperties": false
  17751. },
  17752. "SessionMessage": {
  17753. "anyOf": [
  17754. {
  17755. "$ref": "#/components/schemas/SessionMessageAgentSwitched"
  17756. },
  17757. {
  17758. "$ref": "#/components/schemas/SessionMessageModelSwitched"
  17759. },
  17760. {
  17761. "$ref": "#/components/schemas/SessionMessageUser"
  17762. },
  17763. {
  17764. "$ref": "#/components/schemas/SessionMessageSynthetic"
  17765. },
  17766. {
  17767. "$ref": "#/components/schemas/SessionMessageShell"
  17768. },
  17769. {
  17770. "$ref": "#/components/schemas/SessionMessageAssistant"
  17771. },
  17772. {
  17773. "$ref": "#/components/schemas/SessionMessageCompaction"
  17774. }
  17775. ]
  17776. },
  17777. "ModelV2Info": {
  17778. "type": "object",
  17779. "properties": {
  17780. "id": {
  17781. "type": "string"
  17782. },
  17783. "apiID": {
  17784. "type": "string"
  17785. },
  17786. "providerID": {
  17787. "type": "string"
  17788. },
  17789. "family": {
  17790. "type": "string"
  17791. },
  17792. "name": {
  17793. "type": "string"
  17794. },
  17795. "endpoint": {
  17796. "anyOf": [
  17797. {
  17798. "type": "object",
  17799. "properties": {
  17800. "type": {
  17801. "type": "string",
  17802. "enum": ["unknown"]
  17803. }
  17804. },
  17805. "required": ["type"],
  17806. "additionalProperties": false
  17807. },
  17808. {
  17809. "type": "object",
  17810. "properties": {
  17811. "type": {
  17812. "type": "string",
  17813. "enum": ["openai/responses"]
  17814. },
  17815. "url": {
  17816. "type": "string"
  17817. },
  17818. "websocket": {
  17819. "type": "boolean"
  17820. }
  17821. },
  17822. "required": ["type", "url"],
  17823. "additionalProperties": false
  17824. },
  17825. {
  17826. "type": "object",
  17827. "properties": {
  17828. "type": {
  17829. "type": "string",
  17830. "enum": ["openai/completions"]
  17831. },
  17832. "url": {
  17833. "type": "string"
  17834. },
  17835. "reasoning": {
  17836. "anyOf": [
  17837. {
  17838. "type": "object",
  17839. "properties": {
  17840. "type": {
  17841. "type": "string",
  17842. "enum": ["reasoning_content"]
  17843. }
  17844. },
  17845. "required": ["type"],
  17846. "additionalProperties": false
  17847. },
  17848. {
  17849. "type": "object",
  17850. "properties": {
  17851. "type": {
  17852. "type": "string",
  17853. "enum": ["reasoning_details"]
  17854. }
  17855. },
  17856. "required": ["type"],
  17857. "additionalProperties": false
  17858. }
  17859. ]
  17860. }
  17861. },
  17862. "required": ["type", "url"],
  17863. "additionalProperties": false
  17864. },
  17865. {
  17866. "type": "object",
  17867. "properties": {
  17868. "type": {
  17869. "type": "string",
  17870. "enum": ["anthropic/messages"]
  17871. },
  17872. "url": {
  17873. "type": "string"
  17874. }
  17875. },
  17876. "required": ["type", "url"],
  17877. "additionalProperties": false
  17878. },
  17879. {
  17880. "type": "object",
  17881. "properties": {
  17882. "type": {
  17883. "type": "string",
  17884. "enum": ["aisdk"]
  17885. },
  17886. "package": {
  17887. "type": "string"
  17888. },
  17889. "url": {
  17890. "type": "string"
  17891. }
  17892. },
  17893. "required": ["type", "package"],
  17894. "additionalProperties": false
  17895. }
  17896. ]
  17897. },
  17898. "capabilities": {
  17899. "type": "object",
  17900. "properties": {
  17901. "tools": {
  17902. "type": "boolean"
  17903. },
  17904. "input": {
  17905. "type": "array",
  17906. "items": {
  17907. "type": "string"
  17908. }
  17909. },
  17910. "output": {
  17911. "type": "array",
  17912. "items": {
  17913. "type": "string"
  17914. }
  17915. }
  17916. },
  17917. "required": ["tools", "input", "output"],
  17918. "additionalProperties": false
  17919. },
  17920. "options": {
  17921. "type": "object",
  17922. "properties": {
  17923. "headers": {
  17924. "type": "object",
  17925. "additionalProperties": {
  17926. "type": "string"
  17927. }
  17928. },
  17929. "body": {
  17930. "type": "object"
  17931. },
  17932. "aisdk": {
  17933. "type": "object",
  17934. "properties": {
  17935. "provider": {
  17936. "type": "object"
  17937. },
  17938. "request": {
  17939. "type": "object"
  17940. }
  17941. },
  17942. "required": ["provider", "request"],
  17943. "additionalProperties": false
  17944. },
  17945. "variant": {
  17946. "type": "string"
  17947. }
  17948. },
  17949. "required": ["headers", "body", "aisdk"],
  17950. "additionalProperties": false
  17951. },
  17952. "variants": {
  17953. "type": "array",
  17954. "items": {
  17955. "type": "object",
  17956. "properties": {
  17957. "id": {
  17958. "type": "string"
  17959. },
  17960. "headers": {
  17961. "type": "object",
  17962. "additionalProperties": {
  17963. "type": "string"
  17964. }
  17965. },
  17966. "body": {
  17967. "type": "object"
  17968. },
  17969. "aisdk": {
  17970. "type": "object",
  17971. "properties": {
  17972. "provider": {
  17973. "type": "object"
  17974. },
  17975. "request": {
  17976. "type": "object"
  17977. }
  17978. },
  17979. "required": ["provider", "request"],
  17980. "additionalProperties": false
  17981. }
  17982. },
  17983. "required": ["id", "headers", "body", "aisdk"],
  17984. "additionalProperties": false
  17985. }
  17986. },
  17987. "time": {
  17988. "type": "object",
  17989. "properties": {
  17990. "released": {
  17991. "anyOf": [
  17992. {
  17993. "type": "number"
  17994. },
  17995. {
  17996. "type": "string",
  17997. "enum": ["NaN"]
  17998. },
  17999. {
  18000. "type": "string",
  18001. "enum": ["Infinity"]
  18002. },
  18003. {
  18004. "type": "string",
  18005. "enum": ["-Infinity"]
  18006. },
  18007. {
  18008. "type": "string",
  18009. "enum": ["Infinity", "-Infinity", "NaN"]
  18010. }
  18011. ]
  18012. }
  18013. },
  18014. "required": ["released"],
  18015. "additionalProperties": false
  18016. },
  18017. "cost": {
  18018. "type": "array",
  18019. "items": {
  18020. "type": "object",
  18021. "properties": {
  18022. "tier": {
  18023. "type": "object",
  18024. "properties": {
  18025. "type": {
  18026. "type": "string",
  18027. "enum": ["context"]
  18028. },
  18029. "size": {
  18030. "type": "integer"
  18031. }
  18032. },
  18033. "required": ["type", "size"],
  18034. "additionalProperties": false
  18035. },
  18036. "input": {
  18037. "type": "number"
  18038. },
  18039. "output": {
  18040. "type": "number"
  18041. },
  18042. "cache": {
  18043. "type": "object",
  18044. "properties": {
  18045. "read": {
  18046. "type": "number"
  18047. },
  18048. "write": {
  18049. "type": "number"
  18050. }
  18051. },
  18052. "required": ["read", "write"],
  18053. "additionalProperties": false
  18054. }
  18055. },
  18056. "required": ["input", "output", "cache"],
  18057. "additionalProperties": false
  18058. }
  18059. },
  18060. "status": {
  18061. "type": "string",
  18062. "enum": ["alpha", "beta", "deprecated", "active"]
  18063. },
  18064. "enabled": {
  18065. "type": "boolean"
  18066. },
  18067. "limit": {
  18068. "type": "object",
  18069. "properties": {
  18070. "context": {
  18071. "type": "integer"
  18072. },
  18073. "input": {
  18074. "type": "integer"
  18075. },
  18076. "output": {
  18077. "type": "integer"
  18078. }
  18079. },
  18080. "required": ["context", "output"],
  18081. "additionalProperties": false
  18082. }
  18083. },
  18084. "required": [
  18085. "id",
  18086. "apiID",
  18087. "providerID",
  18088. "name",
  18089. "endpoint",
  18090. "capabilities",
  18091. "options",
  18092. "variants",
  18093. "time",
  18094. "cost",
  18095. "status",
  18096. "enabled",
  18097. "limit"
  18098. ],
  18099. "additionalProperties": false
  18100. },
  18101. "ProviderV2Info": {
  18102. "type": "object",
  18103. "properties": {
  18104. "id": {
  18105. "type": "string"
  18106. },
  18107. "name": {
  18108. "type": "string"
  18109. },
  18110. "enabled": {
  18111. "anyOf": [
  18112. {
  18113. "type": "boolean",
  18114. "enum": [false]
  18115. },
  18116. {
  18117. "type": "object",
  18118. "properties": {
  18119. "via": {
  18120. "type": "string",
  18121. "enum": ["env"]
  18122. },
  18123. "name": {
  18124. "type": "string"
  18125. }
  18126. },
  18127. "required": ["via", "name"],
  18128. "additionalProperties": false
  18129. },
  18130. {
  18131. "type": "object",
  18132. "properties": {
  18133. "via": {
  18134. "type": "string",
  18135. "enum": ["auth"]
  18136. },
  18137. "service": {
  18138. "type": "string"
  18139. }
  18140. },
  18141. "required": ["via", "service"],
  18142. "additionalProperties": false
  18143. },
  18144. {
  18145. "type": "object",
  18146. "properties": {
  18147. "via": {
  18148. "type": "string",
  18149. "enum": ["custom"]
  18150. },
  18151. "data": {
  18152. "type": "object"
  18153. }
  18154. },
  18155. "required": ["via", "data"],
  18156. "additionalProperties": false
  18157. }
  18158. ]
  18159. },
  18160. "env": {
  18161. "type": "array",
  18162. "items": {
  18163. "type": "string"
  18164. }
  18165. },
  18166. "endpoint": {
  18167. "anyOf": [
  18168. {
  18169. "type": "object",
  18170. "properties": {
  18171. "type": {
  18172. "type": "string",
  18173. "enum": ["unknown"]
  18174. }
  18175. },
  18176. "required": ["type"],
  18177. "additionalProperties": false
  18178. },
  18179. {
  18180. "type": "object",
  18181. "properties": {
  18182. "type": {
  18183. "type": "string",
  18184. "enum": ["openai/responses"]
  18185. },
  18186. "url": {
  18187. "type": "string"
  18188. },
  18189. "websocket": {
  18190. "type": "boolean"
  18191. }
  18192. },
  18193. "required": ["type", "url"],
  18194. "additionalProperties": false
  18195. },
  18196. {
  18197. "type": "object",
  18198. "properties": {
  18199. "type": {
  18200. "type": "string",
  18201. "enum": ["openai/completions"]
  18202. },
  18203. "url": {
  18204. "type": "string"
  18205. },
  18206. "reasoning": {
  18207. "anyOf": [
  18208. {
  18209. "type": "object",
  18210. "properties": {
  18211. "type": {
  18212. "type": "string",
  18213. "enum": ["reasoning_content"]
  18214. }
  18215. },
  18216. "required": ["type"],
  18217. "additionalProperties": false
  18218. },
  18219. {
  18220. "type": "object",
  18221. "properties": {
  18222. "type": {
  18223. "type": "string",
  18224. "enum": ["reasoning_details"]
  18225. }
  18226. },
  18227. "required": ["type"],
  18228. "additionalProperties": false
  18229. }
  18230. ]
  18231. }
  18232. },
  18233. "required": ["type", "url"],
  18234. "additionalProperties": false
  18235. },
  18236. {
  18237. "type": "object",
  18238. "properties": {
  18239. "type": {
  18240. "type": "string",
  18241. "enum": ["anthropic/messages"]
  18242. },
  18243. "url": {
  18244. "type": "string"
  18245. }
  18246. },
  18247. "required": ["type", "url"],
  18248. "additionalProperties": false
  18249. },
  18250. {
  18251. "type": "object",
  18252. "properties": {
  18253. "type": {
  18254. "type": "string",
  18255. "enum": ["aisdk"]
  18256. },
  18257. "package": {
  18258. "type": "string"
  18259. },
  18260. "url": {
  18261. "type": "string"
  18262. }
  18263. },
  18264. "required": ["type", "package"],
  18265. "additionalProperties": false
  18266. }
  18267. ]
  18268. },
  18269. "options": {
  18270. "type": "object",
  18271. "properties": {
  18272. "headers": {
  18273. "type": "object",
  18274. "additionalProperties": {
  18275. "type": "string"
  18276. }
  18277. },
  18278. "body": {
  18279. "type": "object"
  18280. },
  18281. "aisdk": {
  18282. "type": "object",
  18283. "properties": {
  18284. "provider": {
  18285. "type": "object"
  18286. },
  18287. "request": {
  18288. "type": "object"
  18289. }
  18290. },
  18291. "required": ["provider", "request"],
  18292. "additionalProperties": false
  18293. }
  18294. },
  18295. "required": ["headers", "body", "aisdk"],
  18296. "additionalProperties": false
  18297. }
  18298. },
  18299. "required": ["id", "name", "enabled", "env", "endpoint", "options"],
  18300. "additionalProperties": false
  18301. },
  18302. "EventTuiToastShow1": {
  18303. "type": "object",
  18304. "properties": {
  18305. "id": {
  18306. "type": "string"
  18307. },
  18308. "type": {
  18309. "type": "string",
  18310. "enum": ["tui.toast.show"]
  18311. },
  18312. "properties": {
  18313. "type": "object",
  18314. "properties": {
  18315. "title": {
  18316. "type": "string"
  18317. },
  18318. "message": {
  18319. "type": "string"
  18320. },
  18321. "variant": {
  18322. "type": "string",
  18323. "enum": ["info", "success", "warning", "error"]
  18324. },
  18325. "duration": {
  18326. "type": "integer",
  18327. "exclusiveMinimum": 0
  18328. }
  18329. },
  18330. "required": ["message", "variant"],
  18331. "additionalProperties": false
  18332. }
  18333. },
  18334. "required": ["id", "type", "properties"],
  18335. "additionalProperties": false
  18336. },
  18337. "BadRequestError": {
  18338. "type": "object",
  18339. "required": ["name", "data"],
  18340. "properties": {
  18341. "name": {
  18342. "type": "string",
  18343. "enum": ["BadRequest"]
  18344. },
  18345. "data": {
  18346. "type": "object",
  18347. "required": ["message"],
  18348. "properties": {
  18349. "message": {
  18350. "type": "string"
  18351. },
  18352. "kind": {
  18353. "type": "string",
  18354. "enum": ["Params", "Headers", "Query", "Body", "Payload"]
  18355. }
  18356. }
  18357. }
  18358. }
  18359. }
  18360. }
  18361. },
  18362. "security": [],
  18363. "tags": [
  18364. {
  18365. "name": "control",
  18366. "description": "Control plane routes."
  18367. },
  18368. {
  18369. "name": "global",
  18370. "description": "Global server routes."
  18371. },
  18372. {
  18373. "name": "event",
  18374. "description": "Instance event stream route."
  18375. },
  18376. {
  18377. "name": "config",
  18378. "description": "Experimental HttpApi config routes."
  18379. },
  18380. {
  18381. "name": "experimental",
  18382. "description": "Experimental HttpApi read-only routes."
  18383. },
  18384. {
  18385. "name": "file",
  18386. "description": "Experimental HttpApi file routes."
  18387. },
  18388. {
  18389. "name": "instance",
  18390. "description": "Experimental HttpApi instance read routes."
  18391. },
  18392. {
  18393. "name": "mcp",
  18394. "description": "Experimental HttpApi MCP routes."
  18395. },
  18396. {
  18397. "name": "project",
  18398. "description": "Experimental HttpApi project routes."
  18399. },
  18400. {
  18401. "name": "pty",
  18402. "description": "Experimental HttpApi PTY routes."
  18403. },
  18404. {
  18405. "name": "question",
  18406. "description": "Question routes."
  18407. },
  18408. {
  18409. "name": "permission",
  18410. "description": "Experimental HttpApi permission routes."
  18411. },
  18412. {
  18413. "name": "provider",
  18414. "description": "Experimental HttpApi provider routes."
  18415. },
  18416. {
  18417. "name": "session",
  18418. "description": "Experimental HttpApi session routes."
  18419. },
  18420. {
  18421. "name": "sync",
  18422. "description": "Experimental HttpApi sync routes."
  18423. },
  18424. {
  18425. "name": "v2",
  18426. "description": "Experimental v2 routes."
  18427. },
  18428. {
  18429. "name": "v2 messages",
  18430. "description": "Experimental v2 message routes."
  18431. },
  18432. {
  18433. "name": "v2 models",
  18434. "description": "Experimental v2 model routes."
  18435. },
  18436. {
  18437. "name": "v2 providers",
  18438. "description": "Experimental v2 provider routes."
  18439. },
  18440. {
  18441. "name": "tui",
  18442. "description": "Experimental HttpApi TUI routes."
  18443. },
  18444. {
  18445. "name": "workspace",
  18446. "description": "Experimental HttpApi workspace routes."
  18447. },
  18448. {
  18449. "name": "pty",
  18450. "description": "PTY websocket route."
  18451. }
  18452. ]
  18453. }