| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783 |
- {
- "openapi": "3.1.1",
- "info": {
- "title": "opencode",
- "description": "opencode api",
- "version": "1.0.0"
- },
- "paths": {
- "/global/health": {
- "get": {
- "operationId": "global.health",
- "summary": "Get health",
- "description": "Get health information about the OpenCode server.",
- "responses": {
- "200": {
- "description": "Health information",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "healthy": {
- "type": "boolean",
- "const": true
- },
- "version": {
- "type": "string"
- }
- },
- "required": ["healthy", "version"]
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.global.health({\n ...\n})"
- }
- ]
- }
- },
- "/global/event": {
- "get": {
- "operationId": "global.event",
- "summary": "Get global events",
- "description": "Subscribe to global events from the OpenCode system using server-sent events.",
- "responses": {
- "200": {
- "description": "Event stream",
- "content": {
- "text/event-stream": {
- "schema": {
- "$ref": "#/components/schemas/GlobalEvent"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.global.event({\n ...\n})"
- }
- ]
- }
- },
- "/global/dispose": {
- "post": {
- "operationId": "global.dispose",
- "summary": "Dispose instance",
- "description": "Clean up and dispose all OpenCode instances, releasing all resources.",
- "responses": {
- "200": {
- "description": "Global disposed",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.global.dispose({\n ...\n})"
- }
- ]
- }
- },
- "/project": {
- "get": {
- "operationId": "project.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List all projects",
- "description": "Get a list of projects that have been opened with OpenCode.",
- "responses": {
- "200": {
- "description": "List of projects",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Project"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.project.list({\n ...\n})"
- }
- ]
- }
- },
- "/project/current": {
- "get": {
- "operationId": "project.current",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get current project",
- "description": "Retrieve the currently active project that OpenCode is working with.",
- "responses": {
- "200": {
- "description": "Current project information",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Project"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.project.current({\n ...\n})"
- }
- ]
- }
- },
- "/project/{projectID}": {
- "patch": {
- "operationId": "project.update",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "projectID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Update project",
- "description": "Update project properties such as name, icon and color.",
- "responses": {
- "200": {
- "description": "Updated project information",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Project"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "icon": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "override": {
- "type": "string"
- },
- "color": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.project.update({\n ...\n})"
- }
- ]
- }
- },
- "/pty": {
- "get": {
- "operationId": "pty.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List PTY sessions",
- "description": "Get a list of all active pseudo-terminal (PTY) sessions managed by OpenCode.",
- "responses": {
- "200": {
- "description": "List of sessions",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Pty"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.list({\n ...\n})"
- }
- ]
- },
- "post": {
- "operationId": "pty.create",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Create PTY session",
- "description": "Create a new pseudo-terminal (PTY) session for running shell commands and processes.",
- "responses": {
- "200": {
- "description": "Created session",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Pty"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "command": {
- "type": "string"
- },
- "args": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "cwd": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "env": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.create({\n ...\n})"
- }
- ]
- }
- },
- "/pty/{ptyID}": {
- "get": {
- "operationId": "pty.get",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "ptyID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Get PTY session",
- "description": "Retrieve detailed information about a specific pseudo-terminal (PTY) session.",
- "responses": {
- "200": {
- "description": "Session info",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Pty"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.get({\n ...\n})"
- }
- ]
- },
- "put": {
- "operationId": "pty.update",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "ptyID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Update PTY session",
- "description": "Update properties of an existing pseudo-terminal (PTY) session.",
- "responses": {
- "200": {
- "description": "Updated session",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Pty"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "size": {
- "type": "object",
- "properties": {
- "rows": {
- "type": "number"
- },
- "cols": {
- "type": "number"
- }
- },
- "required": ["rows", "cols"]
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.update({\n ...\n})"
- }
- ]
- },
- "delete": {
- "operationId": "pty.remove",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "ptyID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Remove PTY session",
- "description": "Remove and terminate a specific pseudo-terminal (PTY) session.",
- "responses": {
- "200": {
- "description": "Session removed",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.remove({\n ...\n})"
- }
- ]
- }
- },
- "/pty/{ptyID}/connect": {
- "get": {
- "operationId": "pty.connect",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "ptyID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Connect to PTY session",
- "description": "Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.",
- "responses": {
- "200": {
- "description": "Connected session",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.pty.connect({\n ...\n})"
- }
- ]
- }
- },
- "/config": {
- "get": {
- "operationId": "config.get",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get configuration",
- "description": "Retrieve the current OpenCode configuration settings and preferences.",
- "responses": {
- "200": {
- "description": "Get config info",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Config"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.config.get({\n ...\n})"
- }
- ]
- },
- "patch": {
- "operationId": "config.update",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Update configuration",
- "description": "Update OpenCode configuration settings and preferences.",
- "responses": {
- "200": {
- "description": "Successfully updated config",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Config"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Config"
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.config.update({\n ...\n})"
- }
- ]
- }
- },
- "/config/providers": {
- "get": {
- "operationId": "config.providers",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List config providers",
- "description": "Get a list of all configured AI providers and their default models.",
- "responses": {
- "200": {
- "description": "List of providers",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "providers": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Provider"
- }
- },
- "default": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "required": ["providers", "default"]
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.config.providers({\n ...\n})"
- }
- ]
- }
- },
- "/experimental/tool/ids": {
- "get": {
- "operationId": "tool.ids",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List tool IDs",
- "description": "Get a list of all available tool IDs, including both built-in tools and dynamically registered tools.",
- "responses": {
- "200": {
- "description": "Tool IDs",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ToolIDs"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tool.ids({\n ...\n})"
- }
- ]
- }
- },
- "/experimental/tool": {
- "get": {
- "operationId": "tool.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "query",
- "name": "provider",
- "schema": {
- "type": "string"
- },
- "required": true
- },
- {
- "in": "query",
- "name": "model",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "List tools",
- "description": "Get a list of available tools with their JSON schema parameters for a specific provider and model combination.",
- "responses": {
- "200": {
- "description": "Tools",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ToolList"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tool.list({\n ...\n})"
- }
- ]
- }
- },
- "/experimental/worktree": {
- "post": {
- "operationId": "worktree.create",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Create worktree",
- "description": "Create a new git worktree for the current project.",
- "responses": {
- "200": {
- "description": "Worktree created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Worktree"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/WorktreeCreateInput"
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.worktree.create({\n ...\n})"
- }
- ]
- },
- "get": {
- "operationId": "worktree.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List worktrees",
- "description": "List all sandbox worktrees for the current project.",
- "responses": {
- "200": {
- "description": "List of worktree directories",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.worktree.list({\n ...\n})"
- }
- ]
- },
- "delete": {
- "operationId": "worktree.remove",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Remove worktree",
- "description": "Remove a git worktree and delete its branch.",
- "responses": {
- "200": {
- "description": "Worktree removed",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/WorktreeRemoveInput"
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.worktree.remove({\n ...\n})"
- }
- ]
- }
- },
- "/experimental/worktree/reset": {
- "post": {
- "operationId": "worktree.reset",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Reset worktree",
- "description": "Reset a worktree branch to the primary default branch.",
- "responses": {
- "200": {
- "description": "Worktree reset",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/WorktreeResetInput"
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.worktree.reset({\n ...\n})"
- }
- ]
- }
- },
- "/experimental/resource": {
- "get": {
- "operationId": "experimental.resource.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get MCP resources",
- "description": "Get all available MCP resources from connected servers. Optionally filter by name.",
- "responses": {
- "200": {
- "description": "MCP resources",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/McpResource"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.experimental.resource.list({\n ...\n})"
- }
- ]
- }
- },
- "/session": {
- "get": {
- "operationId": "session.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- },
- "description": "Filter sessions by project directory"
- },
- {
- "in": "query",
- "name": "roots",
- "schema": {
- "type": "boolean"
- },
- "description": "Only return root sessions (no parentID)"
- },
- {
- "in": "query",
- "name": "start",
- "schema": {
- "type": "number"
- },
- "description": "Filter sessions updated on or after this timestamp (milliseconds since epoch)"
- },
- {
- "in": "query",
- "name": "search",
- "schema": {
- "type": "string"
- },
- "description": "Filter sessions by title (case-insensitive)"
- },
- {
- "in": "query",
- "name": "limit",
- "schema": {
- "type": "number"
- },
- "description": "Maximum number of sessions to return"
- }
- ],
- "summary": "List sessions",
- "description": "Get a list of all OpenCode sessions, sorted by most recently updated.",
- "responses": {
- "200": {
- "description": "List of sessions",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.list({\n ...\n})"
- }
- ]
- },
- "post": {
- "operationId": "session.create",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Create session",
- "description": "Create a new OpenCode session for interacting with AI assistants and managing conversations.",
- "responses": {
- "200": {
- "description": "Successfully created session",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "parentID": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "title": {
- "type": "string"
- },
- "permission": {
- "$ref": "#/components/schemas/PermissionRuleset"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.create({\n ...\n})"
- }
- ]
- }
- },
- "/session/status": {
- "get": {
- "operationId": "session.status",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get session status",
- "description": "Retrieve the current status of all sessions, including active, idle, and completed states.",
- "responses": {
- "200": {
- "description": "Get session status",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/SessionStatus"
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.status({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}": {
- "get": {
- "operationId": "session.get",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "required": true
- }
- ],
- "summary": "Get session",
- "description": "Retrieve detailed information about a specific OpenCode session.",
- "tags": ["Session"],
- "responses": {
- "200": {
- "description": "Get session",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.get({\n ...\n})"
- }
- ]
- },
- "delete": {
- "operationId": "session.delete",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "required": true
- }
- ],
- "summary": "Delete session",
- "description": "Delete a session and permanently remove all associated data, including messages and history.",
- "responses": {
- "200": {
- "description": "Successfully deleted session",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.delete({\n ...\n})"
- }
- ]
- },
- "patch": {
- "operationId": "session.update",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Update session",
- "description": "Update properties of an existing session, such as title or other metadata.",
- "responses": {
- "200": {
- "description": "Successfully updated session",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "time": {
- "type": "object",
- "properties": {
- "archived": {
- "type": "number"
- }
- }
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.update({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/children": {
- "get": {
- "operationId": "session.children",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "required": true
- }
- ],
- "summary": "Get session children",
- "tags": ["Session"],
- "description": "Retrieve all child sessions that were forked from the specified parent session.",
- "responses": {
- "200": {
- "description": "List of children",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.children({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/todo": {
- "get": {
- "operationId": "session.todo",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- }
- ],
- "summary": "Get session todos",
- "description": "Retrieve the todo list associated with a specific session, showing tasks and action items.",
- "responses": {
- "200": {
- "description": "Todo list",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Todo"
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.todo({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/init": {
- "post": {
- "operationId": "session.init",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- }
- ],
- "summary": "Initialize session",
- "description": "Analyze the current application and create an AGENTS.md file with project-specific agent configurations.",
- "responses": {
- "200": {
- "description": "200",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "modelID": {
- "type": "string"
- },
- "providerID": {
- "type": "string"
- },
- "messageID": {
- "type": "string",
- "pattern": "^msg.*"
- }
- },
- "required": ["modelID", "providerID", "messageID"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.init({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/fork": {
- "post": {
- "operationId": "session.fork",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "required": true
- }
- ],
- "summary": "Fork session",
- "description": "Create a new session by forking an existing session at a specific message point.",
- "responses": {
- "200": {
- "description": "200",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "messageID": {
- "type": "string",
- "pattern": "^msg.*"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.fork({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/abort": {
- "post": {
- "operationId": "session.abort",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Abort session",
- "description": "Abort an active session and stop any ongoing AI processing or command execution.",
- "responses": {
- "200": {
- "description": "Aborted session",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.abort({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/share": {
- "post": {
- "operationId": "session.share",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Share session",
- "description": "Create a shareable link for a session, allowing others to view the conversation.",
- "responses": {
- "200": {
- "description": "Successfully shared session",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.share({\n ...\n})"
- }
- ]
- },
- "delete": {
- "operationId": "session.unshare",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "required": true
- }
- ],
- "summary": "Unshare session",
- "description": "Remove the shareable link for a session, making it private again.",
- "responses": {
- "200": {
- "description": "Successfully unshared session",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.unshare({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/diff": {
- "get": {
- "operationId": "session.diff",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "required": true
- },
- {
- "in": "query",
- "name": "messageID",
- "schema": {
- "type": "string",
- "pattern": "^msg.*"
- }
- }
- ],
- "summary": "Get message diff",
- "description": "Get the file changes (diff) that resulted from a specific user message in the session.",
- "responses": {
- "200": {
- "description": "Successfully retrieved diff",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FileDiff"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.diff({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/summarize": {
- "post": {
- "operationId": "session.summarize",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- }
- ],
- "summary": "Summarize session",
- "description": "Generate a concise summary of the session using AI compaction to preserve key information.",
- "responses": {
- "200": {
- "description": "Summarized session",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "providerID": {
- "type": "string"
- },
- "modelID": {
- "type": "string"
- },
- "auto": {
- "default": false,
- "type": "boolean"
- }
- },
- "required": ["providerID", "modelID"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.summarize({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/message": {
- "get": {
- "operationId": "session.messages",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- },
- {
- "in": "query",
- "name": "limit",
- "schema": {
- "type": "number"
- }
- }
- ],
- "summary": "Get session messages",
- "description": "Retrieve all messages in a session, including user prompts and AI responses.",
- "responses": {
- "200": {
- "description": "List of messages",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/Message"
- },
- "parts": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Part"
- }
- }
- },
- "required": ["info", "parts"]
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.messages({\n ...\n})"
- }
- ]
- },
- "post": {
- "operationId": "session.prompt",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- }
- ],
- "summary": "Send message",
- "description": "Create and send a new message to a session, streaming the AI response.",
- "responses": {
- "200": {
- "description": "Created message",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/AssistantMessage"
- },
- "parts": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Part"
- }
- }
- },
- "required": ["info", "parts"]
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "messageID": {
- "type": "string",
- "pattern": "^msg.*"
- },
- "model": {
- "type": "object",
- "properties": {
- "providerID": {
- "type": "string"
- },
- "modelID": {
- "type": "string"
- }
- },
- "required": ["providerID", "modelID"]
- },
- "agent": {
- "type": "string"
- },
- "noReply": {
- "type": "boolean"
- },
- "tools": {
- "description": "@deprecated tools and permissions have been merged, you can set permissions on the session itself now",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "boolean"
- }
- },
- "system": {
- "type": "string"
- },
- "variant": {
- "type": "string"
- },
- "parts": {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/TextPartInput"
- },
- {
- "$ref": "#/components/schemas/FilePartInput"
- },
- {
- "$ref": "#/components/schemas/AgentPartInput"
- },
- {
- "$ref": "#/components/schemas/SubtaskPartInput"
- }
- ]
- }
- }
- },
- "required": ["parts"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.prompt({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/message/{messageID}": {
- "get": {
- "operationId": "session.message",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- },
- {
- "in": "path",
- "name": "messageID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Message ID"
- }
- ],
- "summary": "Get message",
- "description": "Retrieve a specific message from a session by its message ID.",
- "responses": {
- "200": {
- "description": "Message",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/Message"
- },
- "parts": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Part"
- }
- }
- },
- "required": ["info", "parts"]
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.message({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/message/{messageID}/part/{partID}": {
- "delete": {
- "operationId": "part.delete",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- },
- {
- "in": "path",
- "name": "messageID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Message ID"
- },
- {
- "in": "path",
- "name": "partID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Part ID"
- }
- ],
- "description": "Delete a part from a message",
- "responses": {
- "200": {
- "description": "Successfully deleted part",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.part.delete({\n ...\n})"
- }
- ]
- },
- "patch": {
- "operationId": "part.update",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- },
- {
- "in": "path",
- "name": "messageID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Message ID"
- },
- {
- "in": "path",
- "name": "partID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Part ID"
- }
- ],
- "description": "Update a part in a message",
- "responses": {
- "200": {
- "description": "Successfully updated part",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Part"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Part"
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.part.update({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/prompt_async": {
- "post": {
- "operationId": "session.prompt_async",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- }
- ],
- "summary": "Send async message",
- "description": "Create and send a new message to a session asynchronously, starting the session if needed and returning immediately.",
- "responses": {
- "204": {
- "description": "Prompt accepted"
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "messageID": {
- "type": "string",
- "pattern": "^msg.*"
- },
- "model": {
- "type": "object",
- "properties": {
- "providerID": {
- "type": "string"
- },
- "modelID": {
- "type": "string"
- }
- },
- "required": ["providerID", "modelID"]
- },
- "agent": {
- "type": "string"
- },
- "noReply": {
- "type": "boolean"
- },
- "tools": {
- "description": "@deprecated tools and permissions have been merged, you can set permissions on the session itself now",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "boolean"
- }
- },
- "system": {
- "type": "string"
- },
- "variant": {
- "type": "string"
- },
- "parts": {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/TextPartInput"
- },
- {
- "$ref": "#/components/schemas/FilePartInput"
- },
- {
- "$ref": "#/components/schemas/AgentPartInput"
- },
- {
- "$ref": "#/components/schemas/SubtaskPartInput"
- }
- ]
- }
- }
- },
- "required": ["parts"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.prompt_async({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/command": {
- "post": {
- "operationId": "session.command",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- }
- ],
- "summary": "Send command",
- "description": "Send a new command to a session for execution by the AI assistant.",
- "responses": {
- "200": {
- "description": "Created message",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/AssistantMessage"
- },
- "parts": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Part"
- }
- }
- },
- "required": ["info", "parts"]
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "messageID": {
- "type": "string",
- "pattern": "^msg.*"
- },
- "agent": {
- "type": "string"
- },
- "model": {
- "type": "string"
- },
- "arguments": {
- "type": "string"
- },
- "command": {
- "type": "string"
- },
- "variant": {
- "type": "string"
- },
- "parts": {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "file"
- },
- "mime": {
- "type": "string"
- },
- "filename": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "source": {
- "$ref": "#/components/schemas/FilePartSource"
- }
- },
- "required": ["type", "mime", "url"]
- }
- ]
- }
- }
- },
- "required": ["arguments", "command"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.command({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/shell": {
- "post": {
- "operationId": "session.shell",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Session ID"
- }
- ],
- "summary": "Run shell command",
- "description": "Execute a shell command within the session context and return the AI's response.",
- "responses": {
- "200": {
- "description": "Created message",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AssistantMessage"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "agent": {
- "type": "string"
- },
- "model": {
- "type": "object",
- "properties": {
- "providerID": {
- "type": "string"
- },
- "modelID": {
- "type": "string"
- }
- },
- "required": ["providerID", "modelID"]
- },
- "command": {
- "type": "string"
- }
- },
- "required": ["agent", "command"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.shell({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/revert": {
- "post": {
- "operationId": "session.revert",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Revert message",
- "description": "Revert a specific message in a session, undoing its effects and restoring the previous state.",
- "responses": {
- "200": {
- "description": "Updated session",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "messageID": {
- "type": "string",
- "pattern": "^msg.*"
- },
- "partID": {
- "type": "string",
- "pattern": "^prt.*"
- }
- },
- "required": ["messageID"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.revert({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/unrevert": {
- "post": {
- "operationId": "session.unrevert",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Restore reverted messages",
- "description": "Restore all previously reverted messages in a session.",
- "responses": {
- "200": {
- "description": "Updated session",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Session"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.session.unrevert({\n ...\n})"
- }
- ]
- }
- },
- "/session/{sessionID}/permissions/{permissionID}": {
- "post": {
- "operationId": "permission.respond",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "sessionID",
- "schema": {
- "type": "string"
- },
- "required": true
- },
- {
- "in": "path",
- "name": "permissionID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Respond to permission",
- "deprecated": true,
- "description": "Approve or deny a permission request from the AI assistant.",
- "responses": {
- "200": {
- "description": "Permission processed successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "response": {
- "type": "string",
- "enum": ["once", "always", "reject"]
- }
- },
- "required": ["response"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.permission.respond({\n ...\n})"
- }
- ]
- }
- },
- "/permission/{requestID}/reply": {
- "post": {
- "operationId": "permission.reply",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "requestID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Respond to permission request",
- "description": "Approve or deny a permission request from the AI assistant.",
- "responses": {
- "200": {
- "description": "Permission processed successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "reply": {
- "type": "string",
- "enum": ["once", "always", "reject"]
- },
- "message": {
- "type": "string"
- }
- },
- "required": ["reply"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.permission.reply({\n ...\n})"
- }
- ]
- }
- },
- "/permission": {
- "get": {
- "operationId": "permission.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List pending permissions",
- "description": "Get all pending permission requests across all sessions.",
- "responses": {
- "200": {
- "description": "List of pending permissions",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PermissionRequest"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.permission.list({\n ...\n})"
- }
- ]
- }
- },
- "/question": {
- "get": {
- "operationId": "question.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List pending questions",
- "description": "Get all pending question requests across all sessions.",
- "responses": {
- "200": {
- "description": "List of pending questions",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/QuestionRequest"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.question.list({\n ...\n})"
- }
- ]
- }
- },
- "/question/{requestID}/reply": {
- "post": {
- "operationId": "question.reply",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "requestID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Reply to question request",
- "description": "Provide answers to a question request from the AI assistant.",
- "responses": {
- "200": {
- "description": "Question answered successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "answers": {
- "description": "User answers in order of questions (each answer is an array of selected labels)",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/QuestionAnswer"
- }
- }
- },
- "required": ["answers"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.question.reply({\n ...\n})"
- }
- ]
- }
- },
- "/question/{requestID}/reject": {
- "post": {
- "operationId": "question.reject",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "requestID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Reject question request",
- "description": "Reject a question request from the AI assistant.",
- "responses": {
- "200": {
- "description": "Question rejected successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.question.reject({\n ...\n})"
- }
- ]
- }
- },
- "/provider": {
- "get": {
- "operationId": "provider.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List providers",
- "description": "Get a list of all available AI providers, including both available and connected ones.",
- "responses": {
- "200": {
- "description": "List of providers",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "all": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "api": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "env": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string"
- },
- "npm": {
- "type": "string"
- },
- "models": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "family": {
- "type": "string"
- },
- "release_date": {
- "type": "string"
- },
- "attachment": {
- "type": "boolean"
- },
- "reasoning": {
- "type": "boolean"
- },
- "temperature": {
- "type": "boolean"
- },
- "tool_call": {
- "type": "boolean"
- },
- "interleaved": {
- "anyOf": [
- {
- "type": "boolean",
- "const": true
- },
- {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "enum": ["reasoning_content", "reasoning_details"]
- }
- },
- "required": ["field"],
- "additionalProperties": false
- }
- ]
- },
- "cost": {
- "type": "object",
- "properties": {
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- },
- "cache_read": {
- "type": "number"
- },
- "cache_write": {
- "type": "number"
- },
- "context_over_200k": {
- "type": "object",
- "properties": {
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- },
- "cache_read": {
- "type": "number"
- },
- "cache_write": {
- "type": "number"
- }
- },
- "required": ["input", "output"]
- }
- },
- "required": ["input", "output"]
- },
- "limit": {
- "type": "object",
- "properties": {
- "context": {
- "type": "number"
- },
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- }
- },
- "required": ["context", "output"]
- },
- "modalities": {
- "type": "object",
- "properties": {
- "input": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["text", "audio", "image", "video", "pdf"]
- }
- },
- "output": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["text", "audio", "image", "video", "pdf"]
- }
- }
- },
- "required": ["input", "output"]
- },
- "experimental": {
- "type": "boolean"
- },
- "status": {
- "type": "string",
- "enum": ["alpha", "beta", "deprecated"]
- },
- "options": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "headers": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- "provider": {
- "type": "object",
- "properties": {
- "npm": {
- "type": "string"
- }
- },
- "required": ["npm"]
- },
- "variants": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- }
- }
- },
- "required": [
- "id",
- "name",
- "release_date",
- "attachment",
- "reasoning",
- "temperature",
- "tool_call",
- "limit",
- "options"
- ]
- }
- }
- },
- "required": ["name", "env", "id", "models"]
- }
- },
- "default": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- "connected": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": ["all", "default", "connected"]
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.provider.list({\n ...\n})"
- }
- ]
- }
- },
- "/provider/auth": {
- "get": {
- "operationId": "provider.auth",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get provider auth methods",
- "description": "Retrieve available authentication methods for all AI providers.",
- "responses": {
- "200": {
- "description": "Provider auth methods",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ProviderAuthMethod"
- }
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.provider.auth({\n ...\n})"
- }
- ]
- }
- },
- "/provider/{providerID}/oauth/authorize": {
- "post": {
- "operationId": "provider.oauth.authorize",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "providerID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Provider ID"
- }
- ],
- "summary": "OAuth authorize",
- "description": "Initiate OAuth authorization for a specific AI provider to get an authorization URL.",
- "responses": {
- "200": {
- "description": "Authorization URL and method",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProviderAuthAuthorization"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "method": {
- "description": "Auth method index",
- "type": "number"
- }
- },
- "required": ["method"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.provider.oauth.authorize({\n ...\n})"
- }
- ]
- }
- },
- "/provider/{providerID}/oauth/callback": {
- "post": {
- "operationId": "provider.oauth.callback",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "providerID",
- "schema": {
- "type": "string"
- },
- "required": true,
- "description": "Provider ID"
- }
- ],
- "summary": "OAuth callback",
- "description": "Handle the OAuth callback from a provider after user authorization.",
- "responses": {
- "200": {
- "description": "OAuth callback processed successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "method": {
- "description": "Auth method index",
- "type": "number"
- },
- "code": {
- "description": "OAuth authorization code",
- "type": "string"
- }
- },
- "required": ["method"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.provider.oauth.callback({\n ...\n})"
- }
- ]
- }
- },
- "/find": {
- "get": {
- "operationId": "find.text",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "query",
- "name": "pattern",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Find text",
- "description": "Search for text patterns across files in the project using ripgrep.",
- "responses": {
- "200": {
- "description": "Matches",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "path": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- }
- },
- "required": ["text"]
- },
- "lines": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- }
- },
- "required": ["text"]
- },
- "line_number": {
- "type": "number"
- },
- "absolute_offset": {
- "type": "number"
- },
- "submatches": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "match": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- }
- },
- "required": ["text"]
- },
- "start": {
- "type": "number"
- },
- "end": {
- "type": "number"
- }
- },
- "required": ["match", "start", "end"]
- }
- }
- },
- "required": ["path", "lines", "line_number", "absolute_offset", "submatches"]
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.find.text({\n ...\n})"
- }
- ]
- }
- },
- "/find/file": {
- "get": {
- "operationId": "find.files",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "query",
- "name": "query",
- "schema": {
- "type": "string"
- },
- "required": true
- },
- {
- "in": "query",
- "name": "dirs",
- "schema": {
- "type": "string",
- "enum": ["true", "false"]
- }
- },
- {
- "in": "query",
- "name": "type",
- "schema": {
- "type": "string",
- "enum": ["file", "directory"]
- }
- },
- {
- "in": "query",
- "name": "limit",
- "schema": {
- "type": "integer",
- "minimum": 1,
- "maximum": 200
- }
- }
- ],
- "summary": "Find files",
- "description": "Search for files or directories by name or pattern in the project directory.",
- "responses": {
- "200": {
- "description": "File paths",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.find.files({\n ...\n})"
- }
- ]
- }
- },
- "/find/symbol": {
- "get": {
- "operationId": "find.symbols",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "query",
- "name": "query",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Find symbols",
- "description": "Search for workspace symbols like functions, classes, and variables using LSP.",
- "responses": {
- "200": {
- "description": "Symbols",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Symbol"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.find.symbols({\n ...\n})"
- }
- ]
- }
- },
- "/file": {
- "get": {
- "operationId": "file.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "query",
- "name": "path",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "List files",
- "description": "List files and directories in a specified path.",
- "responses": {
- "200": {
- "description": "Files and directories",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FileNode"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.file.list({\n ...\n})"
- }
- ]
- }
- },
- "/file/content": {
- "get": {
- "operationId": "file.read",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "query",
- "name": "path",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Read file",
- "description": "Read the content of a specified file.",
- "responses": {
- "200": {
- "description": "File content",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FileContent"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.file.read({\n ...\n})"
- }
- ]
- }
- },
- "/file/status": {
- "get": {
- "operationId": "file.status",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get file status",
- "description": "Get the git status of all files in the project.",
- "responses": {
- "200": {
- "description": "File status",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/File"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.file.status({\n ...\n})"
- }
- ]
- }
- },
- "/mcp": {
- "get": {
- "operationId": "mcp.status",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get MCP status",
- "description": "Get the status of all Model Context Protocol (MCP) servers.",
- "responses": {
- "200": {
- "description": "MCP server status",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/MCPStatus"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.status({\n ...\n})"
- }
- ]
- },
- "post": {
- "operationId": "mcp.add",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Add MCP server",
- "description": "Dynamically add a new Model Context Protocol (MCP) server to the system.",
- "responses": {
- "200": {
- "description": "MCP server added successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/MCPStatus"
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "config": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/McpLocalConfig"
- },
- {
- "$ref": "#/components/schemas/McpRemoteConfig"
- }
- ]
- }
- },
- "required": ["name", "config"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.add({\n ...\n})"
- }
- ]
- }
- },
- "/mcp/{name}/auth": {
- "post": {
- "operationId": "mcp.auth.start",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "schema": {
- "type": "string"
- },
- "in": "path",
- "name": "name",
- "required": true
- }
- ],
- "summary": "Start MCP OAuth",
- "description": "Start OAuth authentication flow for a Model Context Protocol (MCP) server.",
- "responses": {
- "200": {
- "description": "OAuth flow started",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "authorizationUrl": {
- "description": "URL to open in browser for authorization",
- "type": "string"
- }
- },
- "required": ["authorizationUrl"]
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.auth.start({\n ...\n})"
- }
- ]
- },
- "delete": {
- "operationId": "mcp.auth.remove",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "schema": {
- "type": "string"
- },
- "in": "path",
- "name": "name",
- "required": true
- }
- ],
- "summary": "Remove MCP OAuth",
- "description": "Remove OAuth credentials for an MCP server",
- "responses": {
- "200": {
- "description": "OAuth credentials removed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "success": {
- "type": "boolean",
- "const": true
- }
- },
- "required": ["success"]
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.auth.remove({\n ...\n})"
- }
- ]
- }
- },
- "/mcp/{name}/auth/callback": {
- "post": {
- "operationId": "mcp.auth.callback",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "schema": {
- "type": "string"
- },
- "in": "path",
- "name": "name",
- "required": true
- }
- ],
- "summary": "Complete MCP OAuth",
- "description": "Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code.",
- "responses": {
- "200": {
- "description": "OAuth authentication completed",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/MCPStatus"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "code": {
- "description": "Authorization code from OAuth callback",
- "type": "string"
- }
- },
- "required": ["code"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.auth.callback({\n ...\n})"
- }
- ]
- }
- },
- "/mcp/{name}/auth/authenticate": {
- "post": {
- "operationId": "mcp.auth.authenticate",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "schema": {
- "type": "string"
- },
- "in": "path",
- "name": "name",
- "required": true
- }
- ],
- "summary": "Authenticate MCP OAuth",
- "description": "Start OAuth flow and wait for callback (opens browser)",
- "responses": {
- "200": {
- "description": "OAuth authentication completed",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/MCPStatus"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.auth.authenticate({\n ...\n})"
- }
- ]
- }
- },
- "/mcp/{name}/connect": {
- "post": {
- "operationId": "mcp.connect",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "name",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "description": "Connect an MCP server",
- "responses": {
- "200": {
- "description": "MCP server connected successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.connect({\n ...\n})"
- }
- ]
- }
- },
- "/mcp/{name}/disconnect": {
- "post": {
- "operationId": "mcp.disconnect",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "name",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "description": "Disconnect an MCP server",
- "responses": {
- "200": {
- "description": "MCP server disconnected successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.mcp.disconnect({\n ...\n})"
- }
- ]
- }
- },
- "/tui/append-prompt": {
- "post": {
- "operationId": "tui.appendPrompt",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Append TUI prompt",
- "description": "Append prompt to the TUI",
- "responses": {
- "200": {
- "description": "Prompt processed successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- }
- },
- "required": ["text"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.appendPrompt({\n ...\n})"
- }
- ]
- }
- },
- "/tui/open-help": {
- "post": {
- "operationId": "tui.openHelp",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Open help dialog",
- "description": "Open the help dialog in the TUI to display user assistance information.",
- "responses": {
- "200": {
- "description": "Help dialog opened successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.openHelp({\n ...\n})"
- }
- ]
- }
- },
- "/tui/open-sessions": {
- "post": {
- "operationId": "tui.openSessions",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Open sessions dialog",
- "description": "Open the session dialog",
- "responses": {
- "200": {
- "description": "Session dialog opened successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.openSessions({\n ...\n})"
- }
- ]
- }
- },
- "/tui/open-themes": {
- "post": {
- "operationId": "tui.openThemes",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Open themes dialog",
- "description": "Open the theme dialog",
- "responses": {
- "200": {
- "description": "Theme dialog opened successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.openThemes({\n ...\n})"
- }
- ]
- }
- },
- "/tui/open-models": {
- "post": {
- "operationId": "tui.openModels",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Open models dialog",
- "description": "Open the model dialog",
- "responses": {
- "200": {
- "description": "Model dialog opened successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.openModels({\n ...\n})"
- }
- ]
- }
- },
- "/tui/submit-prompt": {
- "post": {
- "operationId": "tui.submitPrompt",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Submit TUI prompt",
- "description": "Submit the prompt",
- "responses": {
- "200": {
- "description": "Prompt submitted successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.submitPrompt({\n ...\n})"
- }
- ]
- }
- },
- "/tui/clear-prompt": {
- "post": {
- "operationId": "tui.clearPrompt",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Clear TUI prompt",
- "description": "Clear the prompt",
- "responses": {
- "200": {
- "description": "Prompt cleared successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.clearPrompt({\n ...\n})"
- }
- ]
- }
- },
- "/tui/execute-command": {
- "post": {
- "operationId": "tui.executeCommand",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Execute TUI command",
- "description": "Execute a TUI command (e.g. agent_cycle)",
- "responses": {
- "200": {
- "description": "Command executed successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "command": {
- "type": "string"
- }
- },
- "required": ["command"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.executeCommand({\n ...\n})"
- }
- ]
- }
- },
- "/tui/show-toast": {
- "post": {
- "operationId": "tui.showToast",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Show TUI toast",
- "description": "Show a toast notification in the TUI",
- "responses": {
- "200": {
- "description": "Toast notification shown successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "variant": {
- "type": "string",
- "enum": ["info", "success", "warning", "error"]
- },
- "duration": {
- "description": "Duration in milliseconds",
- "default": 5000,
- "type": "number"
- }
- },
- "required": ["message", "variant"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.showToast({\n ...\n})"
- }
- ]
- }
- },
- "/tui/publish": {
- "post": {
- "operationId": "tui.publish",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Publish TUI event",
- "description": "Publish a TUI event",
- "responses": {
- "200": {
- "description": "Event published successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Event.tui.prompt.append"
- },
- {
- "$ref": "#/components/schemas/Event.tui.command.execute"
- },
- {
- "$ref": "#/components/schemas/Event.tui.toast.show"
- },
- {
- "$ref": "#/components/schemas/Event.tui.session.select"
- }
- ]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.publish({\n ...\n})"
- }
- ]
- }
- },
- "/tui/select-session": {
- "post": {
- "operationId": "tui.selectSession",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Select session",
- "description": "Navigate the TUI to display the specified session.",
- "responses": {
- "200": {
- "description": "Session selected successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- },
- "404": {
- "description": "Not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NotFoundError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "sessionID": {
- "description": "Session ID to navigate to",
- "type": "string",
- "pattern": "^ses"
- }
- },
- "required": ["sessionID"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.selectSession({\n ...\n})"
- }
- ]
- }
- },
- "/tui/control/next": {
- "get": {
- "operationId": "tui.control.next",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get next TUI request",
- "description": "Retrieve the next TUI (Terminal User Interface) request from the queue for processing.",
- "responses": {
- "200": {
- "description": "Next TUI request",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string"
- },
- "body": {}
- },
- "required": ["path", "body"]
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.control.next({\n ...\n})"
- }
- ]
- }
- },
- "/tui/control/response": {
- "post": {
- "operationId": "tui.control.response",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Submit TUI response",
- "description": "Submit a response to the TUI request queue to complete a pending request.",
- "responses": {
- "200": {
- "description": "Response submitted successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.tui.control.response({\n ...\n})"
- }
- ]
- }
- },
- "/instance/dispose": {
- "post": {
- "operationId": "instance.dispose",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Dispose instance",
- "description": "Clean up and dispose the current OpenCode instance, releasing all resources.",
- "responses": {
- "200": {
- "description": "Instance disposed",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.instance.dispose({\n ...\n})"
- }
- ]
- }
- },
- "/path": {
- "get": {
- "operationId": "path.get",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get paths",
- "description": "Retrieve the current working directory and related path information for the OpenCode instance.",
- "responses": {
- "200": {
- "description": "Path",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Path"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.path.get({\n ...\n})"
- }
- ]
- }
- },
- "/vcs": {
- "get": {
- "operationId": "vcs.get",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get VCS info",
- "description": "Retrieve version control system (VCS) information for the current project, such as git branch.",
- "responses": {
- "200": {
- "description": "VCS info",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/VcsInfo"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.vcs.get({\n ...\n})"
- }
- ]
- }
- },
- "/command": {
- "get": {
- "operationId": "command.list",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List commands",
- "description": "Get a list of all available commands in the OpenCode system.",
- "responses": {
- "200": {
- "description": "List of commands",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Command"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.command.list({\n ...\n})"
- }
- ]
- }
- },
- "/log": {
- "post": {
- "operationId": "app.log",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Write log",
- "description": "Write a log entry to the server logs with specified level and metadata.",
- "responses": {
- "200": {
- "description": "Log entry written successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "service": {
- "description": "Service name for the log entry",
- "type": "string"
- },
- "level": {
- "description": "Log level",
- "type": "string",
- "enum": ["debug", "info", "error", "warn"]
- },
- "message": {
- "description": "Log message",
- "type": "string"
- },
- "extra": {
- "description": "Additional metadata for the log entry",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- }
- },
- "required": ["service", "level", "message"]
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.app.log({\n ...\n})"
- }
- ]
- }
- },
- "/agent": {
- "get": {
- "operationId": "app.agents",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List agents",
- "description": "Get a list of all available AI agents in the OpenCode system.",
- "responses": {
- "200": {
- "description": "List of agents",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Agent"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.app.agents({\n ...\n})"
- }
- ]
- }
- },
- "/skill": {
- "get": {
- "operationId": "app.skills",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "List skills",
- "description": "Get a list of all available skills in the OpenCode system.",
- "responses": {
- "200": {
- "description": "List of skills",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "location": {
- "type": "string"
- }
- },
- "required": ["name", "description", "location"]
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.app.skills({\n ...\n})"
- }
- ]
- }
- },
- "/lsp": {
- "get": {
- "operationId": "lsp.status",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get LSP status",
- "description": "Get LSP server status",
- "responses": {
- "200": {
- "description": "LSP server status",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LSPStatus"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.lsp.status({\n ...\n})"
- }
- ]
- }
- },
- "/formatter": {
- "get": {
- "operationId": "formatter.status",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Get formatter status",
- "description": "Get formatter status",
- "responses": {
- "200": {
- "description": "Formatter status",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FormatterStatus"
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.formatter.status({\n ...\n})"
- }
- ]
- }
- },
- "/auth/{providerID}": {
- "put": {
- "operationId": "auth.set",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- },
- {
- "in": "path",
- "name": "providerID",
- "schema": {
- "type": "string"
- },
- "required": true
- }
- ],
- "summary": "Set auth credentials",
- "description": "Set authentication credentials",
- "responses": {
- "200": {
- "description": "Successfully set authentication credentials",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BadRequestError"
- }
- }
- }
- }
- },
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Auth"
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.auth.set({\n ...\n})"
- }
- ]
- }
- },
- "/event": {
- "get": {
- "operationId": "event.subscribe",
- "parameters": [
- {
- "in": "query",
- "name": "directory",
- "schema": {
- "type": "string"
- }
- }
- ],
- "summary": "Subscribe to events",
- "description": "Get events",
- "responses": {
- "200": {
- "description": "Event stream",
- "content": {
- "text/event-stream": {
- "schema": {
- "$ref": "#/components/schemas/Event"
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "js",
- "source": "import { createOpencodeClient } from \"@opencode-ai/sdk\n\nconst client = createOpencodeClient()\nawait client.event.subscribe({\n ...\n})"
- }
- ]
- }
- }
- },
- "components": {
- "schemas": {
- "Event.installation.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "installation.updated"
- },
- "properties": {
- "type": "object",
- "properties": {
- "version": {
- "type": "string"
- }
- },
- "required": ["version"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.installation.update-available": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "installation.update-available"
- },
- "properties": {
- "type": "object",
- "properties": {
- "version": {
- "type": "string"
- }
- },
- "required": ["version"]
- }
- },
- "required": ["type", "properties"]
- },
- "Project": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "worktree": {
- "type": "string"
- },
- "vcs": {
- "type": "string",
- "const": "git"
- },
- "name": {
- "type": "string"
- },
- "icon": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "override": {
- "type": "string"
- },
- "color": {
- "type": "string"
- }
- }
- },
- "time": {
- "type": "object",
- "properties": {
- "created": {
- "type": "number"
- },
- "updated": {
- "type": "number"
- },
- "initialized": {
- "type": "number"
- }
- },
- "required": ["created", "updated"]
- },
- "sandboxes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": ["id", "worktree", "time", "sandboxes"]
- },
- "Event.project.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "project.updated"
- },
- "properties": {
- "$ref": "#/components/schemas/Project"
- }
- },
- "required": ["type", "properties"]
- },
- "Event.server.instance.disposed": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "server.instance.disposed"
- },
- "properties": {
- "type": "object",
- "properties": {
- "directory": {
- "type": "string"
- }
- },
- "required": ["directory"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.server.connected": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "server.connected"
- },
- "properties": {
- "type": "object",
- "properties": {}
- }
- },
- "required": ["type", "properties"]
- },
- "Event.global.disposed": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "global.disposed"
- },
- "properties": {
- "type": "object",
- "properties": {}
- }
- },
- "required": ["type", "properties"]
- },
- "Event.lsp.client.diagnostics": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "lsp.client.diagnostics"
- },
- "properties": {
- "type": "object",
- "properties": {
- "serverID": {
- "type": "string"
- },
- "path": {
- "type": "string"
- }
- },
- "required": ["serverID", "path"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.lsp.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "lsp.updated"
- },
- "properties": {
- "type": "object",
- "properties": {}
- }
- },
- "required": ["type", "properties"]
- },
- "Event.file.edited": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "file.edited"
- },
- "properties": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string"
- }
- },
- "required": ["file"]
- }
- },
- "required": ["type", "properties"]
- },
- "FileDiff": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string"
- },
- "before": {
- "type": "string"
- },
- "after": {
- "type": "string"
- },
- "additions": {
- "type": "number"
- },
- "deletions": {
- "type": "number"
- }
- },
- "required": ["file", "before", "after", "additions", "deletions"]
- },
- "UserMessage": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "role": {
- "type": "string",
- "const": "user"
- },
- "time": {
- "type": "object",
- "properties": {
- "created": {
- "type": "number"
- }
- },
- "required": ["created"]
- },
- "summary": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "body": {
- "type": "string"
- },
- "diffs": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FileDiff"
- }
- }
- },
- "required": ["diffs"]
- },
- "agent": {
- "type": "string"
- },
- "model": {
- "type": "object",
- "properties": {
- "providerID": {
- "type": "string"
- },
- "modelID": {
- "type": "string"
- }
- },
- "required": ["providerID", "modelID"]
- },
- "system": {
- "type": "string"
- },
- "tools": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "boolean"
- }
- },
- "variant": {
- "type": "string"
- }
- },
- "required": ["id", "sessionID", "role", "time", "agent", "model"]
- },
- "ProviderAuthError": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "const": "ProviderAuthError"
- },
- "data": {
- "type": "object",
- "properties": {
- "providerID": {
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- },
- "required": ["providerID", "message"]
- }
- },
- "required": ["name", "data"]
- },
- "UnknownError": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "const": "UnknownError"
- },
- "data": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- }
- },
- "required": ["message"]
- }
- },
- "required": ["name", "data"]
- },
- "MessageOutputLengthError": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "const": "MessageOutputLengthError"
- },
- "data": {
- "type": "object",
- "properties": {}
- }
- },
- "required": ["name", "data"]
- },
- "MessageAbortedError": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "const": "MessageAbortedError"
- },
- "data": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- }
- },
- "required": ["message"]
- }
- },
- "required": ["name", "data"]
- },
- "APIError": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "const": "APIError"
- },
- "data": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "statusCode": {
- "type": "number"
- },
- "isRetryable": {
- "type": "boolean"
- },
- "responseHeaders": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- "responseBody": {
- "type": "string"
- },
- "metadata": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "required": ["message", "isRetryable"]
- }
- },
- "required": ["name", "data"]
- },
- "AssistantMessage": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "role": {
- "type": "string",
- "const": "assistant"
- },
- "time": {
- "type": "object",
- "properties": {
- "created": {
- "type": "number"
- },
- "completed": {
- "type": "number"
- }
- },
- "required": ["created"]
- },
- "error": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ProviderAuthError"
- },
- {
- "$ref": "#/components/schemas/UnknownError"
- },
- {
- "$ref": "#/components/schemas/MessageOutputLengthError"
- },
- {
- "$ref": "#/components/schemas/MessageAbortedError"
- },
- {
- "$ref": "#/components/schemas/APIError"
- }
- ]
- },
- "parentID": {
- "type": "string"
- },
- "modelID": {
- "type": "string"
- },
- "providerID": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- },
- "agent": {
- "type": "string"
- },
- "path": {
- "type": "object",
- "properties": {
- "cwd": {
- "type": "string"
- },
- "root": {
- "type": "string"
- }
- },
- "required": ["cwd", "root"]
- },
- "summary": {
- "type": "boolean"
- },
- "cost": {
- "type": "number"
- },
- "tokens": {
- "type": "object",
- "properties": {
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- },
- "reasoning": {
- "type": "number"
- },
- "cache": {
- "type": "object",
- "properties": {
- "read": {
- "type": "number"
- },
- "write": {
- "type": "number"
- }
- },
- "required": ["read", "write"]
- }
- },
- "required": ["input", "output", "reasoning", "cache"]
- },
- "finish": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "sessionID",
- "role",
- "time",
- "parentID",
- "modelID",
- "providerID",
- "mode",
- "agent",
- "path",
- "cost",
- "tokens"
- ]
- },
- "Message": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/UserMessage"
- },
- {
- "$ref": "#/components/schemas/AssistantMessage"
- }
- ]
- },
- "Event.message.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "message.updated"
- },
- "properties": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/Message"
- }
- },
- "required": ["info"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.message.removed": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "message.removed"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- }
- },
- "required": ["sessionID", "messageID"]
- }
- },
- "required": ["type", "properties"]
- },
- "TextPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "text"
- },
- "text": {
- "type": "string"
- },
- "synthetic": {
- "type": "boolean"
- },
- "ignored": {
- "type": "boolean"
- },
- "time": {
- "type": "object",
- "properties": {
- "start": {
- "type": "number"
- },
- "end": {
- "type": "number"
- }
- },
- "required": ["start"]
- },
- "metadata": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "text"]
- },
- "ReasoningPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "reasoning"
- },
- "text": {
- "type": "string"
- },
- "metadata": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "time": {
- "type": "object",
- "properties": {
- "start": {
- "type": "number"
- },
- "end": {
- "type": "number"
- }
- },
- "required": ["start"]
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "text", "time"]
- },
- "FilePartSourceText": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string"
- },
- "start": {
- "type": "integer",
- "minimum": -9007199254740991,
- "maximum": 9007199254740991
- },
- "end": {
- "type": "integer",
- "minimum": -9007199254740991,
- "maximum": 9007199254740991
- }
- },
- "required": ["value", "start", "end"]
- },
- "FileSource": {
- "type": "object",
- "properties": {
- "text": {
- "$ref": "#/components/schemas/FilePartSourceText"
- },
- "type": {
- "type": "string",
- "const": "file"
- },
- "path": {
- "type": "string"
- }
- },
- "required": ["text", "type", "path"]
- },
- "Range": {
- "type": "object",
- "properties": {
- "start": {
- "type": "object",
- "properties": {
- "line": {
- "type": "number"
- },
- "character": {
- "type": "number"
- }
- },
- "required": ["line", "character"]
- },
- "end": {
- "type": "object",
- "properties": {
- "line": {
- "type": "number"
- },
- "character": {
- "type": "number"
- }
- },
- "required": ["line", "character"]
- }
- },
- "required": ["start", "end"]
- },
- "SymbolSource": {
- "type": "object",
- "properties": {
- "text": {
- "$ref": "#/components/schemas/FilePartSourceText"
- },
- "type": {
- "type": "string",
- "const": "symbol"
- },
- "path": {
- "type": "string"
- },
- "range": {
- "$ref": "#/components/schemas/Range"
- },
- "name": {
- "type": "string"
- },
- "kind": {
- "type": "integer",
- "minimum": -9007199254740991,
- "maximum": 9007199254740991
- }
- },
- "required": ["text", "type", "path", "range", "name", "kind"]
- },
- "ResourceSource": {
- "type": "object",
- "properties": {
- "text": {
- "$ref": "#/components/schemas/FilePartSourceText"
- },
- "type": {
- "type": "string",
- "const": "resource"
- },
- "clientName": {
- "type": "string"
- },
- "uri": {
- "type": "string"
- }
- },
- "required": ["text", "type", "clientName", "uri"]
- },
- "FilePartSource": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/FileSource"
- },
- {
- "$ref": "#/components/schemas/SymbolSource"
- },
- {
- "$ref": "#/components/schemas/ResourceSource"
- }
- ]
- },
- "FilePart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "file"
- },
- "mime": {
- "type": "string"
- },
- "filename": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "source": {
- "$ref": "#/components/schemas/FilePartSource"
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "mime", "url"]
- },
- "ToolStatePending": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "const": "pending"
- },
- "input": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "raw": {
- "type": "string"
- }
- },
- "required": ["status", "input", "raw"]
- },
- "ToolStateRunning": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "const": "running"
- },
- "input": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "title": {
- "type": "string"
- },
- "metadata": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "time": {
- "type": "object",
- "properties": {
- "start": {
- "type": "number"
- }
- },
- "required": ["start"]
- }
- },
- "required": ["status", "input", "time"]
- },
- "ToolStateCompleted": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "const": "completed"
- },
- "input": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "output": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "metadata": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "time": {
- "type": "object",
- "properties": {
- "start": {
- "type": "number"
- },
- "end": {
- "type": "number"
- },
- "compacted": {
- "type": "number"
- }
- },
- "required": ["start", "end"]
- },
- "attachments": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FilePart"
- }
- }
- },
- "required": ["status", "input", "output", "title", "metadata", "time"]
- },
- "ToolStateError": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "const": "error"
- },
- "input": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "error": {
- "type": "string"
- },
- "metadata": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "time": {
- "type": "object",
- "properties": {
- "start": {
- "type": "number"
- },
- "end": {
- "type": "number"
- }
- },
- "required": ["start", "end"]
- }
- },
- "required": ["status", "input", "error", "time"]
- },
- "ToolState": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ToolStatePending"
- },
- {
- "$ref": "#/components/schemas/ToolStateRunning"
- },
- {
- "$ref": "#/components/schemas/ToolStateCompleted"
- },
- {
- "$ref": "#/components/schemas/ToolStateError"
- }
- ]
- },
- "ToolPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "tool"
- },
- "callID": {
- "type": "string"
- },
- "tool": {
- "type": "string"
- },
- "state": {
- "$ref": "#/components/schemas/ToolState"
- },
- "metadata": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "callID", "tool", "state"]
- },
- "StepStartPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "step-start"
- },
- "snapshot": {
- "type": "string"
- }
- },
- "required": ["id", "sessionID", "messageID", "type"]
- },
- "StepFinishPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "step-finish"
- },
- "reason": {
- "type": "string"
- },
- "snapshot": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "tokens": {
- "type": "object",
- "properties": {
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- },
- "reasoning": {
- "type": "number"
- },
- "cache": {
- "type": "object",
- "properties": {
- "read": {
- "type": "number"
- },
- "write": {
- "type": "number"
- }
- },
- "required": ["read", "write"]
- }
- },
- "required": ["input", "output", "reasoning", "cache"]
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "reason", "cost", "tokens"]
- },
- "SnapshotPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "snapshot"
- },
- "snapshot": {
- "type": "string"
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "snapshot"]
- },
- "PatchPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "patch"
- },
- "hash": {
- "type": "string"
- },
- "files": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "hash", "files"]
- },
- "AgentPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "agent"
- },
- "name": {
- "type": "string"
- },
- "source": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string"
- },
- "start": {
- "type": "integer",
- "minimum": -9007199254740991,
- "maximum": 9007199254740991
- },
- "end": {
- "type": "integer",
- "minimum": -9007199254740991,
- "maximum": 9007199254740991
- }
- },
- "required": ["value", "start", "end"]
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "name"]
- },
- "RetryPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "retry"
- },
- "attempt": {
- "type": "number"
- },
- "error": {
- "$ref": "#/components/schemas/APIError"
- },
- "time": {
- "type": "object",
- "properties": {
- "created": {
- "type": "number"
- }
- },
- "required": ["created"]
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "attempt", "error", "time"]
- },
- "CompactionPart": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "compaction"
- },
- "auto": {
- "type": "boolean"
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "auto"]
- },
- "Part": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/TextPart"
- },
- {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "subtask"
- },
- "prompt": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "agent": {
- "type": "string"
- },
- "model": {
- "type": "object",
- "properties": {
- "providerID": {
- "type": "string"
- },
- "modelID": {
- "type": "string"
- }
- },
- "required": ["providerID", "modelID"]
- },
- "command": {
- "type": "string"
- }
- },
- "required": ["id", "sessionID", "messageID", "type", "prompt", "description", "agent"]
- },
- {
- "$ref": "#/components/schemas/ReasoningPart"
- },
- {
- "$ref": "#/components/schemas/FilePart"
- },
- {
- "$ref": "#/components/schemas/ToolPart"
- },
- {
- "$ref": "#/components/schemas/StepStartPart"
- },
- {
- "$ref": "#/components/schemas/StepFinishPart"
- },
- {
- "$ref": "#/components/schemas/SnapshotPart"
- },
- {
- "$ref": "#/components/schemas/PatchPart"
- },
- {
- "$ref": "#/components/schemas/AgentPart"
- },
- {
- "$ref": "#/components/schemas/RetryPart"
- },
- {
- "$ref": "#/components/schemas/CompactionPart"
- }
- ]
- },
- "Event.message.part.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "message.part.updated"
- },
- "properties": {
- "type": "object",
- "properties": {
- "part": {
- "$ref": "#/components/schemas/Part"
- },
- "delta": {
- "type": "string"
- }
- },
- "required": ["part"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.message.part.removed": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "message.part.removed"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- },
- "messageID": {
- "type": "string"
- },
- "partID": {
- "type": "string"
- }
- },
- "required": ["sessionID", "messageID", "partID"]
- }
- },
- "required": ["type", "properties"]
- },
- "PermissionRequest": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "pattern": "^per.*"
- },
- "sessionID": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "permission": {
- "type": "string"
- },
- "patterns": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "metadata": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "always": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tool": {
- "type": "object",
- "properties": {
- "messageID": {
- "type": "string"
- },
- "callID": {
- "type": "string"
- }
- },
- "required": ["messageID", "callID"]
- }
- },
- "required": ["id", "sessionID", "permission", "patterns", "metadata", "always"]
- },
- "Event.permission.asked": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "permission.asked"
- },
- "properties": {
- "$ref": "#/components/schemas/PermissionRequest"
- }
- },
- "required": ["type", "properties"]
- },
- "Event.permission.replied": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "permission.replied"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- },
- "requestID": {
- "type": "string"
- },
- "reply": {
- "type": "string",
- "enum": ["once", "always", "reject"]
- }
- },
- "required": ["sessionID", "requestID", "reply"]
- }
- },
- "required": ["type", "properties"]
- },
- "SessionStatus": {
- "anyOf": [
- {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "idle"
- }
- },
- "required": ["type"]
- },
- {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "retry"
- },
- "attempt": {
- "type": "number"
- },
- "message": {
- "type": "string"
- },
- "next": {
- "type": "number"
- }
- },
- "required": ["type", "attempt", "message", "next"]
- },
- {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "busy"
- }
- },
- "required": ["type"]
- }
- ]
- },
- "Event.session.status": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "session.status"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- },
- "status": {
- "$ref": "#/components/schemas/SessionStatus"
- }
- },
- "required": ["sessionID", "status"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.session.idle": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "session.idle"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- }
- },
- "required": ["sessionID"]
- }
- },
- "required": ["type", "properties"]
- },
- "QuestionOption": {
- "type": "object",
- "properties": {
- "label": {
- "description": "Display text (1-5 words, concise)",
- "type": "string",
- "maxLength": 30
- },
- "description": {
- "description": "Explanation of choice",
- "type": "string"
- }
- },
- "required": ["label", "description"]
- },
- "QuestionInfo": {
- "type": "object",
- "properties": {
- "question": {
- "description": "Complete question",
- "type": "string"
- },
- "header": {
- "description": "Very short label (max 30 chars)",
- "type": "string",
- "maxLength": 30
- },
- "options": {
- "description": "Available choices",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/QuestionOption"
- }
- },
- "multiple": {
- "description": "Allow selecting multiple choices",
- "type": "boolean"
- },
- "custom": {
- "description": "Allow typing a custom answer (default: true)",
- "type": "boolean"
- }
- },
- "required": ["question", "header", "options"]
- },
- "QuestionRequest": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "pattern": "^que.*"
- },
- "sessionID": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "questions": {
- "description": "Questions to ask",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/QuestionInfo"
- }
- },
- "tool": {
- "type": "object",
- "properties": {
- "messageID": {
- "type": "string"
- },
- "callID": {
- "type": "string"
- }
- },
- "required": ["messageID", "callID"]
- }
- },
- "required": ["id", "sessionID", "questions"]
- },
- "Event.question.asked": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "question.asked"
- },
- "properties": {
- "$ref": "#/components/schemas/QuestionRequest"
- }
- },
- "required": ["type", "properties"]
- },
- "QuestionAnswer": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "Event.question.replied": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "question.replied"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- },
- "requestID": {
- "type": "string"
- },
- "answers": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/QuestionAnswer"
- }
- }
- },
- "required": ["sessionID", "requestID", "answers"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.question.rejected": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "question.rejected"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- },
- "requestID": {
- "type": "string"
- }
- },
- "required": ["sessionID", "requestID"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.session.compacted": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "session.compacted"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- }
- },
- "required": ["sessionID"]
- }
- },
- "required": ["type", "properties"]
- },
- "Todo": {
- "type": "object",
- "properties": {
- "content": {
- "description": "Brief description of the task",
- "type": "string"
- },
- "status": {
- "description": "Current status of the task: pending, in_progress, completed, cancelled",
- "type": "string"
- },
- "priority": {
- "description": "Priority level of the task: high, medium, low",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the todo item",
- "type": "string"
- }
- },
- "required": ["content", "status", "priority", "id"]
- },
- "Event.todo.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "todo.updated"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- },
- "todos": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Todo"
- }
- }
- },
- "required": ["sessionID", "todos"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.file.watcher.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "file.watcher.updated"
- },
- "properties": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string"
- },
- "event": {
- "anyOf": [
- {
- "type": "string",
- "const": "add"
- },
- {
- "type": "string",
- "const": "change"
- },
- {
- "type": "string",
- "const": "unlink"
- }
- ]
- }
- },
- "required": ["file", "event"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.tui.prompt.append": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "tui.prompt.append"
- },
- "properties": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- }
- },
- "required": ["text"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.tui.command.execute": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "tui.command.execute"
- },
- "properties": {
- "type": "object",
- "properties": {
- "command": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "session.list",
- "session.new",
- "session.share",
- "session.interrupt",
- "session.compact",
- "session.page.up",
- "session.page.down",
- "session.line.up",
- "session.line.down",
- "session.half.page.up",
- "session.half.page.down",
- "session.first",
- "session.last",
- "prompt.clear",
- "prompt.submit",
- "agent.cycle"
- ]
- },
- {
- "type": "string"
- }
- ]
- }
- },
- "required": ["command"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.tui.toast.show": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "tui.toast.show"
- },
- "properties": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "variant": {
- "type": "string",
- "enum": ["info", "success", "warning", "error"]
- },
- "duration": {
- "description": "Duration in milliseconds",
- "default": 5000,
- "type": "number"
- }
- },
- "required": ["message", "variant"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.tui.session.select": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "tui.session.select"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "description": "Session ID to navigate to",
- "type": "string",
- "pattern": "^ses"
- }
- },
- "required": ["sessionID"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.mcp.tools.changed": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "mcp.tools.changed"
- },
- "properties": {
- "type": "object",
- "properties": {
- "server": {
- "type": "string"
- }
- },
- "required": ["server"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.mcp.browser.open.failed": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "mcp.browser.open.failed"
- },
- "properties": {
- "type": "object",
- "properties": {
- "mcpName": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- },
- "required": ["mcpName", "url"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.command.executed": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "command.executed"
- },
- "properties": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "sessionID": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "arguments": {
- "type": "string"
- },
- "messageID": {
- "type": "string",
- "pattern": "^msg.*"
- }
- },
- "required": ["name", "sessionID", "arguments", "messageID"]
- }
- },
- "required": ["type", "properties"]
- },
- "PermissionAction": {
- "type": "string",
- "enum": ["allow", "deny", "ask"]
- },
- "PermissionRule": {
- "type": "object",
- "properties": {
- "permission": {
- "type": "string"
- },
- "pattern": {
- "type": "string"
- },
- "action": {
- "$ref": "#/components/schemas/PermissionAction"
- }
- },
- "required": ["permission", "pattern", "action"]
- },
- "PermissionRuleset": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PermissionRule"
- }
- },
- "Session": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "slug": {
- "type": "string"
- },
- "projectID": {
- "type": "string"
- },
- "directory": {
- "type": "string"
- },
- "parentID": {
- "type": "string",
- "pattern": "^ses.*"
- },
- "summary": {
- "type": "object",
- "properties": {
- "additions": {
- "type": "number"
- },
- "deletions": {
- "type": "number"
- },
- "files": {
- "type": "number"
- },
- "diffs": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FileDiff"
- }
- }
- },
- "required": ["additions", "deletions", "files"]
- },
- "share": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- }
- },
- "required": ["url"]
- },
- "title": {
- "type": "string"
- },
- "version": {
- "type": "string"
- },
- "time": {
- "type": "object",
- "properties": {
- "created": {
- "type": "number"
- },
- "updated": {
- "type": "number"
- },
- "compacting": {
- "type": "number"
- },
- "archived": {
- "type": "number"
- }
- },
- "required": ["created", "updated"]
- },
- "permission": {
- "$ref": "#/components/schemas/PermissionRuleset"
- },
- "revert": {
- "type": "object",
- "properties": {
- "messageID": {
- "type": "string"
- },
- "partID": {
- "type": "string"
- },
- "snapshot": {
- "type": "string"
- },
- "diff": {
- "type": "string"
- }
- },
- "required": ["messageID"]
- }
- },
- "required": ["id", "slug", "projectID", "directory", "title", "version", "time"]
- },
- "Event.session.created": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "session.created"
- },
- "properties": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/Session"
- }
- },
- "required": ["info"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.session.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "session.updated"
- },
- "properties": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/Session"
- }
- },
- "required": ["info"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.session.deleted": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "session.deleted"
- },
- "properties": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/Session"
- }
- },
- "required": ["info"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.session.diff": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "session.diff"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- },
- "diff": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FileDiff"
- }
- }
- },
- "required": ["sessionID", "diff"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.session.error": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "session.error"
- },
- "properties": {
- "type": "object",
- "properties": {
- "sessionID": {
- "type": "string"
- },
- "error": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ProviderAuthError"
- },
- {
- "$ref": "#/components/schemas/UnknownError"
- },
- {
- "$ref": "#/components/schemas/MessageOutputLengthError"
- },
- {
- "$ref": "#/components/schemas/MessageAbortedError"
- },
- {
- "$ref": "#/components/schemas/APIError"
- }
- ]
- }
- }
- }
- },
- "required": ["type", "properties"]
- },
- "Event.vcs.branch.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "vcs.branch.updated"
- },
- "properties": {
- "type": "object",
- "properties": {
- "branch": {
- "type": "string"
- }
- }
- }
- },
- "required": ["type", "properties"]
- },
- "Pty": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "pattern": "^pty.*"
- },
- "title": {
- "type": "string"
- },
- "command": {
- "type": "string"
- },
- "args": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "cwd": {
- "type": "string"
- },
- "status": {
- "type": "string",
- "enum": ["running", "exited"]
- },
- "pid": {
- "type": "number"
- }
- },
- "required": ["id", "title", "command", "args", "cwd", "status", "pid"]
- },
- "Event.pty.created": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "pty.created"
- },
- "properties": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/Pty"
- }
- },
- "required": ["info"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.pty.updated": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "pty.updated"
- },
- "properties": {
- "type": "object",
- "properties": {
- "info": {
- "$ref": "#/components/schemas/Pty"
- }
- },
- "required": ["info"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.pty.exited": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "pty.exited"
- },
- "properties": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "pattern": "^pty.*"
- },
- "exitCode": {
- "type": "number"
- }
- },
- "required": ["id", "exitCode"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event.pty.deleted": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "pty.deleted"
- },
- "properties": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "pattern": "^pty.*"
- }
- },
- "required": ["id"]
- }
- },
- "required": ["type", "properties"]
- },
- "Event": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Event.installation.updated"
- },
- {
- "$ref": "#/components/schemas/Event.installation.update-available"
- },
- {
- "$ref": "#/components/schemas/Event.project.updated"
- },
- {
- "$ref": "#/components/schemas/Event.server.instance.disposed"
- },
- {
- "$ref": "#/components/schemas/Event.server.connected"
- },
- {
- "$ref": "#/components/schemas/Event.global.disposed"
- },
- {
- "$ref": "#/components/schemas/Event.lsp.client.diagnostics"
- },
- {
- "$ref": "#/components/schemas/Event.lsp.updated"
- },
- {
- "$ref": "#/components/schemas/Event.file.edited"
- },
- {
- "$ref": "#/components/schemas/Event.message.updated"
- },
- {
- "$ref": "#/components/schemas/Event.message.removed"
- },
- {
- "$ref": "#/components/schemas/Event.message.part.updated"
- },
- {
- "$ref": "#/components/schemas/Event.message.part.removed"
- },
- {
- "$ref": "#/components/schemas/Event.permission.asked"
- },
- {
- "$ref": "#/components/schemas/Event.permission.replied"
- },
- {
- "$ref": "#/components/schemas/Event.session.status"
- },
- {
- "$ref": "#/components/schemas/Event.session.idle"
- },
- {
- "$ref": "#/components/schemas/Event.question.asked"
- },
- {
- "$ref": "#/components/schemas/Event.question.replied"
- },
- {
- "$ref": "#/components/schemas/Event.question.rejected"
- },
- {
- "$ref": "#/components/schemas/Event.session.compacted"
- },
- {
- "$ref": "#/components/schemas/Event.todo.updated"
- },
- {
- "$ref": "#/components/schemas/Event.file.watcher.updated"
- },
- {
- "$ref": "#/components/schemas/Event.tui.prompt.append"
- },
- {
- "$ref": "#/components/schemas/Event.tui.command.execute"
- },
- {
- "$ref": "#/components/schemas/Event.tui.toast.show"
- },
- {
- "$ref": "#/components/schemas/Event.tui.session.select"
- },
- {
- "$ref": "#/components/schemas/Event.mcp.tools.changed"
- },
- {
- "$ref": "#/components/schemas/Event.mcp.browser.open.failed"
- },
- {
- "$ref": "#/components/schemas/Event.command.executed"
- },
- {
- "$ref": "#/components/schemas/Event.session.created"
- },
- {
- "$ref": "#/components/schemas/Event.session.updated"
- },
- {
- "$ref": "#/components/schemas/Event.session.deleted"
- },
- {
- "$ref": "#/components/schemas/Event.session.diff"
- },
- {
- "$ref": "#/components/schemas/Event.session.error"
- },
- {
- "$ref": "#/components/schemas/Event.vcs.branch.updated"
- },
- {
- "$ref": "#/components/schemas/Event.pty.created"
- },
- {
- "$ref": "#/components/schemas/Event.pty.updated"
- },
- {
- "$ref": "#/components/schemas/Event.pty.exited"
- },
- {
- "$ref": "#/components/schemas/Event.pty.deleted"
- }
- ]
- },
- "GlobalEvent": {
- "type": "object",
- "properties": {
- "directory": {
- "type": "string"
- },
- "payload": {
- "$ref": "#/components/schemas/Event"
- }
- },
- "required": ["directory", "payload"]
- },
- "BadRequestError": {
- "type": "object",
- "properties": {
- "data": {},
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- }
- },
- "success": {
- "type": "boolean",
- "const": false
- }
- },
- "required": ["data", "errors", "success"]
- },
- "NotFoundError": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "const": "NotFoundError"
- },
- "data": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- }
- },
- "required": ["message"]
- }
- },
- "required": ["name", "data"]
- },
- "KeybindsConfig": {
- "description": "Custom keybind configurations",
- "type": "object",
- "properties": {
- "leader": {
- "description": "Leader key for keybind combinations",
- "default": "ctrl+x",
- "type": "string"
- },
- "app_exit": {
- "description": "Exit the application",
- "default": "ctrl+c,ctrl+d,<leader>q",
- "type": "string"
- },
- "editor_open": {
- "description": "Open external editor",
- "default": "<leader>e",
- "type": "string"
- },
- "theme_list": {
- "description": "List available themes",
- "default": "<leader>t",
- "type": "string"
- },
- "sidebar_toggle": {
- "description": "Toggle sidebar",
- "default": "<leader>b",
- "type": "string"
- },
- "scrollbar_toggle": {
- "description": "Toggle session scrollbar",
- "default": "none",
- "type": "string"
- },
- "username_toggle": {
- "description": "Toggle username visibility",
- "default": "none",
- "type": "string"
- },
- "status_view": {
- "description": "View status",
- "default": "<leader>s",
- "type": "string"
- },
- "session_export": {
- "description": "Export session to editor",
- "default": "<leader>x",
- "type": "string"
- },
- "session_new": {
- "description": "Create a new session",
- "default": "<leader>n",
- "type": "string"
- },
- "session_list": {
- "description": "List all sessions",
- "default": "<leader>l",
- "type": "string"
- },
- "session_timeline": {
- "description": "Show session timeline",
- "default": "<leader>g",
- "type": "string"
- },
- "session_fork": {
- "description": "Fork session from message",
- "default": "none",
- "type": "string"
- },
- "session_rename": {
- "description": "Rename session",
- "default": "ctrl+r",
- "type": "string"
- },
- "session_delete": {
- "description": "Delete session",
- "default": "ctrl+d",
- "type": "string"
- },
- "stash_delete": {
- "description": "Delete stash entry",
- "default": "ctrl+d",
- "type": "string"
- },
- "model_provider_list": {
- "description": "Open provider list from model dialog",
- "default": "ctrl+a",
- "type": "string"
- },
- "model_favorite_toggle": {
- "description": "Toggle model favorite status",
- "default": "ctrl+f",
- "type": "string"
- },
- "session_share": {
- "description": "Share current session",
- "default": "none",
- "type": "string"
- },
- "session_unshare": {
- "description": "Unshare current session",
- "default": "none",
- "type": "string"
- },
- "session_interrupt": {
- "description": "Interrupt current session",
- "default": "escape",
- "type": "string"
- },
- "session_compact": {
- "description": "Compact the session",
- "default": "<leader>c",
- "type": "string"
- },
- "messages_page_up": {
- "description": "Scroll messages up by one page",
- "default": "pageup,ctrl+alt+b",
- "type": "string"
- },
- "messages_page_down": {
- "description": "Scroll messages down by one page",
- "default": "pagedown,ctrl+alt+f",
- "type": "string"
- },
- "messages_line_up": {
- "description": "Scroll messages up by one line",
- "default": "ctrl+alt+y",
- "type": "string"
- },
- "messages_line_down": {
- "description": "Scroll messages down by one line",
- "default": "ctrl+alt+e",
- "type": "string"
- },
- "messages_half_page_up": {
- "description": "Scroll messages up by half page",
- "default": "ctrl+alt+u",
- "type": "string"
- },
- "messages_half_page_down": {
- "description": "Scroll messages down by half page",
- "default": "ctrl+alt+d",
- "type": "string"
- },
- "messages_first": {
- "description": "Navigate to first message",
- "default": "ctrl+g,home",
- "type": "string"
- },
- "messages_last": {
- "description": "Navigate to last message",
- "default": "ctrl+alt+g,end",
- "type": "string"
- },
- "messages_next": {
- "description": "Navigate to next message",
- "default": "none",
- "type": "string"
- },
- "messages_previous": {
- "description": "Navigate to previous message",
- "default": "none",
- "type": "string"
- },
- "messages_last_user": {
- "description": "Navigate to last user message",
- "default": "none",
- "type": "string"
- },
- "messages_copy": {
- "description": "Copy message",
- "default": "<leader>y",
- "type": "string"
- },
- "messages_undo": {
- "description": "Undo message",
- "default": "<leader>u",
- "type": "string"
- },
- "messages_redo": {
- "description": "Redo message",
- "default": "<leader>r",
- "type": "string"
- },
- "messages_toggle_conceal": {
- "description": "Toggle code block concealment in messages",
- "default": "<leader>h",
- "type": "string"
- },
- "tool_details": {
- "description": "Toggle tool details visibility",
- "default": "none",
- "type": "string"
- },
- "model_list": {
- "description": "List available models",
- "default": "<leader>m",
- "type": "string"
- },
- "model_cycle_recent": {
- "description": "Next recently used model",
- "default": "f2",
- "type": "string"
- },
- "model_cycle_recent_reverse": {
- "description": "Previous recently used model",
- "default": "shift+f2",
- "type": "string"
- },
- "model_cycle_favorite": {
- "description": "Next favorite model",
- "default": "none",
- "type": "string"
- },
- "model_cycle_favorite_reverse": {
- "description": "Previous favorite model",
- "default": "none",
- "type": "string"
- },
- "command_list": {
- "description": "List available commands",
- "default": "ctrl+p",
- "type": "string"
- },
- "agent_list": {
- "description": "List agents",
- "default": "<leader>a",
- "type": "string"
- },
- "agent_cycle": {
- "description": "Next agent",
- "default": "tab",
- "type": "string"
- },
- "agent_cycle_reverse": {
- "description": "Previous agent",
- "default": "shift+tab",
- "type": "string"
- },
- "variant_cycle": {
- "description": "Cycle model variants",
- "default": "ctrl+t",
- "type": "string"
- },
- "input_clear": {
- "description": "Clear input field",
- "default": "ctrl+c",
- "type": "string"
- },
- "input_paste": {
- "description": "Paste from clipboard",
- "default": "ctrl+v",
- "type": "string"
- },
- "input_submit": {
- "description": "Submit input",
- "default": "return",
- "type": "string"
- },
- "input_newline": {
- "description": "Insert newline in input",
- "default": "shift+return,ctrl+return,alt+return,ctrl+j",
- "type": "string"
- },
- "input_move_left": {
- "description": "Move cursor left in input",
- "default": "left,ctrl+b",
- "type": "string"
- },
- "input_move_right": {
- "description": "Move cursor right in input",
- "default": "right,ctrl+f",
- "type": "string"
- },
- "input_move_up": {
- "description": "Move cursor up in input",
- "default": "up",
- "type": "string"
- },
- "input_move_down": {
- "description": "Move cursor down in input",
- "default": "down",
- "type": "string"
- },
- "input_select_left": {
- "description": "Select left in input",
- "default": "shift+left",
- "type": "string"
- },
- "input_select_right": {
- "description": "Select right in input",
- "default": "shift+right",
- "type": "string"
- },
- "input_select_up": {
- "description": "Select up in input",
- "default": "shift+up",
- "type": "string"
- },
- "input_select_down": {
- "description": "Select down in input",
- "default": "shift+down",
- "type": "string"
- },
- "input_line_home": {
- "description": "Move to start of line in input",
- "default": "ctrl+a",
- "type": "string"
- },
- "input_line_end": {
- "description": "Move to end of line in input",
- "default": "ctrl+e",
- "type": "string"
- },
- "input_select_line_home": {
- "description": "Select to start of line in input",
- "default": "ctrl+shift+a",
- "type": "string"
- },
- "input_select_line_end": {
- "description": "Select to end of line in input",
- "default": "ctrl+shift+e",
- "type": "string"
- },
- "input_visual_line_home": {
- "description": "Move to start of visual line in input",
- "default": "alt+a",
- "type": "string"
- },
- "input_visual_line_end": {
- "description": "Move to end of visual line in input",
- "default": "alt+e",
- "type": "string"
- },
- "input_select_visual_line_home": {
- "description": "Select to start of visual line in input",
- "default": "alt+shift+a",
- "type": "string"
- },
- "input_select_visual_line_end": {
- "description": "Select to end of visual line in input",
- "default": "alt+shift+e",
- "type": "string"
- },
- "input_buffer_home": {
- "description": "Move to start of buffer in input",
- "default": "home",
- "type": "string"
- },
- "input_buffer_end": {
- "description": "Move to end of buffer in input",
- "default": "end",
- "type": "string"
- },
- "input_select_buffer_home": {
- "description": "Select to start of buffer in input",
- "default": "shift+home",
- "type": "string"
- },
- "input_select_buffer_end": {
- "description": "Select to end of buffer in input",
- "default": "shift+end",
- "type": "string"
- },
- "input_delete_line": {
- "description": "Delete line in input",
- "default": "ctrl+shift+d",
- "type": "string"
- },
- "input_delete_to_line_end": {
- "description": "Delete to end of line in input",
- "default": "ctrl+k",
- "type": "string"
- },
- "input_delete_to_line_start": {
- "description": "Delete to start of line in input",
- "default": "ctrl+u",
- "type": "string"
- },
- "input_backspace": {
- "description": "Backspace in input",
- "default": "backspace,shift+backspace",
- "type": "string"
- },
- "input_delete": {
- "description": "Delete character in input",
- "default": "ctrl+d,delete,shift+delete",
- "type": "string"
- },
- "input_undo": {
- "description": "Undo in input",
- "default": "ctrl+-,super+z",
- "type": "string"
- },
- "input_redo": {
- "description": "Redo in input",
- "default": "ctrl+.,super+shift+z",
- "type": "string"
- },
- "input_word_forward": {
- "description": "Move word forward in input",
- "default": "alt+f,alt+right,ctrl+right",
- "type": "string"
- },
- "input_word_backward": {
- "description": "Move word backward in input",
- "default": "alt+b,alt+left,ctrl+left",
- "type": "string"
- },
- "input_select_word_forward": {
- "description": "Select word forward in input",
- "default": "alt+shift+f,alt+shift+right",
- "type": "string"
- },
- "input_select_word_backward": {
- "description": "Select word backward in input",
- "default": "alt+shift+b,alt+shift+left",
- "type": "string"
- },
- "input_delete_word_forward": {
- "description": "Delete word forward in input",
- "default": "alt+d,alt+delete,ctrl+delete",
- "type": "string"
- },
- "input_delete_word_backward": {
- "description": "Delete word backward in input",
- "default": "ctrl+w,ctrl+backspace,alt+backspace",
- "type": "string"
- },
- "history_previous": {
- "description": "Previous history item",
- "default": "up",
- "type": "string"
- },
- "history_next": {
- "description": "Next history item",
- "default": "down",
- "type": "string"
- },
- "session_child_cycle": {
- "description": "Next child session",
- "default": "<leader>right",
- "type": "string"
- },
- "session_child_cycle_reverse": {
- "description": "Previous child session",
- "default": "<leader>left",
- "type": "string"
- },
- "session_parent": {
- "description": "Go to parent session",
- "default": "<leader>up",
- "type": "string"
- },
- "terminal_suspend": {
- "description": "Suspend terminal",
- "default": "ctrl+z",
- "type": "string"
- },
- "terminal_title_toggle": {
- "description": "Toggle terminal title",
- "default": "none",
- "type": "string"
- },
- "tips_toggle": {
- "description": "Toggle tips on home screen",
- "default": "<leader>h",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "LogLevel": {
- "description": "Log level",
- "type": "string",
- "enum": ["DEBUG", "INFO", "WARN", "ERROR"]
- },
- "ServerConfig": {
- "description": "Server configuration for opencode serve and web commands",
- "type": "object",
- "properties": {
- "port": {
- "description": "Port to listen on",
- "type": "integer",
- "exclusiveMinimum": 0,
- "maximum": 9007199254740991
- },
- "hostname": {
- "description": "Hostname to listen on",
- "type": "string"
- },
- "mdns": {
- "description": "Enable mDNS service discovery",
- "type": "boolean"
- },
- "cors": {
- "description": "Additional domains to allow for CORS",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "additionalProperties": false
- },
- "PermissionActionConfig": {
- "type": "string",
- "enum": ["ask", "allow", "deny"]
- },
- "PermissionObjectConfig": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/PermissionActionConfig"
- }
- },
- "PermissionRuleConfig": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/PermissionActionConfig"
- },
- {
- "$ref": "#/components/schemas/PermissionObjectConfig"
- }
- ]
- },
- "PermissionConfig": {
- "anyOf": [
- {
- "type": "object",
- "properties": {
- "__originalKeys": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "read": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- },
- "edit": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- },
- "glob": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- },
- "grep": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- },
- "list": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- },
- "bash": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- },
- "task": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- },
- "external_directory": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- },
- "todowrite": {
- "$ref": "#/components/schemas/PermissionActionConfig"
- },
- "todoread": {
- "$ref": "#/components/schemas/PermissionActionConfig"
- },
- "question": {
- "$ref": "#/components/schemas/PermissionActionConfig"
- },
- "webfetch": {
- "$ref": "#/components/schemas/PermissionActionConfig"
- },
- "websearch": {
- "$ref": "#/components/schemas/PermissionActionConfig"
- },
- "codesearch": {
- "$ref": "#/components/schemas/PermissionActionConfig"
- },
- "lsp": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- },
- "doom_loop": {
- "$ref": "#/components/schemas/PermissionActionConfig"
- }
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/PermissionRuleConfig"
- }
- },
- {
- "$ref": "#/components/schemas/PermissionActionConfig"
- }
- ]
- },
- "AgentConfig": {
- "type": "object",
- "properties": {
- "model": {
- "type": "string"
- },
- "temperature": {
- "type": "number"
- },
- "top_p": {
- "type": "number"
- },
- "prompt": {
- "type": "string"
- },
- "tools": {
- "description": "@deprecated Use 'permission' field instead",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "boolean"
- }
- },
- "disable": {
- "type": "boolean"
- },
- "description": {
- "description": "Description of when to use the agent",
- "type": "string"
- },
- "mode": {
- "type": "string",
- "enum": ["subagent", "primary", "all"]
- },
- "hidden": {
- "description": "Hide this subagent from the @ autocomplete menu (default: false, only applies to mode: subagent)",
- "type": "boolean"
- },
- "options": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "color": {
- "description": "Hex color code for the agent (e.g., #FF5733)",
- "type": "string",
- "pattern": "^#[0-9a-fA-F]{6}$"
- },
- "steps": {
- "description": "Maximum number of agentic iterations before forcing text-only response",
- "type": "integer",
- "exclusiveMinimum": 0,
- "maximum": 9007199254740991
- },
- "maxSteps": {
- "description": "@deprecated Use 'steps' field instead.",
- "type": "integer",
- "exclusiveMinimum": 0,
- "maximum": 9007199254740991
- },
- "permission": {
- "$ref": "#/components/schemas/PermissionConfig"
- }
- },
- "additionalProperties": {}
- },
- "ProviderConfig": {
- "type": "object",
- "properties": {
- "api": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "env": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "type": "string"
- },
- "npm": {
- "type": "string"
- },
- "models": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "family": {
- "type": "string"
- },
- "release_date": {
- "type": "string"
- },
- "attachment": {
- "type": "boolean"
- },
- "reasoning": {
- "type": "boolean"
- },
- "temperature": {
- "type": "boolean"
- },
- "tool_call": {
- "type": "boolean"
- },
- "interleaved": {
- "anyOf": [
- {
- "type": "boolean",
- "const": true
- },
- {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "enum": ["reasoning_content", "reasoning_details"]
- }
- },
- "required": ["field"],
- "additionalProperties": false
- }
- ]
- },
- "cost": {
- "type": "object",
- "properties": {
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- },
- "cache_read": {
- "type": "number"
- },
- "cache_write": {
- "type": "number"
- },
- "context_over_200k": {
- "type": "object",
- "properties": {
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- },
- "cache_read": {
- "type": "number"
- },
- "cache_write": {
- "type": "number"
- }
- },
- "required": ["input", "output"]
- }
- },
- "required": ["input", "output"]
- },
- "limit": {
- "type": "object",
- "properties": {
- "context": {
- "type": "number"
- },
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- }
- },
- "required": ["context", "output"]
- },
- "modalities": {
- "type": "object",
- "properties": {
- "input": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["text", "audio", "image", "video", "pdf"]
- }
- },
- "output": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["text", "audio", "image", "video", "pdf"]
- }
- }
- },
- "required": ["input", "output"]
- },
- "experimental": {
- "type": "boolean"
- },
- "status": {
- "type": "string",
- "enum": ["alpha", "beta", "deprecated"]
- },
- "options": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "headers": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- "provider": {
- "type": "object",
- "properties": {
- "npm": {
- "type": "string"
- }
- },
- "required": ["npm"]
- },
- "variants": {
- "description": "Variant-specific configuration",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "object",
- "properties": {
- "disabled": {
- "description": "Disable this variant for the model",
- "type": "boolean"
- }
- },
- "additionalProperties": {}
- }
- }
- }
- }
- },
- "whitelist": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "blacklist": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "options": {
- "type": "object",
- "properties": {
- "apiKey": {
- "type": "string"
- },
- "baseURL": {
- "type": "string"
- },
- "enterpriseUrl": {
- "description": "GitHub Enterprise URL for copilot authentication",
- "type": "string"
- },
- "setCacheKey": {
- "description": "Enable promptCacheKey for this provider (default false)",
- "type": "boolean"
- },
- "timeout": {
- "description": "Timeout in milliseconds for requests to this provider. Default is 300000 (5 minutes). Set to false to disable timeout.",
- "anyOf": [
- {
- "description": "Timeout in milliseconds for requests to this provider. Default is 300000 (5 minutes). Set to false to disable timeout.",
- "type": "integer",
- "exclusiveMinimum": 0,
- "maximum": 9007199254740991
- },
- {
- "description": "Disable timeout for this provider entirely.",
- "type": "boolean",
- "const": false
- }
- ]
- }
- },
- "additionalProperties": {}
- }
- },
- "additionalProperties": false
- },
- "McpLocalConfig": {
- "type": "object",
- "properties": {
- "type": {
- "description": "Type of MCP server connection",
- "type": "string",
- "const": "local"
- },
- "command": {
- "description": "Command and arguments to run the MCP server",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "environment": {
- "description": "Environment variables to set when running the MCP server",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- "enabled": {
- "description": "Enable or disable the MCP server on startup",
- "type": "boolean"
- },
- "timeout": {
- "description": "Timeout in ms for MCP server requests. Defaults to 5000 (5 seconds) if not specified.",
- "type": "integer",
- "exclusiveMinimum": 0,
- "maximum": 9007199254740991
- }
- },
- "required": ["type", "command"],
- "additionalProperties": false
- },
- "McpOAuthConfig": {
- "type": "object",
- "properties": {
- "clientId": {
- "description": "OAuth client ID. If not provided, dynamic client registration (RFC 7591) will be attempted.",
- "type": "string"
- },
- "clientSecret": {
- "description": "OAuth client secret (if required by the authorization server)",
- "type": "string"
- },
- "scope": {
- "description": "OAuth scopes to request during authorization",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "McpRemoteConfig": {
- "type": "object",
- "properties": {
- "type": {
- "description": "Type of MCP server connection",
- "type": "string",
- "const": "remote"
- },
- "url": {
- "description": "URL of the remote MCP server",
- "type": "string"
- },
- "enabled": {
- "description": "Enable or disable the MCP server on startup",
- "type": "boolean"
- },
- "headers": {
- "description": "Headers to send with the request",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- "oauth": {
- "description": "OAuth authentication configuration for the MCP server. Set to false to disable OAuth auto-detection.",
- "anyOf": [
- {
- "$ref": "#/components/schemas/McpOAuthConfig"
- },
- {
- "type": "boolean",
- "const": false
- }
- ]
- },
- "timeout": {
- "description": "Timeout in ms for MCP server requests. Defaults to 5000 (5 seconds) if not specified.",
- "type": "integer",
- "exclusiveMinimum": 0,
- "maximum": 9007199254740991
- }
- },
- "required": ["type", "url"],
- "additionalProperties": false
- },
- "LayoutConfig": {
- "description": "@deprecated Always uses stretch layout.",
- "type": "string",
- "enum": ["auto", "stretch"]
- },
- "Config": {
- "type": "object",
- "properties": {
- "$schema": {
- "description": "JSON schema reference for configuration validation",
- "type": "string"
- },
- "theme": {
- "description": "Theme name to use for the interface",
- "type": "string"
- },
- "keybinds": {
- "$ref": "#/components/schemas/KeybindsConfig"
- },
- "logLevel": {
- "$ref": "#/components/schemas/LogLevel"
- },
- "tui": {
- "description": "TUI specific settings",
- "type": "object",
- "properties": {
- "scroll_speed": {
- "description": "TUI scroll speed",
- "type": "number",
- "minimum": 0.001
- },
- "scroll_acceleration": {
- "description": "Scroll acceleration settings",
- "type": "object",
- "properties": {
- "enabled": {
- "description": "Enable scroll acceleration",
- "type": "boolean"
- }
- },
- "required": ["enabled"]
- },
- "diff_style": {
- "description": "Control diff rendering style: 'auto' adapts to terminal width, 'stacked' always shows single column",
- "type": "string",
- "enum": ["auto", "stacked"]
- }
- }
- },
- "server": {
- "$ref": "#/components/schemas/ServerConfig"
- },
- "command": {
- "description": "Command configuration, see https://opencode.ai/docs/commands",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "object",
- "properties": {
- "template": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "agent": {
- "type": "string"
- },
- "model": {
- "type": "string"
- },
- "subtask": {
- "type": "boolean"
- }
- },
- "required": ["template"]
- }
- },
- "watcher": {
- "type": "object",
- "properties": {
- "ignore": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "plugin": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "snapshot": {
- "type": "boolean"
- },
- "share": {
- "description": "Control sharing behavior:'manual' allows manual sharing via commands, 'auto' enables automatic sharing, 'disabled' disables all sharing",
- "type": "string",
- "enum": ["manual", "auto", "disabled"]
- },
- "autoshare": {
- "description": "@deprecated Use 'share' field instead. Share newly created sessions automatically",
- "type": "boolean"
- },
- "autoupdate": {
- "description": "Automatically update to the latest version. Set to true to auto-update, false to disable, or 'notify' to show update notifications",
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "string",
- "const": "notify"
- }
- ]
- },
- "disabled_providers": {
- "description": "Disable providers that are loaded automatically",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "enabled_providers": {
- "description": "When set, ONLY these providers will be enabled. All other providers will be ignored",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "model": {
- "description": "Model to use in the format of provider/model, eg anthropic/claude-2",
- "type": "string"
- },
- "small_model": {
- "description": "Small model to use for tasks like title generation in the format of provider/model",
- "type": "string"
- },
- "default_agent": {
- "description": "Default agent to use when none is specified. Must be a primary agent. Falls back to 'build' if not set or if the specified agent is invalid.",
- "type": "string"
- },
- "username": {
- "description": "Custom username to display in conversations instead of system username",
- "type": "string"
- },
- "mode": {
- "description": "@deprecated Use `agent` field instead.",
- "type": "object",
- "properties": {
- "build": {
- "$ref": "#/components/schemas/AgentConfig"
- },
- "plan": {
- "$ref": "#/components/schemas/AgentConfig"
- }
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/AgentConfig"
- }
- },
- "agent": {
- "description": "Agent configuration, see https://opencode.ai/docs/agents",
- "type": "object",
- "properties": {
- "plan": {
- "$ref": "#/components/schemas/AgentConfig"
- },
- "build": {
- "$ref": "#/components/schemas/AgentConfig"
- },
- "general": {
- "$ref": "#/components/schemas/AgentConfig"
- },
- "explore": {
- "$ref": "#/components/schemas/AgentConfig"
- },
- "title": {
- "$ref": "#/components/schemas/AgentConfig"
- },
- "summary": {
- "$ref": "#/components/schemas/AgentConfig"
- },
- "compaction": {
- "$ref": "#/components/schemas/AgentConfig"
- }
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/AgentConfig"
- }
- },
- "provider": {
- "description": "Custom provider configurations and model overrides",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/ProviderConfig"
- }
- },
- "mcp": {
- "description": "MCP (Model Context Protocol) server configurations",
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "anyOf": [
- {
- "anyOf": [
- {
- "$ref": "#/components/schemas/McpLocalConfig"
- },
- {
- "$ref": "#/components/schemas/McpRemoteConfig"
- }
- ]
- },
- {
- "type": "object",
- "properties": {
- "enabled": {
- "type": "boolean"
- }
- },
- "required": ["enabled"],
- "additionalProperties": false
- }
- ]
- }
- },
- "formatter": {
- "anyOf": [
- {
- "type": "boolean",
- "const": false
- },
- {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "object",
- "properties": {
- "disabled": {
- "type": "boolean"
- },
- "command": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "environment": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- "extensions": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- ]
- },
- "lsp": {
- "anyOf": [
- {
- "type": "boolean",
- "const": false
- },
- {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "anyOf": [
- {
- "type": "object",
- "properties": {
- "disabled": {
- "type": "boolean",
- "const": true
- }
- },
- "required": ["disabled"]
- },
- {
- "type": "object",
- "properties": {
- "command": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "extensions": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "disabled": {
- "type": "boolean"
- },
- "env": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- "initialization": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- }
- },
- "required": ["command"]
- }
- ]
- }
- }
- ]
- },
- "instructions": {
- "description": "Additional instruction files or patterns to include",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "layout": {
- "$ref": "#/components/schemas/LayoutConfig"
- },
- "permission": {
- "$ref": "#/components/schemas/PermissionConfig"
- },
- "tools": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "boolean"
- }
- },
- "enterprise": {
- "type": "object",
- "properties": {
- "url": {
- "description": "Enterprise URL",
- "type": "string"
- }
- }
- },
- "compaction": {
- "type": "object",
- "properties": {
- "auto": {
- "description": "Enable automatic compaction when context is full (default: true)",
- "type": "boolean"
- },
- "prune": {
- "description": "Enable pruning of old tool outputs (default: true)",
- "type": "boolean"
- }
- }
- },
- "experimental": {
- "type": "object",
- "properties": {
- "hook": {
- "type": "object",
- "properties": {
- "file_edited": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "command": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "environment": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "required": ["command"]
- }
- }
- },
- "session_completed": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "command": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "environment": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "required": ["command"]
- }
- }
- }
- },
- "chatMaxRetries": {
- "description": "Number of retries for chat completions on failure",
- "type": "number"
- },
- "disable_paste_summary": {
- "type": "boolean"
- },
- "batch_tool": {
- "description": "Enable the batch tool",
- "type": "boolean"
- },
- "openTelemetry": {
- "description": "Enable OpenTelemetry spans for AI SDK calls (using the 'experimental_telemetry' flag)",
- "type": "boolean"
- },
- "primary_tools": {
- "description": "Tools that should only be available to primary agents.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "continue_loop_on_deny": {
- "description": "Continue the agent loop when a tool call is denied",
- "type": "boolean"
- },
- "mcp_timeout": {
- "description": "Timeout in milliseconds for model context protocol (MCP) requests",
- "type": "integer",
- "exclusiveMinimum": 0,
- "maximum": 9007199254740991
- }
- }
- }
- },
- "additionalProperties": false
- },
- "Model": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "providerID": {
- "type": "string"
- },
- "api": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "npm": {
- "type": "string"
- }
- },
- "required": ["id", "url", "npm"]
- },
- "name": {
- "type": "string"
- },
- "family": {
- "type": "string"
- },
- "capabilities": {
- "type": "object",
- "properties": {
- "temperature": {
- "type": "boolean"
- },
- "reasoning": {
- "type": "boolean"
- },
- "attachment": {
- "type": "boolean"
- },
- "toolcall": {
- "type": "boolean"
- },
- "input": {
- "type": "object",
- "properties": {
- "text": {
- "type": "boolean"
- },
- "audio": {
- "type": "boolean"
- },
- "image": {
- "type": "boolean"
- },
- "video": {
- "type": "boolean"
- },
- "pdf": {
- "type": "boolean"
- }
- },
- "required": ["text", "audio", "image", "video", "pdf"]
- },
- "output": {
- "type": "object",
- "properties": {
- "text": {
- "type": "boolean"
- },
- "audio": {
- "type": "boolean"
- },
- "image": {
- "type": "boolean"
- },
- "video": {
- "type": "boolean"
- },
- "pdf": {
- "type": "boolean"
- }
- },
- "required": ["text", "audio", "image", "video", "pdf"]
- },
- "interleaved": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "object",
- "properties": {
- "field": {
- "type": "string",
- "enum": ["reasoning_content", "reasoning_details"]
- }
- },
- "required": ["field"]
- }
- ]
- }
- },
- "required": ["temperature", "reasoning", "attachment", "toolcall", "input", "output", "interleaved"]
- },
- "cost": {
- "type": "object",
- "properties": {
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- },
- "cache": {
- "type": "object",
- "properties": {
- "read": {
- "type": "number"
- },
- "write": {
- "type": "number"
- }
- },
- "required": ["read", "write"]
- },
- "experimentalOver200K": {
- "type": "object",
- "properties": {
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- },
- "cache": {
- "type": "object",
- "properties": {
- "read": {
- "type": "number"
- },
- "write": {
- "type": "number"
- }
- },
- "required": ["read", "write"]
- }
- },
- "required": ["input", "output", "cache"]
- }
- },
- "required": ["input", "output", "cache"]
- },
- "limit": {
- "type": "object",
- "properties": {
- "context": {
- "type": "number"
- },
- "input": {
- "type": "number"
- },
- "output": {
- "type": "number"
- }
- },
- "required": ["context", "output"]
- },
- "status": {
- "type": "string",
- "enum": ["alpha", "beta", "deprecated", "active"]
- },
- "options": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "headers": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- "release_date": {
- "type": "string"
- },
- "variants": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- }
- }
- },
- "required": [
- "id",
- "providerID",
- "api",
- "name",
- "capabilities",
- "cost",
- "limit",
- "status",
- "options",
- "headers",
- "release_date"
- ]
- },
- "Provider": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "source": {
- "type": "string",
- "enum": ["env", "config", "custom", "api"]
- },
- "env": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "key": {
- "type": "string"
- },
- "options": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "models": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "$ref": "#/components/schemas/Model"
- }
- }
- },
- "required": ["id", "name", "source", "env", "options", "models"]
- },
- "ToolIDs": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "ToolListItem": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "parameters": {}
- },
- "required": ["id", "description", "parameters"]
- },
- "ToolList": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ToolListItem"
- }
- },
- "Worktree": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "branch": {
- "type": "string"
- },
- "directory": {
- "type": "string"
- }
- },
- "required": ["name", "branch", "directory"]
- },
- "WorktreeCreateInput": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "startCommand": {
- "type": "string"
- }
- }
- },
- "WorktreeRemoveInput": {
- "type": "object",
- "properties": {
- "directory": {
- "type": "string"
- }
- },
- "required": ["directory"]
- },
- "WorktreeResetInput": {
- "type": "object",
- "properties": {
- "directory": {
- "type": "string"
- }
- },
- "required": ["directory"]
- },
- "McpResource": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "uri": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "mimeType": {
- "type": "string"
- },
- "client": {
- "type": "string"
- }
- },
- "required": ["name", "uri", "client"]
- },
- "TextPartInput": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "text"
- },
- "text": {
- "type": "string"
- },
- "synthetic": {
- "type": "boolean"
- },
- "ignored": {
- "type": "boolean"
- },
- "time": {
- "type": "object",
- "properties": {
- "start": {
- "type": "number"
- },
- "end": {
- "type": "number"
- }
- },
- "required": ["start"]
- },
- "metadata": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- }
- },
- "required": ["type", "text"]
- },
- "FilePartInput": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "file"
- },
- "mime": {
- "type": "string"
- },
- "filename": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "source": {
- "$ref": "#/components/schemas/FilePartSource"
- }
- },
- "required": ["type", "mime", "url"]
- },
- "AgentPartInput": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "agent"
- },
- "name": {
- "type": "string"
- },
- "source": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string"
- },
- "start": {
- "type": "integer",
- "minimum": -9007199254740991,
- "maximum": 9007199254740991
- },
- "end": {
- "type": "integer",
- "minimum": -9007199254740991,
- "maximum": 9007199254740991
- }
- },
- "required": ["value", "start", "end"]
- }
- },
- "required": ["type", "name"]
- },
- "SubtaskPartInput": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "const": "subtask"
- },
- "prompt": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "agent": {
- "type": "string"
- },
- "model": {
- "type": "object",
- "properties": {
- "providerID": {
- "type": "string"
- },
- "modelID": {
- "type": "string"
- }
- },
- "required": ["providerID", "modelID"]
- },
- "command": {
- "type": "string"
- }
- },
- "required": ["type", "prompt", "description", "agent"]
- },
- "ProviderAuthMethod": {
- "type": "object",
- "properties": {
- "type": {
- "anyOf": [
- {
- "type": "string",
- "const": "oauth"
- },
- {
- "type": "string",
- "const": "api"
- }
- ]
- },
- "label": {
- "type": "string"
- }
- },
- "required": ["type", "label"]
- },
- "ProviderAuthAuthorization": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "method": {
- "anyOf": [
- {
- "type": "string",
- "const": "auto"
- },
- {
- "type": "string",
- "const": "code"
- }
- ]
- },
- "instructions": {
- "type": "string"
- }
- },
- "required": ["url", "method", "instructions"]
- },
- "Symbol": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "kind": {
- "type": "number"
- },
- "location": {
- "type": "object",
- "properties": {
- "uri": {
- "type": "string"
- },
- "range": {
- "$ref": "#/components/schemas/Range"
- }
- },
- "required": ["uri", "range"]
- }
- },
- "required": ["name", "kind", "location"]
- },
- "FileNode": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "path": {
- "type": "string"
- },
- "absolute": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": ["file", "directory"]
- },
- "ignored": {
- "type": "boolean"
- }
- },
- "required": ["name", "path", "absolute", "type", "ignored"]
- },
- "FileContent": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "text"
- },
- "content": {
- "type": "string"
- },
- "diff": {
- "type": "string"
- },
- "patch": {
- "type": "object",
- "properties": {
- "oldFileName": {
- "type": "string"
- },
- "newFileName": {
- "type": "string"
- },
- "oldHeader": {
- "type": "string"
- },
- "newHeader": {
- "type": "string"
- },
- "hunks": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "oldStart": {
- "type": "number"
- },
- "oldLines": {
- "type": "number"
- },
- "newStart": {
- "type": "number"
- },
- "newLines": {
- "type": "number"
- },
- "lines": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": ["oldStart", "oldLines", "newStart", "newLines", "lines"]
- }
- },
- "index": {
- "type": "string"
- }
- },
- "required": ["oldFileName", "newFileName", "hunks"]
- },
- "encoding": {
- "type": "string",
- "const": "base64"
- },
- "mimeType": {
- "type": "string"
- }
- },
- "required": ["type", "content"]
- },
- "File": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string"
- },
- "added": {
- "type": "integer",
- "minimum": -9007199254740991,
- "maximum": 9007199254740991
- },
- "removed": {
- "type": "integer",
- "minimum": -9007199254740991,
- "maximum": 9007199254740991
- },
- "status": {
- "type": "string",
- "enum": ["added", "deleted", "modified"]
- }
- },
- "required": ["path", "added", "removed", "status"]
- },
- "MCPStatusConnected": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "const": "connected"
- }
- },
- "required": ["status"]
- },
- "MCPStatusDisabled": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "const": "disabled"
- }
- },
- "required": ["status"]
- },
- "MCPStatusFailed": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "const": "failed"
- },
- "error": {
- "type": "string"
- }
- },
- "required": ["status", "error"]
- },
- "MCPStatusNeedsAuth": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "const": "needs_auth"
- }
- },
- "required": ["status"]
- },
- "MCPStatusNeedsClientRegistration": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "const": "needs_client_registration"
- },
- "error": {
- "type": "string"
- }
- },
- "required": ["status", "error"]
- },
- "MCPStatus": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/MCPStatusConnected"
- },
- {
- "$ref": "#/components/schemas/MCPStatusDisabled"
- },
- {
- "$ref": "#/components/schemas/MCPStatusFailed"
- },
- {
- "$ref": "#/components/schemas/MCPStatusNeedsAuth"
- },
- {
- "$ref": "#/components/schemas/MCPStatusNeedsClientRegistration"
- }
- ]
- },
- "Path": {
- "type": "object",
- "properties": {
- "home": {
- "type": "string"
- },
- "state": {
- "type": "string"
- },
- "config": {
- "type": "string"
- },
- "worktree": {
- "type": "string"
- },
- "directory": {
- "type": "string"
- }
- },
- "required": ["home", "state", "config", "worktree", "directory"]
- },
- "VcsInfo": {
- "type": "object",
- "properties": {
- "branch": {
- "type": "string"
- }
- },
- "required": ["branch"]
- },
- "Command": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "agent": {
- "type": "string"
- },
- "model": {
- "type": "string"
- },
- "mcp": {
- "type": "boolean"
- },
- "template": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "string"
- }
- ]
- },
- "subtask": {
- "type": "boolean"
- },
- "hints": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": ["name", "template", "hints"]
- },
- "Agent": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "mode": {
- "type": "string",
- "enum": ["subagent", "primary", "all"]
- },
- "native": {
- "type": "boolean"
- },
- "hidden": {
- "type": "boolean"
- },
- "topP": {
- "type": "number"
- },
- "temperature": {
- "type": "number"
- },
- "color": {
- "type": "string"
- },
- "permission": {
- "$ref": "#/components/schemas/PermissionRuleset"
- },
- "model": {
- "type": "object",
- "properties": {
- "modelID": {
- "type": "string"
- },
- "providerID": {
- "type": "string"
- }
- },
- "required": ["modelID", "providerID"]
- },
- "prompt": {
- "type": "string"
- },
- "options": {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {}
- },
- "steps": {
- "type": "integer",
- "exclusiveMinimum": 0,
- "maximum": 9007199254740991
- }
- },
- "required": ["name", "mode", "permission", "options"]
- },
- "LSPStatus": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "root": {
- "type": "string"
- },
- "status": {
- "anyOf": [
- {
- "type": "string",
- "const": "connected"
- },
- {
- "type": "string",
- "const": "error"
- }
- ]
- }
- },
- "required": ["id", "name", "root", "status"]
- },
- "FormatterStatus": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "extensions": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "enabled": {
- "type": "boolean"
- }
- },
- "required": ["name", "extensions", "enabled"]
- },
- "OAuth": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "oauth"
- },
- "refresh": {
- "type": "string"
- },
- "access": {
- "type": "string"
- },
- "expires": {
- "type": "number"
- },
- "accountId": {
- "type": "string"
- },
- "enterpriseUrl": {
- "type": "string"
- }
- },
- "required": ["type", "refresh", "access", "expires"]
- },
- "ApiAuth": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "api"
- },
- "key": {
- "type": "string"
- }
- },
- "required": ["type", "key"]
- },
- "WellKnownAuth": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "const": "wellknown"
- },
- "key": {
- "type": "string"
- },
- "token": {
- "type": "string"
- }
- },
- "required": ["type", "key", "token"]
- },
- "Auth": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/OAuth"
- },
- {
- "$ref": "#/components/schemas/ApiAuth"
- },
- {
- "$ref": "#/components/schemas/WellKnownAuth"
- }
- ]
- }
- }
- }
- }
|