Something went wrong. Try again.
fork of hey-api/openapi-ts because I need some additional things
Something went wrong. Try again.
201 kB · 7452 lines
YAML
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453openapi: 3.1.1info: title: opencode description: opencode api version: 1.0.0paths: /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
const client = createOpencodeClient() await client.global.health({ ... }) /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
const client = createOpencodeClient() await client.global.event({ ... }) /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
const client = createOpencodeClient() await client.global.dispose({ ... }) /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
const client = createOpencodeClient() await client.project.list({ ... }) /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
const client = createOpencodeClient() await client.project.current({ ... }) /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 color: type: string x-codeSamples: - lang: js source: |- import { createOpencodeClient } from "@opencode-ai/sdk
const client = createOpencodeClient() await client.project.update({ ... }) /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
const client = createOpencodeClient() await client.pty.list({ ... }) 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
const client = createOpencodeClient() await client.pty.create({ ... }) /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
const client = createOpencodeClient() await client.pty.get({ ... }) 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
const client = createOpencodeClient() await client.pty.update({ ... }) 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
const client = createOpencodeClient() await client.pty.remove({ ... }) /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
const client = createOpencodeClient() await client.pty.connect({ ... }) /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
const client = createOpencodeClient() await client.config.get({ ... }) 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
const client = createOpencodeClient() await client.config.update({ ... }) /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
const client = createOpencodeClient() await client.tool.ids({ ... }) /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
const client = createOpencodeClient() await client.tool.list({ ... }) /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
const client = createOpencodeClient() await client.instance.dispose({ ... }) /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
const client = createOpencodeClient() await client.path.get({ ... }) /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
const client = createOpencodeClient() await client.vcs.get({ ... }) /session: get: operationId: session.list parameters: - in: query name: directory schema: type: string 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
const client = createOpencodeClient() await client.session.list({ ... }) 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
const client = createOpencodeClient() await client.session.create({ ... }) /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
const client = createOpencodeClient() await client.session.status({ ... }) /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
const client = createOpencodeClient() await client.session.get({ ... }) 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
const client = createOpencodeClient() await client.session.delete({ ... }) 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
const client = createOpencodeClient() await client.session.update({ ... }) /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
const client = createOpencodeClient() await client.session.children({ ... }) /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
const client = createOpencodeClient() await client.session.todo({ ... }) /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
const client = createOpencodeClient() await client.session.init({ ... }) /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
const client = createOpencodeClient() await client.session.fork({ ... }) /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
const client = createOpencodeClient() await client.session.abort({ ... }) /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
const client = createOpencodeClient() await client.session.share({ ... }) 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
const client = createOpencodeClient() await client.session.unshare({ ... }) /session/{sessionID}/diff: get: operationId: session.diff parameters: - in: query name: directory schema: type: string - in: path name: sessionID schema: type: string required: true description: Session ID - in: query name: messageID schema: type: string pattern: ^msg.* summary: Get session diff description: Get all file changes (diffs) made during this session. responses: '200': description: List of diffs content: application/json: schema: type: array items: $ref: '#/components/schemas/FileDiff' '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
const client = createOpencodeClient() await client.session.diff({ ... }) /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
const client = createOpencodeClient() await client.session.summarize({ ... }) /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
const client = createOpencodeClient() await client.session.messages({ ... }) 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
const client = createOpencodeClient() await client.session.prompt({ ... }) /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
const client = createOpencodeClient() await client.session.message({ ... }) /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
const client = createOpencodeClient() await client.part.delete({ ... }) 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
const client = createOpencodeClient() await client.part.update({ ... }) /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
const client = createOpencodeClient() await client.session.prompt_async({ ... }) /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 required: - arguments - command x-codeSamples: - lang: js source: |- import { createOpencodeClient } from "@opencode-ai/sdk
const client = createOpencodeClient() await client.session.command({ ... }) /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
const client = createOpencodeClient() await client.session.shell({ ... }) /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
const client = createOpencodeClient() await client.session.revert({ ... }) /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
const client = createOpencodeClient() await client.session.unrevert({ ... }) /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
const client = createOpencodeClient() await client.permission.respond({ ... }) /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 required: - reply x-codeSamples: - lang: js source: |- import { createOpencodeClient } from "@opencode-ai/sdk
const client = createOpencodeClient() await client.permission.reply({ ... }) /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
const client = createOpencodeClient() await client.permission.list({ ... }) /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
const client = createOpencodeClient() await client.command.list({ ... }) /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
const client = createOpencodeClient() await client.config.providers({ ... }) /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 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
const client = createOpencodeClient() await client.provider.list({ ... }) /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
const client = createOpencodeClient() await client.provider.auth({ ... }) /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
const client = createOpencodeClient() await client.provider.oauth.authorize({ ... }) /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
const client = createOpencodeClient() await client.provider.oauth.callback({ ... }) /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
const client = createOpencodeClient() await client.find.text({ ... }) /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
const client = createOpencodeClient() await client.find.files({ ... }) /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
const client = createOpencodeClient() await client.find.symbols({ ... }) /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
const client = createOpencodeClient() await client.file.list({ ... }) /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
const client = createOpencodeClient() await client.file.read({ ... }) /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
const client = createOpencodeClient() await client.file.status({ ... }) /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
const client = createOpencodeClient() await client.app.log({ ... }) /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
const client = createOpencodeClient() await client.app.agents({ ... }) /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
const client = createOpencodeClient() await client.mcp.status({ ... }) 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
const client = createOpencodeClient() await client.mcp.add({ ... }) /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
const client = createOpencodeClient() await client.mcp.auth.start({ ... }) 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
const client = createOpencodeClient() await client.mcp.auth.remove({ ... }) /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
const client = createOpencodeClient() await client.mcp.auth.callback({ ... }) /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
const client = createOpencodeClient() await client.mcp.auth.authenticate({ ... }) /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
const client = createOpencodeClient() await client.mcp.connect({ ... }) /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
const client = createOpencodeClient() await client.mcp.disconnect({ ... }) /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
const client = createOpencodeClient() await client.lsp.status({ ... }) /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
const client = createOpencodeClient() await client.formatter.status({ ... }) /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
const client = createOpencodeClient() await client.tui.appendPrompt({ ... }) /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
const client = createOpencodeClient() await client.tui.openHelp({ ... }) /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
const client = createOpencodeClient() await client.tui.openSessions({ ... }) /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
const client = createOpencodeClient() await client.tui.openThemes({ ... }) /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
const client = createOpencodeClient() await client.tui.openModels({ ... }) /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
const client = createOpencodeClient() await client.tui.submitPrompt({ ... }) /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
const client = createOpencodeClient() await client.tui.clearPrompt({ ... }) /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
const client = createOpencodeClient() await client.tui.executeCommand({ ... }) /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
const client = createOpencodeClient() await client.tui.showToast({ ... }) /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' x-codeSamples: - lang: js source: |- import { createOpencodeClient } from "@opencode-ai/sdk
const client = createOpencodeClient() await client.tui.publish({ ... }) /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
const client = createOpencodeClient() await client.tui.control.next({ ... }) /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
const client = createOpencodeClient() await client.tui.control.response({ ... }) /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
const client = createOpencodeClient() await client.auth.set({ ... }) /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
const client = createOpencodeClient() await client.event.subscribe({ ... })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 color: type: string time: type: object properties: created: type: number updated: type: number initialized: type: number required: - created - updated required: - id - worktree - time 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.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 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 FilePartSource: anyOf: - $ref: '#/components/schemas/FileSource' - $ref: '#/components/schemas/SymbolSource' 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 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 Event.session.compacted: type: object properties: type: type: string const: session.compacted properties: type: object properties: sessionID: type: string required: - sessionID 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 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.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.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.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.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.* 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 - 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.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.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.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: 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.lsp.client.diagnostics' - $ref: '#/components/schemas/Event.lsp.updated' - $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.session.compacted' - $ref: '#/components/schemas/Event.file.edited' - $ref: '#/components/schemas/Event.todo.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.mcp.tools.changed' - $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.file.watcher.updated' - $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' - $ref: '#/components/schemas/Event.server.connected' - $ref: '#/components/schemas/Event.global.disposed' 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: none 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 type: string messages_page_down: description: Scroll messages down by one page default: pagedown 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: 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' 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 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 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 fetching tools from the MCP server. 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 fetching tools from the MCP server. 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/agent 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: - $ref: '#/components/schemas/McpLocalConfig' - $ref: '#/components/schemas/McpRemoteConfig' 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 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' 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 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 command: type: string required: - type - prompt - description - agent 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 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 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 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 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 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' 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 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'