Compare commits

...
1 Commits
Author SHA1 Message Date
OpenRouter Team 13d706e274 Commits included in this export:
- 35d4e3137846cf3e0a5800e012692818f0dfe309
  - b2f10545419cea6b8a12c509f41ec4bd3937af0c
  - 2dbb7d9612a6e699caa91f334ad105dbde6442ee
  - 50539a3577b5a7e925b756f6bb87744052701215
  - 2cdbe64441ce4435ea0a1ff9127472e815fdaccf
  - f35bb49a8b788937fa61c0cf4591b14f2bc8b217
  - 08a37babde9ad8df5e24e0cd865d3292b1627464
  - 7ddc8e1ed230ca489bc11a5e14696c209ea76349
  - ad31290f38f3f02627f3e1953f1d7cf3e06159a5
  - fb7f764b500618e322f56d49997fbcfaebba7e39
  - 4306c032b9b4f3cfefeacdd3d243b0336f3b2f15

GitOrigin-RevId: 35d4e3137846cf3e0a5800e012692818f0dfe309
2026-03-17 02:59:58 +00:00
433 changed files with 18149 additions and 2124 deletions
+197 -17
View File
@@ -1,12 +1,12 @@
lockVersion: 2.0.0 lockVersion: 2.0.0
id: cfd52247-6a25-4c6d-bbce-fe6fce0cd69d id: cfd52247-6a25-4c6d-bbce-fe6fce0cd69d
management: management:
docChecksum: ba9a1c22e9c7d5926d71b1e78e16b482 docChecksum: fff8b3c28663df858db3a222b1f62d40
docVersion: 1.0.0 docVersion: 1.0.0
speakeasyVersion: 1.666.0 speakeasyVersion: 1.666.0
generationVersion: 2.768.0 generationVersion: 2.768.0
releaseVersion: 0.7.11 releaseVersion: 0.9.0
configChecksum: c2013e97e44ae07d6749ebe461b47299 configChecksum: e6f61aeb6e1587fb2f6f67ef3b5217c5
repoURL: https://github.com/OpenRouterTeam/python-sdk.git repoURL: https://github.com/OpenRouterTeam/python-sdk.git
installationURL: https://github.com/OpenRouterTeam/python-sdk.git installationURL: https://github.com/OpenRouterTeam/python-sdk.git
published: true published: true
@@ -50,21 +50,31 @@ generatedFiles:
- .gitattributes - .gitattributes
- .vscode/settings.json - .vscode/settings.json
- USAGE.md - USAGE.md
- docs/components/action.md
- docs/components/actionfindinpage.md
- docs/components/actionopenpage.md
- docs/components/actionsearch.md
- docs/components/activityitem.md - docs/components/activityitem.md
- docs/components/allowedtools.md
- docs/components/always.md
- docs/components/architecture.md - docs/components/architecture.md
- docs/components/assistantmessage.md - docs/components/assistantmessage.md
- docs/components/assistantmessagecontent.md - docs/components/assistantmessagecontent.md
- docs/components/assistantmessageimages.md - docs/components/assistantmessageimages.md
- docs/components/assistantmessageimagesimageurl.md - docs/components/assistantmessageimagesimageurl.md
- docs/components/assistantmessagerole.md - docs/components/assistantmessagerole.md
- docs/components/background.md
- docs/components/badgatewayresponseerrordata.md - docs/components/badgatewayresponseerrordata.md
- docs/components/badrequestresponseerrordata.md - docs/components/badrequestresponseerrordata.md
- docs/components/by.md - docs/components/by.md
- docs/components/cachecontrol.md
- docs/components/chainid.md - docs/components/chainid.md
- docs/components/chatcompletionaudiooutput.md
- docs/components/chatcompletionfinishreason.md - docs/components/chatcompletionfinishreason.md
- docs/components/chatgenerationparams.md - docs/components/chatgenerationparams.md
- docs/components/chatgenerationparamsby.md - docs/components/chatgenerationparamsby.md
- docs/components/chatgenerationparamsidautorouter.md - docs/components/chatgenerationparamsidautorouter.md
- docs/components/chatgenerationparamsidcontextcompression.md
- docs/components/chatgenerationparamsidfileparser.md - docs/components/chatgenerationparamsidfileparser.md
- docs/components/chatgenerationparamsidmoderation.md - docs/components/chatgenerationparamsidmoderation.md
- docs/components/chatgenerationparamsidresponsehealing.md - docs/components/chatgenerationparamsidresponsehealing.md
@@ -76,6 +86,7 @@ generatedFiles:
- docs/components/chatgenerationparamsorder.md - docs/components/chatgenerationparamsorder.md
- docs/components/chatgenerationparamspartition.md - docs/components/chatgenerationparamspartition.md
- docs/components/chatgenerationparamspluginautorouter.md - docs/components/chatgenerationparamspluginautorouter.md
- docs/components/chatgenerationparamsplugincontextcompression.md
- docs/components/chatgenerationparamspluginfileparser.md - docs/components/chatgenerationparamspluginfileparser.md
- docs/components/chatgenerationparamspluginmoderation.md - docs/components/chatgenerationparamspluginmoderation.md
- docs/components/chatgenerationparamspluginresponsehealing.md - docs/components/chatgenerationparamspluginresponsehealing.md
@@ -89,6 +100,8 @@ generatedFiles:
- docs/components/chatgenerationparamssortenum.md - docs/components/chatgenerationparamssortenum.md
- docs/components/chatgenerationparamssortunion.md - docs/components/chatgenerationparamssortunion.md
- docs/components/chatgenerationparamstrace.md - docs/components/chatgenerationparamstrace.md
- docs/components/chatgenerationparamsttl.md
- docs/components/chatgenerationparamstype.md
- docs/components/chatgenerationtokenusage.md - docs/components/chatgenerationtokenusage.md
- docs/components/chatmessagecontentitem.md - docs/components/chatmessagecontentitem.md
- docs/components/chatmessagecontentitem1.md - docs/components/chatmessagecontentitem1.md
@@ -96,7 +109,10 @@ generatedFiles:
- docs/components/chatmessagecontentitemaudioinputaudio.md - docs/components/chatmessagecontentitemaudioinputaudio.md
- docs/components/chatmessagecontentitemaudiotype.md - docs/components/chatmessagecontentitemaudiotype.md
- docs/components/chatmessagecontentitemcachecontrol.md - docs/components/chatmessagecontentitemcachecontrol.md
- docs/components/chatmessagecontentitemcachecontrolttl.md
- docs/components/chatmessagecontentitemcachecontroltype.md - docs/components/chatmessagecontentitemcachecontroltype.md
- docs/components/chatmessagecontentitemfile.md
- docs/components/chatmessagecontentitemfiletype.md
- docs/components/chatmessagecontentitemimage.md - docs/components/chatmessagecontentitemimage.md
- docs/components/chatmessagecontentitemimagedetail.md - docs/components/chatmessagecontentitemimagedetail.md
- docs/components/chatmessagecontentitemimageimageurl.md - docs/components/chatmessagecontentitemimageimageurl.md
@@ -127,10 +143,21 @@ generatedFiles:
- docs/components/chatstreamoptions.md - docs/components/chatstreamoptions.md
- docs/components/code.md - docs/components/code.md
- docs/components/completiontokensdetails.md - docs/components/completiontokensdetails.md
- docs/components/compoundfilter.md
- docs/components/compoundfiltertype.md
- docs/components/conflictresponseerrordata.md
- docs/components/connectorid.md
- docs/components/container.md
- docs/components/containerauto.md
- docs/components/containertype.md
- docs/components/contextcompressionengine.md
- docs/components/costdetails.md - docs/components/costdetails.md
- docs/components/createchargerequest.md - docs/components/createchargerequest.md
- docs/components/data.md - docs/components/data.md
- docs/components/datacollection.md - docs/components/datacollection.md
- docs/components/datetimeservertool.md
- docs/components/datetimeservertoolparameters.md
- docs/components/datetimeservertooltype.md
- docs/components/debugoptions.md - docs/components/debugoptions.md
- docs/components/defaultparameters.md - docs/components/defaultparameters.md
- docs/components/developermessage.md - docs/components/developermessage.md
@@ -139,31 +166,45 @@ generatedFiles:
- docs/components/edgenetworktimeoutresponseerrordata.md - docs/components/edgenetworktimeoutresponseerrordata.md
- docs/components/effort.md - docs/components/effort.md
- docs/components/endpointstatus.md - docs/components/endpointstatus.md
- docs/components/environment.md
- docs/components/error.md - docs/components/error.md
- docs/components/file.md
- docs/components/filecitation.md - docs/components/filecitation.md
- docs/components/filecitationtype.md - docs/components/filecitationtype.md
- docs/components/filepath.md - docs/components/filepath.md
- docs/components/filepathtype.md - docs/components/filepathtype.md
- docs/components/filters.md
- docs/components/filterstype.md
- docs/components/forbiddenresponseerrordata.md - docs/components/forbiddenresponseerrordata.md
- docs/components/format_.md
- docs/components/formatgrammar.md
- docs/components/formattext.md
- docs/components/formattypegrammar.md
- docs/components/formattypetext.md
- docs/components/imagegenerationstatus.md - docs/components/imagegenerationstatus.md
- docs/components/inputfidelity.md
- docs/components/inputimagemask.md
- docs/components/inputmodality.md - docs/components/inputmodality.md
- docs/components/inputtokensdetails.md - docs/components/inputtokensdetails.md
- docs/components/instructtype.md - docs/components/instructtype.md
- docs/components/internalserverresponseerrordata.md - docs/components/internalserverresponseerrordata.md
- docs/components/jsonschemaconfig.md - docs/components/jsonschemaconfig.md
- docs/components/listendpointsresponse.md - docs/components/listendpointsresponse.md
- docs/components/logprob.md - docs/components/memorylimit.md
- docs/components/message.md - docs/components/message.md
- docs/components/modality.md - docs/components/modality.md
- docs/components/model.md - docs/components/model.md
- docs/components/modelarchitecture.md - docs/components/modelarchitecture.md
- docs/components/modelarchitectureinstructtype.md - docs/components/modelarchitectureinstructtype.md
- docs/components/modelenum.md
- docs/components/modelgroup.md - docs/components/modelgroup.md
- docs/components/modelscountresponse.md - docs/components/modelscountresponse.md
- docs/components/modelslistresponse.md - docs/components/modelslistresponse.md
- docs/components/moderation.md
- docs/components/namedtoolchoice.md - docs/components/namedtoolchoice.md
- docs/components/namedtoolchoicefunction.md - docs/components/namedtoolchoicefunction.md
- docs/components/namedtoolchoicetype.md - docs/components/namedtoolchoicetype.md
- docs/components/never.md
- docs/components/notfoundresponseerrordata.md - docs/components/notfoundresponseerrordata.md
- docs/components/openairesponsesannotation.md - docs/components/openairesponsesannotation.md
- docs/components/openairesponsesincludable.md - docs/components/openairesponsesincludable.md
@@ -175,6 +216,11 @@ generatedFiles:
- docs/components/openairesponsesinputfunctioncalloutput.md - docs/components/openairesponsesinputfunctioncalloutput.md
- docs/components/openairesponsesinputmessage1.md - docs/components/openairesponsesinputmessage1.md
- docs/components/openairesponsesinputmessage2.md - docs/components/openairesponsesinputmessage2.md
- docs/components/openairesponsesinputoutput1.md
- docs/components/openairesponsesinputoutput2.md
- docs/components/openairesponsesinputphasecommentary.md
- docs/components/openairesponsesinputphasefinalanswer.md
- docs/components/openairesponsesinputphaseunion.md
- docs/components/openairesponsesinputroleassistant.md - docs/components/openairesponsesinputroleassistant.md
- docs/components/openairesponsesinputroledeveloper1.md - docs/components/openairesponsesinputroledeveloper1.md
- docs/components/openairesponsesinputroledeveloper2.md - docs/components/openairesponsesinputroledeveloper2.md
@@ -207,12 +253,21 @@ generatedFiles:
- docs/components/openairesponsestoolchoicetypewebsearchpreview20250311.md - docs/components/openairesponsestoolchoicetypewebsearchpreview20250311.md
- docs/components/openairesponsestoolchoiceunion.md - docs/components/openairesponsestoolchoiceunion.md
- docs/components/openairesponsestruncation.md - docs/components/openairesponsestruncation.md
- docs/components/openresponsesapplypatchtool.md
- docs/components/openresponsesapplypatchtooltype.md
- docs/components/openresponsescodeinterpretertool.md
- docs/components/openresponsescomputertool.md
- docs/components/openresponsescomputertooltype.md
- docs/components/openresponsescustomtool.md
- docs/components/openresponseseasyinputmessage.md - docs/components/openresponseseasyinputmessage.md
- docs/components/openresponseseasyinputmessagecontentinputimage.md - docs/components/openresponseseasyinputmessagecontentinputimage.md
- docs/components/openresponseseasyinputmessagecontenttype.md - docs/components/openresponseseasyinputmessagecontenttype.md
- docs/components/openresponseseasyinputmessagecontentunion1.md - docs/components/openresponseseasyinputmessagecontentunion1.md
- docs/components/openresponseseasyinputmessagecontentunion2.md - docs/components/openresponseseasyinputmessagecontentunion2.md
- docs/components/openresponseseasyinputmessagedetail.md - docs/components/openresponseseasyinputmessagedetail.md
- docs/components/openresponseseasyinputmessagephasecommentary.md
- docs/components/openresponseseasyinputmessagephasefinalanswer.md
- docs/components/openresponseseasyinputmessagephaseunion.md
- docs/components/openresponseseasyinputmessageroleassistant.md - docs/components/openresponseseasyinputmessageroleassistant.md
- docs/components/openresponseseasyinputmessageroledeveloper.md - docs/components/openresponseseasyinputmessageroledeveloper.md
- docs/components/openresponseseasyinputmessagerolesystem.md - docs/components/openresponseseasyinputmessagerolesystem.md
@@ -221,8 +276,15 @@ generatedFiles:
- docs/components/openresponseseasyinputmessagetypemessage.md - docs/components/openresponseseasyinputmessagetypemessage.md
- docs/components/openresponseserrorevent.md - docs/components/openresponseserrorevent.md
- docs/components/openresponseserroreventtype.md - docs/components/openresponseserroreventtype.md
- docs/components/openresponsesfilesearchtool.md
- docs/components/openresponsesfilesearchtoolfilters.md
- docs/components/openresponsesfunctioncalloutput.md - docs/components/openresponsesfunctioncalloutput.md
- docs/components/openresponsesfunctioncalloutputtype.md - docs/components/openresponsesfunctioncalloutputdetail.md
- docs/components/openresponsesfunctioncalloutputoutputunion1.md
- docs/components/openresponsesfunctioncalloutputoutputunion2.md
- docs/components/openresponsesfunctioncalloutputtypefunctioncalloutput.md
- docs/components/openresponsesfunctionshelltool.md
- docs/components/openresponsesfunctionshelltooltype.md
- docs/components/openresponsesfunctiontoolcall.md - docs/components/openresponsesfunctiontoolcall.md
- docs/components/openresponsesfunctiontoolcalltype.md - docs/components/openresponsesfunctiontoolcalltype.md
- docs/components/openresponsesimagegencallcompleted.md - docs/components/openresponsesimagegencallcompleted.md
@@ -233,8 +295,12 @@ generatedFiles:
- docs/components/openresponsesimagegencallinprogresstype.md - docs/components/openresponsesimagegencallinprogresstype.md
- docs/components/openresponsesimagegencallpartialimage.md - docs/components/openresponsesimagegencallpartialimage.md
- docs/components/openresponsesimagegencallpartialimagetype.md - docs/components/openresponsesimagegencallpartialimagetype.md
- docs/components/openresponsesinput.md - docs/components/openresponsesimagegenerationtool.md
- docs/components/openresponsesinput1.md - docs/components/openresponsesimagegenerationtooltype.md
- docs/components/openresponsesinputcontent1.md
- docs/components/openresponsesinputcontent2.md
- docs/components/openresponsesinputformat.md
- docs/components/openresponsesinputmessage.md
- docs/components/openresponsesinputmessageitem.md - docs/components/openresponsesinputmessageitem.md
- docs/components/openresponsesinputmessageitemcontentinputimage.md - docs/components/openresponsesinputmessageitemcontentinputimage.md
- docs/components/openresponsesinputmessageitemcontenttype.md - docs/components/openresponsesinputmessageitemcontenttype.md
@@ -245,7 +311,27 @@ generatedFiles:
- docs/components/openresponsesinputmessageitemroleunion.md - docs/components/openresponsesinputmessageitemroleunion.md
- docs/components/openresponsesinputmessageitemroleuser.md - docs/components/openresponsesinputmessageitemroleuser.md
- docs/components/openresponsesinputmessageitemtypemessage.md - docs/components/openresponsesinputmessageitemtypemessage.md
- docs/components/openresponseslogprobs.md - docs/components/openresponsesinputphasecommentary.md
- docs/components/openresponsesinputphasefinalanswer.md
- docs/components/openresponsesinputphaseunion.md
- docs/components/openresponsesinputreasoning.md
- docs/components/openresponsesinputrole.md
- docs/components/openresponsesinputstatuscompleted1.md
- docs/components/openresponsesinputstatuscompleted2.md
- docs/components/openresponsesinputstatusincomplete1.md
- docs/components/openresponsesinputstatusincomplete2.md
- docs/components/openresponsesinputstatusinprogress1.md
- docs/components/openresponsesinputstatusinprogress2.md
- docs/components/openresponsesinputstatusunion1.md
- docs/components/openresponsesinputstatusunion2.md
- docs/components/openresponsesinputtypemessage.md
- docs/components/openresponsesinputtypereasoning.md
- docs/components/openresponsesinputunion.md
- docs/components/openresponsesinputunion1.md
- docs/components/openresponseslocalshelltool.md
- docs/components/openresponseslocalshelltooltype.md
- docs/components/openresponsesmcptool.md
- docs/components/openresponsesmcptooltype.md
- docs/components/openresponsesnonstreamingresponse.md - docs/components/openresponsesnonstreamingresponse.md
- docs/components/openresponsesnonstreamingresponseobject.md - docs/components/openresponsesnonstreamingresponseobject.md
- docs/components/openresponsesnonstreamingresponsetoolfunction.md - docs/components/openresponsesnonstreamingresponsetoolfunction.md
@@ -271,6 +357,7 @@ generatedFiles:
- docs/components/openresponsesreasoningtype.md - docs/components/openresponsesreasoningtype.md
- docs/components/openresponsesrequest.md - docs/components/openresponsesrequest.md
- docs/components/openresponsesrequestidautorouter.md - docs/components/openresponsesrequestidautorouter.md
- docs/components/openresponsesrequestidcontextcompression.md
- docs/components/openresponsesrequestidfileparser.md - docs/components/openresponsesrequestidfileparser.md
- docs/components/openresponsesrequestidmoderation.md - docs/components/openresponsesrequestidmoderation.md
- docs/components/openresponsesrequestidresponsehealing.md - docs/components/openresponsesrequestidresponsehealing.md
@@ -281,6 +368,7 @@ generatedFiles:
- docs/components/openresponsesrequestonly.md - docs/components/openresponsesrequestonly.md
- docs/components/openresponsesrequestorder.md - docs/components/openresponsesrequestorder.md
- docs/components/openresponsesrequestpluginautorouter.md - docs/components/openresponsesrequestpluginautorouter.md
- docs/components/openresponsesrequestplugincontextcompression.md
- docs/components/openresponsesrequestpluginfileparser.md - docs/components/openresponsesrequestpluginfileparser.md
- docs/components/openresponsesrequestpluginmoderation.md - docs/components/openresponsesrequestpluginmoderation.md
- docs/components/openresponsesrequestpluginresponsehealing.md - docs/components/openresponsesrequestpluginresponsehealing.md
@@ -295,6 +383,8 @@ generatedFiles:
- docs/components/openresponsesresponsetext.md - docs/components/openresponsesresponsetext.md
- docs/components/openresponsesresponsetextverbosity.md - docs/components/openresponsesresponsetextverbosity.md
- docs/components/openresponsesstreamevent.md - docs/components/openresponsesstreamevent.md
- docs/components/openresponsesstreameventlogprob1.md
- docs/components/openresponsesstreameventlogprob2.md
- docs/components/openresponsesstreameventresponsecompleted.md - docs/components/openresponsesstreameventresponsecompleted.md
- docs/components/openresponsesstreameventresponsecontentpartadded.md - docs/components/openresponsesstreameventresponsecontentpartadded.md
- docs/components/openresponsesstreameventresponsecontentpartdone.md - docs/components/openresponsesstreameventresponsecontentpartdone.md
@@ -312,22 +402,40 @@ generatedFiles:
- docs/components/openresponsesstreameventresponsereasoningsummarypartdone.md - docs/components/openresponsesstreameventresponsereasoningsummarypartdone.md
- docs/components/openresponsesstreameventresponserefusaldelta.md - docs/components/openresponsesstreameventresponserefusaldelta.md
- docs/components/openresponsesstreameventresponserefusaldone.md - docs/components/openresponsesstreameventresponserefusaldone.md
- docs/components/openresponsestoplogprobs.md - docs/components/openresponsesstreameventtoplogprob1.md
- docs/components/openresponsesstreameventtoplogprob2.md
- docs/components/openresponsesusage.md - docs/components/openresponsesusage.md
- docs/components/openresponseswebsearch20250826tool.md - docs/components/openresponseswebsearch20250826tool.md
- docs/components/openresponseswebsearch20250826toolengine.md
- docs/components/openresponseswebsearch20250826toolfilters.md - docs/components/openresponseswebsearch20250826toolfilters.md
- docs/components/openresponseswebsearch20250826tooltype.md - docs/components/openresponseswebsearch20250826tooltype.md
- docs/components/openresponseswebsearchcallcompleted.md
- docs/components/openresponseswebsearchcallcompletedtype.md
- docs/components/openresponseswebsearchcallinprogress.md
- docs/components/openresponseswebsearchcallinprogresstype.md
- docs/components/openresponseswebsearchcallsearching.md
- docs/components/openresponseswebsearchcallsearchingtype.md
- docs/components/openresponseswebsearchpreview20250311tool.md - docs/components/openresponseswebsearchpreview20250311tool.md
- docs/components/openresponseswebsearchpreview20250311toolengine.md
- docs/components/openresponseswebsearchpreview20250311toolfilters.md
- docs/components/openresponseswebsearchpreview20250311tooltype.md - docs/components/openresponseswebsearchpreview20250311tooltype.md
- docs/components/openresponseswebsearchpreviewtool.md - docs/components/openresponseswebsearchpreviewtool.md
- docs/components/openresponseswebsearchpreviewtoolengine.md
- docs/components/openresponseswebsearchpreviewtoolfilters.md
- docs/components/openresponseswebsearchpreviewtooltype.md - docs/components/openresponseswebsearchpreviewtooltype.md
- docs/components/openresponseswebsearchtool.md - docs/components/openresponseswebsearchtool.md
- docs/components/openresponseswebsearchtoolengine.md
- docs/components/openresponseswebsearchtoolfilters.md - docs/components/openresponseswebsearchtoolfilters.md
- docs/components/openresponseswebsearchtooltype.md - docs/components/openresponseswebsearchtooltype.md
- docs/components/outputformat.md
- docs/components/outputinputimage.md
- docs/components/outputitemimagegenerationcall.md - docs/components/outputitemimagegenerationcall.md
- docs/components/outputitemimagegenerationcalltype.md - docs/components/outputitemimagegenerationcalltype.md
- docs/components/outputmessage.md - docs/components/outputmessage.md
- docs/components/outputmessagecontent.md - docs/components/outputmessagecontent.md
- docs/components/outputmessagephasecommentary.md
- docs/components/outputmessagephasefinalanswer.md
- docs/components/outputmessagephaseunion.md
- docs/components/outputmessagerole.md - docs/components/outputmessagerole.md
- docs/components/outputmessagestatuscompleted.md - docs/components/outputmessagestatuscompleted.md
- docs/components/outputmessagestatusincomplete.md - docs/components/outputmessagestatusincomplete.md
@@ -336,6 +444,7 @@ generatedFiles:
- docs/components/outputmessagetype.md - docs/components/outputmessagetype.md
- docs/components/outputmodality.md - docs/components/outputmodality.md
- docs/components/outputtokensdetails.md - docs/components/outputtokensdetails.md
- docs/components/outputtype.md
- docs/components/parameter.md - docs/components/parameter.md
- docs/components/part1.md - docs/components/part1.md
- docs/components/part2.md - docs/components/part2.md
@@ -372,7 +481,10 @@ generatedFiles:
- docs/components/publicendpoint.md - docs/components/publicendpoint.md
- docs/components/publicendpointquantization.md - docs/components/publicendpointquantization.md
- docs/components/publicpricing.md - docs/components/publicpricing.md
- docs/components/quality.md
- docs/components/quantization.md - docs/components/quantization.md
- docs/components/ranker.md
- docs/components/rankingoptions.md
- docs/components/reason.md - docs/components/reason.md
- docs/components/reasoning.md - docs/components/reasoning.md
- docs/components/reasoningdetailencrypted.md - docs/components/reasoningdetailencrypted.md
@@ -391,6 +503,9 @@ generatedFiles:
- docs/components/reasoningtextcontent.md - docs/components/reasoningtextcontent.md
- docs/components/reasoningtextcontenttype.md - docs/components/reasoningtextcontenttype.md
- docs/components/requesttimeoutresponseerrordata.md - docs/components/requesttimeoutresponseerrordata.md
- docs/components/requireapproval.md
- docs/components/requireapprovalalways.md
- docs/components/requireapprovalnever.md
- docs/components/responseformat.md - docs/components/responseformat.md
- docs/components/responseformatjsonobject.md - docs/components/responseformatjsonobject.md
- docs/components/responseformatjsonobjecttype.md - docs/components/responseformatjsonobjecttype.md
@@ -417,6 +532,7 @@ generatedFiles:
- docs/components/responseinputvideo.md - docs/components/responseinputvideo.md
- docs/components/responseinputvideotype.md - docs/components/responseinputvideotype.md
- docs/components/responseoutputtext.md - docs/components/responseoutputtext.md
- docs/components/responseoutputtextlogprob.md
- docs/components/responseoutputtexttoplogprob.md - docs/components/responseoutputtexttoplogprob.md
- docs/components/responseoutputtexttype.md - docs/components/responseoutputtexttype.md
- docs/components/responseserrorfield.md - docs/components/responseserrorfield.md
@@ -444,6 +560,9 @@ generatedFiles:
- docs/components/responsesoutputitemreasoningtype.md - docs/components/responsesoutputitemreasoningtype.md
- docs/components/responsesoutputmessage.md - docs/components/responsesoutputmessage.md
- docs/components/responsesoutputmessagecontent.md - docs/components/responsesoutputmessagecontent.md
- docs/components/responsesoutputmessagephasecommentary.md
- docs/components/responsesoutputmessagephasefinalanswer.md
- docs/components/responsesoutputmessagephaseunion.md
- docs/components/responsesoutputmessagerole.md - docs/components/responsesoutputmessagerole.md
- docs/components/responsesoutputmessagestatuscompleted.md - docs/components/responsesoutputmessagestatuscompleted.md
- docs/components/responsesoutputmessagestatusincomplete.md - docs/components/responsesoutputmessagestatusincomplete.md
@@ -452,8 +571,12 @@ generatedFiles:
- docs/components/responsesoutputmessagetype.md - docs/components/responsesoutputmessagetype.md
- docs/components/responsesoutputmodality.md - docs/components/responsesoutputmodality.md
- docs/components/responsessearchcontextsize.md - docs/components/responsessearchcontextsize.md
- docs/components/responsesservertooloutput.md
- docs/components/responsesservertooloutputstatus.md
- docs/components/responseswebsearchcalloutput.md - docs/components/responseswebsearchcalloutput.md
- docs/components/responseswebsearchcalloutputtype.md - docs/components/responseswebsearchservertool.md
- docs/components/responseswebsearchservertoolparameters.md
- docs/components/responseswebsearchservertooltype.md
- docs/components/responseswebsearchuserlocation.md - docs/components/responseswebsearchuserlocation.md
- docs/components/responseswebsearchuserlocationtype.md - docs/components/responseswebsearchuserlocationtype.md
- docs/components/responsetextconfig.md - docs/components/responsetextconfig.md
@@ -461,7 +584,10 @@ generatedFiles:
- docs/components/security.md - docs/components/security.md
- docs/components/servicetier.md - docs/components/servicetier.md
- docs/components/serviceunavailableresponseerrordata.md - docs/components/serviceunavailableresponseerrordata.md
- docs/components/size.md
- docs/components/source.md
- docs/components/stop.md - docs/components/stop.md
- docs/components/syntax.md
- docs/components/systemmessage.md - docs/components/systemmessage.md
- docs/components/systemmessagecontent.md - docs/components/systemmessagecontent.md
- docs/components/systemmessagerole.md - docs/components/systemmessagerole.md
@@ -473,6 +599,7 @@ generatedFiles:
- docs/components/toolchoiceoptionrequired.md - docs/components/toolchoiceoptionrequired.md
- docs/components/tooldefinitionjson.md - docs/components/tooldefinitionjson.md
- docs/components/tooldefinitionjsonfunction.md - docs/components/tooldefinitionjsonfunction.md
- docs/components/tooldefinitionjsonfunctionfunction.md
- docs/components/tooldefinitionjsontype.md - docs/components/tooldefinitionjsontype.md
- docs/components/toolresponsemessage.md - docs/components/toolresponsemessage.md
- docs/components/toolresponsemessagecontent.md - docs/components/toolresponsemessagecontent.md
@@ -480,8 +607,12 @@ generatedFiles:
- docs/components/toomanyrequestsresponseerrordata.md - docs/components/toomanyrequestsresponseerrordata.md
- docs/components/topproviderinfo.md - docs/components/topproviderinfo.md
- docs/components/truncation.md - docs/components/truncation.md
- docs/components/ttl.md
- docs/components/type.md - docs/components/type.md
- docs/components/typecodeinterpreter.md
- docs/components/typecustom.md
- docs/components/typefilesearch.md
- docs/components/typefindinpage.md
- docs/components/typeopenpage.md
- docs/components/typeresponsecompleted.md - docs/components/typeresponsecompleted.md
- docs/components/typeresponsecontentpartadded.md - docs/components/typeresponsecontentpartadded.md
- docs/components/typeresponsecontentpartdone.md - docs/components/typeresponsecontentpartdone.md
@@ -499,6 +630,9 @@ generatedFiles:
- docs/components/typeresponsereasoningsummarypartdone.md - docs/components/typeresponsereasoningsummarypartdone.md
- docs/components/typeresponserefusaldelta.md - docs/components/typeresponserefusaldelta.md
- docs/components/typeresponserefusaldone.md - docs/components/typeresponserefusaldone.md
- docs/components/typesearch.md
- docs/components/typeurl.md
- docs/components/typewebsearchcall.md
- docs/components/unauthorizedresponseerrordata.md - docs/components/unauthorizedresponseerrordata.md
- docs/components/unprocessableentityresponseerrordata.md - docs/components/unprocessableentityresponseerrordata.md
- docs/components/urlcitation.md - docs/components/urlcitation.md
@@ -506,14 +640,35 @@ generatedFiles:
- docs/components/usermessage.md - docs/components/usermessage.md
- docs/components/usermessagecontent.md - docs/components/usermessagecontent.md
- docs/components/usermessagerole.md - docs/components/usermessagerole.md
- docs/components/value1.md
- docs/components/value2.md
- docs/components/variables.md - docs/components/variables.md
- docs/components/videoinput.md - docs/components/videoinput.md
- docs/components/websearchengine.md - docs/components/websearchengine.md
- docs/components/websearchpreviewtooluserlocation.md - docs/components/websearchpreviewtooluserlocation.md
- docs/components/websearchpreviewtooluserlocationtype.md - docs/components/websearchpreviewtooluserlocationtype.md
- docs/components/websearchservertool.md
- docs/components/websearchservertoolengine.md
- docs/components/websearchservertoolparameters.md
- docs/components/websearchservertoolparameterstype.md
- docs/components/websearchservertoolsearchcontextsize.md
- docs/components/websearchservertooltypeopenrouterwebsearch.md
- docs/components/websearchservertooluserlocation.md
- docs/components/websearchshorthand.md
- docs/components/websearchshorthandengine.md
- docs/components/websearchshorthandparameters.md
- docs/components/websearchshorthandparametersengine.md
- docs/components/websearchshorthandparameterssearchcontextsize.md
- docs/components/websearchshorthandparameterstype.md
- docs/components/websearchshorthandparametersuserlocation.md
- docs/components/websearchshorthandsearchcontextsize.md
- docs/components/websearchshorthandtype.md
- docs/components/websearchshorthandtypeapproximate.md
- docs/components/websearchshorthanduserlocation.md
- docs/components/websearchstatus.md - docs/components/websearchstatus.md
- docs/errors/badgatewayresponseerror.md - docs/errors/badgatewayresponseerror.md
- docs/errors/badrequestresponseerror.md - docs/errors/badrequestresponseerror.md
- docs/errors/conflictresponseerror.md
- docs/errors/edgenetworktimeoutresponseerror.md - docs/errors/edgenetworktimeoutresponseerror.md
- docs/errors/forbiddenresponseerror.md - docs/errors/forbiddenresponseerror.md
- docs/errors/internalserverresponseerror.md - docs/errors/internalserverresponseerror.md
@@ -729,12 +884,14 @@ generatedFiles:
- src/openrouter/components/assistantmessageimages.py - src/openrouter/components/assistantmessageimages.py
- src/openrouter/components/badgatewayresponseerrordata.py - src/openrouter/components/badgatewayresponseerrordata.py
- src/openrouter/components/badrequestresponseerrordata.py - src/openrouter/components/badrequestresponseerrordata.py
- src/openrouter/components/chatcompletionaudiooutput.py
- src/openrouter/components/chatcompletionfinishreason.py - src/openrouter/components/chatcompletionfinishreason.py
- src/openrouter/components/chatgenerationparams.py - src/openrouter/components/chatgenerationparams.py
- src/openrouter/components/chatgenerationtokenusage.py - src/openrouter/components/chatgenerationtokenusage.py
- src/openrouter/components/chatmessagecontentitem.py - src/openrouter/components/chatmessagecontentitem.py
- src/openrouter/components/chatmessagecontentitemaudio.py - src/openrouter/components/chatmessagecontentitemaudio.py
- src/openrouter/components/chatmessagecontentitemcachecontrol.py - src/openrouter/components/chatmessagecontentitemcachecontrol.py
- src/openrouter/components/chatmessagecontentitemfile.py
- src/openrouter/components/chatmessagecontentitemimage.py - src/openrouter/components/chatmessagecontentitemimage.py
- src/openrouter/components/chatmessagecontentitemtext.py - src/openrouter/components/chatmessagecontentitemtext.py
- src/openrouter/components/chatmessagecontentitemvideo.py - src/openrouter/components/chatmessagecontentitemvideo.py
@@ -749,8 +906,12 @@ generatedFiles:
- src/openrouter/components/chatstreamingmessagetoolcall.py - src/openrouter/components/chatstreamingmessagetoolcall.py
- src/openrouter/components/chatstreamingresponsechunk.py - src/openrouter/components/chatstreamingresponsechunk.py
- src/openrouter/components/chatstreamoptions.py - src/openrouter/components/chatstreamoptions.py
- src/openrouter/components/compoundfilter.py
- src/openrouter/components/conflictresponseerrordata.py
- src/openrouter/components/contextcompressionengine.py
- src/openrouter/components/createchargerequest.py - src/openrouter/components/createchargerequest.py
- src/openrouter/components/datacollection.py - src/openrouter/components/datacollection.py
- src/openrouter/components/datetimeservertool.py
- src/openrouter/components/debugoptions.py - src/openrouter/components/debugoptions.py
- src/openrouter/components/defaultparameters.py - src/openrouter/components/defaultparameters.py
- src/openrouter/components/developermessage.py - src/openrouter/components/developermessage.py
@@ -785,17 +946,25 @@ generatedFiles:
- src/openrouter/components/openairesponsesservicetier.py - src/openrouter/components/openairesponsesservicetier.py
- src/openrouter/components/openairesponsestoolchoice_union.py - src/openrouter/components/openairesponsestoolchoice_union.py
- src/openrouter/components/openairesponsestruncation.py - src/openrouter/components/openairesponsestruncation.py
- src/openrouter/components/openresponsesapplypatchtool.py
- src/openrouter/components/openresponsescodeinterpretertool.py
- src/openrouter/components/openresponsescomputertool.py
- src/openrouter/components/openresponsescustomtool.py
- src/openrouter/components/openresponseseasyinputmessage.py - src/openrouter/components/openresponseseasyinputmessage.py
- src/openrouter/components/openresponseserrorevent.py - src/openrouter/components/openresponseserrorevent.py
- src/openrouter/components/openresponsesfilesearchtool.py
- src/openrouter/components/openresponsesfunctioncalloutput.py - src/openrouter/components/openresponsesfunctioncalloutput.py
- src/openrouter/components/openresponsesfunctionshelltool.py
- src/openrouter/components/openresponsesfunctiontoolcall.py - src/openrouter/components/openresponsesfunctiontoolcall.py
- src/openrouter/components/openresponsesimagegencallcompleted.py - src/openrouter/components/openresponsesimagegencallcompleted.py
- src/openrouter/components/openresponsesimagegencallgenerating.py - src/openrouter/components/openresponsesimagegencallgenerating.py
- src/openrouter/components/openresponsesimagegencallinprogress.py - src/openrouter/components/openresponsesimagegencallinprogress.py
- src/openrouter/components/openresponsesimagegencallpartialimage.py - src/openrouter/components/openresponsesimagegencallpartialimage.py
- src/openrouter/components/openresponsesinput.py - src/openrouter/components/openresponsesimagegenerationtool.py
- src/openrouter/components/openresponsesinput_union.py
- src/openrouter/components/openresponsesinputmessageitem.py - src/openrouter/components/openresponsesinputmessageitem.py
- src/openrouter/components/openresponseslogprobs.py - src/openrouter/components/openresponseslocalshelltool.py
- src/openrouter/components/openresponsesmcptool.py
- src/openrouter/components/openresponsesnonstreamingresponse.py - src/openrouter/components/openresponsesnonstreamingresponse.py
- src/openrouter/components/openresponsesreasoning.py - src/openrouter/components/openresponsesreasoning.py
- src/openrouter/components/openresponsesreasoningconfig.py - src/openrouter/components/openresponsesreasoningconfig.py
@@ -807,9 +976,11 @@ generatedFiles:
- src/openrouter/components/openresponsesrequest.py - src/openrouter/components/openresponsesrequest.py
- src/openrouter/components/openresponsesresponsetext.py - src/openrouter/components/openresponsesresponsetext.py
- src/openrouter/components/openresponsesstreamevent.py - src/openrouter/components/openresponsesstreamevent.py
- src/openrouter/components/openresponsestoplogprobs.py
- src/openrouter/components/openresponsesusage.py - src/openrouter/components/openresponsesusage.py
- src/openrouter/components/openresponseswebsearch20250826tool.py - src/openrouter/components/openresponseswebsearch20250826tool.py
- src/openrouter/components/openresponseswebsearchcallcompleted.py
- src/openrouter/components/openresponseswebsearchcallinprogress.py
- src/openrouter/components/openresponseswebsearchcallsearching.py
- src/openrouter/components/openresponseswebsearchpreview20250311tool.py - src/openrouter/components/openresponseswebsearchpreview20250311tool.py
- src/openrouter/components/openresponseswebsearchpreviewtool.py - src/openrouter/components/openresponseswebsearchpreviewtool.py
- src/openrouter/components/openresponseswebsearchtool.py - src/openrouter/components/openresponseswebsearchtool.py
@@ -866,7 +1037,9 @@ generatedFiles:
- src/openrouter/components/responsesoutputmessage.py - src/openrouter/components/responsesoutputmessage.py
- src/openrouter/components/responsesoutputmodality.py - src/openrouter/components/responsesoutputmodality.py
- src/openrouter/components/responsessearchcontextsize.py - src/openrouter/components/responsessearchcontextsize.py
- src/openrouter/components/responsesservertooloutput.py
- src/openrouter/components/responseswebsearchcalloutput.py - src/openrouter/components/responseswebsearchcalloutput.py
- src/openrouter/components/responseswebsearchservertool.py
- src/openrouter/components/responseswebsearchuserlocation.py - src/openrouter/components/responseswebsearchuserlocation.py
- src/openrouter/components/responsetextconfig.py - src/openrouter/components/responsetextconfig.py
- src/openrouter/components/security.py - src/openrouter/components/security.py
@@ -885,6 +1058,8 @@ generatedFiles:
- src/openrouter/components/videoinput.py - src/openrouter/components/videoinput.py
- src/openrouter/components/websearchengine.py - src/openrouter/components/websearchengine.py
- src/openrouter/components/websearchpreviewtooluserlocation.py - src/openrouter/components/websearchpreviewtooluserlocation.py
- src/openrouter/components/websearchservertool.py
- src/openrouter/components/websearchshorthand.py
- src/openrouter/components/websearchstatus.py - src/openrouter/components/websearchstatus.py
- src/openrouter/credits.py - src/openrouter/credits.py
- src/openrouter/embeddings.py - src/openrouter/embeddings.py
@@ -892,6 +1067,7 @@ generatedFiles:
- src/openrouter/errors/__init__.py - src/openrouter/errors/__init__.py
- src/openrouter/errors/badgatewayresponse_error.py - src/openrouter/errors/badgatewayresponse_error.py
- src/openrouter/errors/badrequestresponse_error.py - src/openrouter/errors/badrequestresponse_error.py
- src/openrouter/errors/conflictresponse_error.py
- src/openrouter/errors/edgenetworktimeoutresponse_error.py - src/openrouter/errors/edgenetworktimeoutresponse_error.py
- src/openrouter/errors/forbiddenresponse_error.py - src/openrouter/errors/forbiddenresponse_error.py
- src/openrouter/errors/internalserverresponse_error.py - src/openrouter/errors/internalserverresponse_error.py
@@ -983,7 +1159,7 @@ examples:
application/json: {"store": false, "service_tier": "auto", "stream": false} application/json: {"store": false, "service_tier": "auto", "stream": false}
responses: responses:
"200": "200":
application/json: {"id": "resp-abc123", "object": "response", "created_at": 1704067200, "model": "gpt-4", "status": "completed", "completed_at": 2510.63, "output": [{"id": "msg-abc123", "role": "assistant", "type": "message", "content": [{"type": "output_text", "text": "Hello! How can I help you today?"}]}], "error": null, "incomplete_details": null, "temperature": null, "top_p": null, "presence_penalty": 7468.94, "frequency_penalty": 3967.09, "instructions": null, "metadata": null, "tools": [], "tool_choice": "auto", "parallel_tool_calls": true} application/json: {"id": "resp-abc123", "object": "response", "created_at": 1704067200, "model": "gpt-4", "status": "completed", "completed_at": 2510.63, "output": [{"type": "message", "status": "completed"}], "error": null, "incomplete_details": null, "temperature": null, "top_p": null, "presence_penalty": 7468.94, "frequency_penalty": 3967.09, "instructions": null, "metadata": null, "tools": [], "tool_choice": "auto", "parallel_tool_calls": true}
"400": "400":
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}} application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
"401": "401":
@@ -1096,7 +1272,7 @@ examples:
id: "<id>" id: "<id>"
responses: responses:
"200": "200":
application/json: {"data": {"id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG", "upstream_id": "chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946", "total_cost": 0.0015, "cache_discount": 0.0002, "upstream_inference_cost": 0.0012, "created_at": "2024-07-15T23:33:19.433273+00:00", "model": "sao10k/l3-stheno-8b", "app_id": 12345, "streamed": true, "cancelled": false, "provider_name": "Infermatic", "latency": 1250, "moderation_latency": 50, "generation_time": 1200, "finish_reason": "stop", "tokens_prompt": 10, "tokens_completion": 25, "native_tokens_prompt": 10, "native_tokens_completion": 25, "native_tokens_completion_images": 0, "native_tokens_reasoning": 5, "native_tokens_cached": 3, "num_media_prompt": 1, "num_input_audio_prompt": 0, "num_media_completion": 0, "num_search_results": 5, "origin": "https://openrouter.ai/", "usage": 0.0015, "is_byok": false, "native_finish_reason": "stop", "external_user": "user-123", "api_type": "completions", "router": "openrouter/auto", "provider_responses": []}} application/json: {"data": {"id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG", "upstream_id": "chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946", "total_cost": 0.0015, "cache_discount": 0.0002, "upstream_inference_cost": 0.0012, "created_at": "2024-07-15T23:33:19.433273+00:00", "model": "sao10k/l3-stheno-8b", "app_id": 12345, "streamed": true, "cancelled": false, "provider_name": "Infermatic", "latency": 1250, "moderation_latency": 50, "generation_time": 1200, "finish_reason": "stop", "tokens_prompt": 10, "tokens_completion": 25, "native_tokens_prompt": 10, "native_tokens_completion": 25, "native_tokens_completion_images": 0, "native_tokens_reasoning": 5, "native_tokens_cached": 3, "num_media_prompt": 1, "num_input_audio_prompt": 0, "num_media_completion": 0, "num_search_results": 5, "origin": "https://openrouter.ai/", "usage": 0.0015, "is_byok": false, "native_finish_reason": "stop", "external_user": "user-123", "api_type": "completions", "router": "openrouter/auto", "provider_responses": [], "user_agent": "<value>", "http_referer": null}}
"401": "401":
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}} application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
"402": "402":
@@ -1120,6 +1296,8 @@ examples:
application/json: {"data": {"count": 150}} application/json: {"data": {"count": 150}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
"400":
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
getModels: getModels:
speakeasy-default-get-models: speakeasy-default-get-models:
responses: responses:
@@ -1299,13 +1477,15 @@ examples:
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}} application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
"409":
application/json: {"error": {"code": 409, "message": "Resource conflict. Please try again later."}}
sendChatCompletionRequest: sendChatCompletionRequest:
speakeasy-default-send-chat-completion-request: speakeasy-default-send-chat-completion-request:
requestBody: requestBody:
application/json: {"messages": [{"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "What is the capital of France?"}], "stream": false, "temperature": 0.7, "top_p": 1} application/json: {"messages": [{"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "What is the capital of France?"}], "stream": false, "temperature": 0.7, "top_p": 1}
responses: responses:
"200": "200":
application/json: {"id": "chatcmpl-123", "choices": [{"finish_reason": "stop", "index": 0, "message": {"role": "assistant"}}], "created": 1677652288, "model": "openai/gpt-4", "object": "chat.completion"} application/json: {"id": "chatcmpl-123", "choices": [{"finish_reason": "stop", "index": 0, "message": {"role": "assistant"}}], "created": 1677652288, "model": "openai/gpt-4", "object": "chat.completion", "system_fingerprint": "fp_44709d6fcb"}
"400": "400":
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}} application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
"500": "500":
+1 -1
View File
@@ -31,7 +31,7 @@ generation:
skipResponseBodyAssertions: false skipResponseBodyAssertions: false
preApplyUnionDiscriminators: true preApplyUnionDiscriminators: true
python: python:
version: 0.7.11 version: 0.9.0
additionalDependencies: additionalDependencies:
dev: {} dev: {}
main: {} main: {}
+4637 -401
View File
File diff suppressed because it is too large Load Diff
+4668 -404
View File
File diff suppressed because it is too large Load Diff
+12 -3
View File
@@ -1,17 +1,18 @@
overlay: 1.0.0 overlay: 1.0.0
x-speakeasy-jsonpath: rfc9535 x-speakeasy-jsonpath: rfc9535
info: info:
title: Add HTTP-Referer and X-Title as global parameters title: Add HTTP-Referer and X-OpenRouter-Title as global parameters
version: 0.0.0 version: 0.0.0
actions: actions:
# Add global parameters for app identification # Add global parameters for app identification
- target: $ - target: $
description: Add x-speakeasy-globals for HTTP-Referer and X-Title headers description: Add x-speakeasy-globals for HTTP-Referer, X-OpenRouter-Title, and X-OpenRouter-Categories headers
update: update:
x-speakeasy-globals: x-speakeasy-globals:
parameters: parameters:
- $ref: "#/components/parameters/AppIdentifier" - $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName" - $ref: "#/components/parameters/AppDisplayName"
- $ref: "#/components/parameters/AppCategories"
# Add component parameters # Add component parameters
- target: $.components - target: $.components
@@ -27,12 +28,19 @@ actions:
The app identifier should be your app's URL and is used as the primary identifier for rankings. The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application. This is used to track API usage per application.
AppDisplayName: AppDisplayName:
name: X-Title name: X-OpenRouter-Title
in: header in: header
schema: schema:
type: string type: string
description: | description: |
The app display name allows you to customize how your app appears in OpenRouter's dashboard. The app display name allows you to customize how your app appears in OpenRouter's dashboard.
AppCategories:
name: X-OpenRouter-Categories
in: header
schema:
type: string
description: |
Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
# Add header parameters to all paths so Speakeasy matches them with globals # Add header parameters to all paths so Speakeasy matches them with globals
- target: $.paths[*] - target: $.paths[*]
@@ -41,3 +49,4 @@ actions:
parameters: parameters:
- $ref: "#/components/parameters/AppIdentifier" - $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName" - $ref: "#/components/parameters/AppDisplayName"
- $ref: "#/components/parameters/AppCategories"
+5 -5
View File
@@ -8,8 +8,8 @@ sources:
- latest - latest
OpenRouter API: OpenRouter API:
sourceNamespace: open-router-chat-completions-api sourceNamespace: open-router-chat-completions-api
sourceRevisionDigest: sha256:8a64fb1c1030c87db14bca3af4883e06b9d5853c153a5fd0f2e4c15166e034dd sourceRevisionDigest: sha256:33bc86b7a9b24082a410a8b5cbdd05ee359c9be2c88a2947893942d6bca20dca
sourceBlobDigest: sha256:7f6d7d20424f27ec13e6ae45a1599dab23f2573a69d634b1bb1c346f8a328ae9 sourceBlobDigest: sha256:63c840be5dfe448c1d3f6ec9c15e1d92d117b35cccd134b1e736e1fb563d013d
tags: tags:
- latest - latest
- main - main
@@ -18,10 +18,10 @@ targets:
open-router: open-router:
source: OpenRouter API source: OpenRouter API
sourceNamespace: open-router-chat-completions-api sourceNamespace: open-router-chat-completions-api
sourceRevisionDigest: sha256:8a64fb1c1030c87db14bca3af4883e06b9d5853c153a5fd0f2e4c15166e034dd sourceRevisionDigest: sha256:33bc86b7a9b24082a410a8b5cbdd05ee359c9be2c88a2947893942d6bca20dca
sourceBlobDigest: sha256:7f6d7d20424f27ec13e6ae45a1599dab23f2573a69d634b1bb1c346f8a328ae9 sourceBlobDigest: sha256:63c840be5dfe448c1d3f6ec9c15e1d92d117b35cccd134b1e736e1fb563d013d
codeSamplesNamespace: open-router-python-code-samples codeSamplesNamespace: open-router-python-code-samples
codeSamplesRevisionDigest: sha256:349390cb3f04fb4fdd6292a33ff1ee0659846fe1e3f03bede5bf13f3e70c447f codeSamplesRevisionDigest: sha256:b23dcc24419d8d006315e89e7a2fe131e28d72f19edb4fa920c97658e9e78073
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: 1.666.0 speakeasyVersion: 1.666.0
+4 -2
View File
@@ -183,7 +183,8 @@ def main():
with OpenRouter( with OpenRouter(
http_referer="<value>", http_referer="<value>",
x_title="<value>", x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
# Rest of application here... # Rest of application here...
@@ -194,7 +195,8 @@ async def amain():
async with OpenRouter( async with OpenRouter(
http_referer="<value>", http_referer="<value>",
x_title="<value>", x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
# Rest of application here... # Rest of application here...
+4 -2
View File
@@ -183,7 +183,8 @@ def main():
with OpenRouter( with OpenRouter(
http_referer="<value>", http_referer="<value>",
x_title="<value>", x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
# Rest of application here... # Rest of application here...
@@ -194,7 +195,8 @@ async def amain():
async with OpenRouter( async with OpenRouter(
http_referer="<value>", http_referer="<value>",
x_title="<value>", x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
# Rest of application here... # Rest of application here...
+4 -2
View File
@@ -7,7 +7,8 @@ import os
with OpenRouter( with OpenRouter(
http_referer="<value>", http_referer="<value>",
x_title="<value>", x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
@@ -33,7 +34,8 @@ async def main():
async with OpenRouter( async with OpenRouter(
http_referer="<value>", http_referer="<value>",
x_title="<value>", x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
+23
View File
@@ -0,0 +1,23 @@
# Action
## Supported Types
### `components.ActionSearch`
```python
value: components.ActionSearch = /* values here */
```
### `components.ActionOpenPage`
```python
value: components.ActionOpenPage = /* values here */
```
### `components.ActionFindInPage`
```python
value: components.ActionFindInPage = /* values here */
```
+10
View File
@@ -0,0 +1,10 @@
# ActionFindInPage
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `type` | [components.TypeFindInPage](../components/typefindinpage.md) | :heavy_check_mark: | N/A |
| `pattern` | *str* | :heavy_check_mark: | N/A |
| `url` | *str* | :heavy_check_mark: | N/A |
+9
View File
@@ -0,0 +1,9 @@
# ActionOpenPage
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
| `type` | [components.TypeOpenPage](../components/typeopenpage.md) | :heavy_check_mark: | N/A |
| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
+11
View File
@@ -0,0 +1,11 @@
# ActionSearch
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `type` | [components.TypeSearch](../components/typesearch.md) | :heavy_check_mark: | N/A |
| `query` | *str* | :heavy_check_mark: | N/A |
| `queries` | List[*str*] | :heavy_minus_sign: | N/A |
| `sources` | List[[components.Source](../components/source.md)] | :heavy_minus_sign: | N/A |
+9
View File
@@ -0,0 +1,9 @@
# AllowedTools
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A |
+8
View File
@@ -0,0 +1,8 @@
# Always
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
+11 -10
View File
@@ -5,13 +5,14 @@ Assistant message for requests and responses
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `role` | [components.AssistantMessageRole](../components/assistantmessagerole.md) | :heavy_check_mark: | N/A | | | `role` | [components.AssistantMessageRole](../components/assistantmessagerole.md) | :heavy_check_mark: | N/A | |
| `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | Assistant message content | | | `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | Assistant message content | |
| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the assistant | | | `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the assistant | |
| `tool_calls` | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls made by the assistant | | | `tool_calls` | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls made by the assistant | |
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message if content was refused | | | `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message if content was refused | |
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning output | | | `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning output | |
| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | | | `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | |
| `images` | List[[components.AssistantMessageImages](../components/assistantmessageimages.md)] | :heavy_minus_sign: | Generated images from image generation models | [<br/>{<br/>"image_url": {<br/>"url": "data:image/png;base64,iVBORw0KGgo..."<br/>}<br/>}<br/>] | | `images` | List[[components.AssistantMessageImages](../components/assistantmessageimages.md)] | :heavy_minus_sign: | Generated images from image generation models | [<br/>{<br/>"image_url": {<br/>"url": "data:image/png;base64,iVBORw0KGgo..."<br/>}<br/>}<br/>] |
| `audio` | [Optional[components.ChatCompletionAudioOutput]](../components/chatcompletionaudiooutput.md) | :heavy_minus_sign: | Audio output data or reference | {<br/>"id": "audio_abc123",<br/>"expires_at": 1677652400,<br/>"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",<br/>"transcript": "Hello! How can I help you today?"<br/>} |
+10
View File
@@ -0,0 +1,10 @@
# Background
## Values
| Name | Value |
| ------------- | ------------- |
| `TRANSPARENT` | transparent |
| `OPAQUE` | opaque |
| `AUTO` | auto |
+2 -1
View File
@@ -9,4 +9,5 @@ The provider sorting strategy (price, throughput, latency)
| ------------ | ------------ | | ------------ | ------------ |
| `PRICE` | price | | `PRICE` | price |
| `THROUGHPUT` | throughput | | `THROUGHPUT` | throughput |
| `LATENCY` | latency | | `LATENCY` | latency |
| `EXACTO` | exacto |
+11
View File
@@ -0,0 +1,11 @@
# CacheControl
Enable automatic prompt caching. When set, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `type` | [components.ChatGenerationParamsType](../components/chatgenerationparamstype.md) | :heavy_check_mark: | N/A |
| `ttl` | [Optional[components.ChatGenerationParamsTTL]](../components/chatgenerationparamsttl.md) | :heavy_minus_sign: | N/A |
@@ -0,0 +1,13 @@
# ChatCompletionAudioOutput
Audio output data or reference
## Fields
| Field | Type | Required | Description |
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
| `id` | *Optional[str]* | :heavy_minus_sign: | Audio output identifier |
| `expires_at` | *Optional[float]* | :heavy_minus_sign: | Audio expiration timestamp |
| `data` | *Optional[str]* | :heavy_minus_sign: | Base64 encoded audio data |
| `transcript` | *Optional[str]* | :heavy_minus_sign: | Audio transcript |
+3 -2
View File
@@ -20,7 +20,7 @@ Chat completion request parameters
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | | `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false |
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | | `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 |
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | | `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens in completion | 100 |
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens) | 100 | | `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 |
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | {<br/>"user_id": "user-123",<br/>"session_id": "session-456"<br/>} | | `metadata` | Dict[str, *str*] | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | {<br/>"user_id": "user-123",<br/>"session_id": "session-456"<br/>} |
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | | `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 |
| `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | Configuration options for reasoning models | {<br/>"effort": "medium",<br/>"summary": "concise"<br/>} | | `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | Configuration options for reasoning models | {<br/>"effort": "medium",<br/>"summary": "concise"<br/>} |
@@ -36,4 +36,5 @@ Chat completion request parameters
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | | `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 |
| `debug` | [Optional[components.DebugOptions]](../components/debugoptions.md) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | {<br/>"echo_upstream_body": true<br/>} | | `debug` | [Optional[components.DebugOptions]](../components/debugoptions.md) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | {<br/>"echo_upstream_body": true<br/>} |
| `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](../components/chatgenerationparamsimageconfig.md)] | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | {<br/>"aspect_ratio": "16:9"<br/>} | | `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](../components/chatgenerationparamsimageconfig.md)] | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | {<br/>"aspect_ratio": "16:9"<br/>} |
| `modalities` | List[[components.Modality](../components/modality.md)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [<br/>"text",<br/>"image"<br/>] | | `modalities` | List[[components.Modality](../components/modality.md)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [<br/>"text",<br/>"image"<br/>] |
| `cache_control` | [Optional[components.CacheControl]](../components/cachecontrol.md) | :heavy_minus_sign: | Enable automatic prompt caching. When set, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. | |
+2 -1
View File
@@ -9,4 +9,5 @@ The provider sorting strategy (price, throughput, latency)
| ------------ | ------------ | | ------------ | ------------ |
| `PRICE` | price | | `PRICE` | price |
| `THROUGHPUT` | throughput | | `THROUGHPUT` | throughput |
| `LATENCY` | latency | | `LATENCY` | latency |
| `EXACTO` | exacto |
@@ -0,0 +1,8 @@
# ChatGenerationParamsIDContextCompression
## Values
| Name | Value |
| --------------------- | --------------------- |
| `CONTEXT_COMPRESSION` | context-compression |
@@ -0,0 +1,10 @@
# ChatGenerationParamsPluginContextCompression
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `id` | [components.ChatGenerationParamsIDContextCompression](../components/chatgenerationparamsidcontextcompression.md) | :heavy_check_mark: | N/A |
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. |
| `engine` | [Optional[components.ContextCompressionEngine]](../components/contextcompressionengine.md) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". |
@@ -33,3 +33,9 @@ value: components.ChatGenerationParamsPluginFileParser = /* values here */
value: components.ChatGenerationParamsPluginResponseHealing = /* values here */ value: components.ChatGenerationParamsPluginResponseHealing = /* values here */
``` ```
### `components.ChatGenerationParamsPluginContextCompression`
```python
value: components.ChatGenerationParamsPluginContextCompression = /* values here */
```
@@ -3,10 +3,12 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | [components.ChatGenerationParamsIDWeb](../components/chatgenerationparamsidweb.md) | :heavy_check_mark: | N/A | | `id` | [components.ChatGenerationParamsIDWeb](../components/chatgenerationparamsidweb.md) | :heavy_check_mark: | N/A | |
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | |
| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A | | `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A | |
| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | | `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | |
| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.md) | :heavy_minus_sign: | The search engine to use for web search. | | `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.md) | :heavy_minus_sign: | The search engine to use for web search. | |
| `include_domains` | List[*str*] | :heavy_minus_sign: | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>] |
| `exclude_domains` | List[*str*] | :heavy_minus_sign: | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>] |
@@ -9,4 +9,5 @@ The provider sorting strategy (price, throughput, latency)
| ------------ | ------------ | | ------------ | ------------ |
| `PRICE` | price | | `PRICE` | price |
| `THROUGHPUT` | throughput | | `THROUGHPUT` | throughput |
| `LATENCY` | latency | | `LATENCY` | latency |
| `EXACTO` | exacto |
@@ -7,4 +7,5 @@
| ------------ | ------------ | | ------------ | ------------ |
| `PRICE` | price | | `PRICE` | price |
| `THROUGHPUT` | throughput | | `THROUGHPUT` | throughput |
| `LATENCY` | latency | | `LATENCY` | latency |
| `EXACTO` | exacto |
@@ -7,4 +7,5 @@
| ------------ | ------------ | | ------------ | ------------ |
| `PRICE` | price | | `PRICE` | price |
| `THROUGHPUT` | throughput | | `THROUGHPUT` | throughput |
| `LATENCY` | latency | | `LATENCY` | latency |
| `EXACTO` | exacto |
@@ -1,4 +1,4 @@
# TTL # ChatGenerationParamsTTL
## Values ## Values
@@ -0,0 +1,8 @@
# ChatGenerationParamsType
## Values
| Name | Value |
| ----------- | ----------- |
| `EPHEMERAL` | ephemeral |
@@ -29,3 +29,9 @@ value: components.ChatMessageContentItemAudio = /* values here */
value: components.ChatMessageContentItem1 = /* values here */ value: components.ChatMessageContentItem1 = /* values here */
``` ```
### `components.ChatMessageContentItemFile`
```python
value: components.ChatMessageContentItemFile = /* values here */
```
@@ -5,7 +5,7 @@ Cache control for the content part
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `type` | [components.ChatMessageContentItemCacheControlType](../components/chatmessagecontentitemcachecontroltype.md) | :heavy_check_mark: | N/A | | `type` | [components.ChatMessageContentItemCacheControlType](../components/chatmessagecontentitemcachecontroltype.md) | :heavy_check_mark: | N/A |
| `ttl` | [Optional[components.TTL]](../components/ttl.md) | :heavy_minus_sign: | N/A | | `ttl` | [Optional[components.ChatMessageContentItemCacheControlTTL]](../components/chatmessagecontentitemcachecontrolttl.md) | :heavy_minus_sign: | N/A |
@@ -0,0 +1,9 @@
# ChatMessageContentItemCacheControlTTL
## Values
| Name | Value |
| ------- | ------- |
| `FIVEM` | 5m |
| `ONEH` | 1h |
@@ -0,0 +1,11 @@
# ChatMessageContentItemFile
File content part for document processing
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `type` | [components.ChatMessageContentItemFileType](../components/chatmessagecontentitemfiletype.md) | :heavy_check_mark: | N/A |
| `file` | [components.File](../components/file.md) | :heavy_check_mark: | N/A |
@@ -0,0 +1,8 @@
# ChatMessageContentItemFileType
## Values
| Name | Value |
| ------ | ------ |
| `FILE` | file |
+1 -1
View File
@@ -8,4 +8,4 @@ Log probabilities for the completion
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `content` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | Log probabilities for content tokens | | `content` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | Log probabilities for content tokens |
| `refusal` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | Log probabilities for refusal tokens | | `refusal` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_minus_sign: | Log probabilities for refusal tokens |
+1 -1
View File
@@ -12,5 +12,5 @@ Chat completion response
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | | `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | | `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
| `object` | [components.ChatResponseObject](../components/chatresponseobject.md) | :heavy_check_mark: | N/A | | | `object` | [components.ChatResponseObject](../components/chatresponseobject.md) | :heavy_check_mark: | N/A | |
| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | | `system_fingerprint` | *Nullable[str]* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb |
| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | Token usage statistics | {<br/>"completion_tokens": 15,<br/>"prompt_tokens": 10,<br/>"total_tokens": 25,<br/>"completion_tokens_details": {<br/>"reasoning_tokens": 5<br/>},<br/>"prompt_tokens_details": {<br/>"cached_tokens": 2<br/>}<br/>} | | `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | Token usage statistics | {<br/>"completion_tokens": 15,<br/>"prompt_tokens": 10,<br/>"total_tokens": 25,<br/>"completion_tokens_details": {<br/>"reasoning_tokens": 5<br/>},<br/>"prompt_tokens_details": {<br/>"cached_tokens": 2<br/>}<br/>} |
+9 -8
View File
@@ -5,11 +5,12 @@ Delta changes in streaming response
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `role` | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign: | The role of the message author | assistant | | `role` | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign: | The role of the message author | assistant |
| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | Message content delta | Hello | | `content` | *OptionalNullable[str]* | :heavy_minus_sign: | Message content delta | Hello |
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to | | `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to |
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | <nil> | | `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | <nil> |
| `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls delta | | | `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls delta | |
| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | | | `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | |
| `audio` | [Optional[components.ChatCompletionAudioOutput]](../components/chatcompletionaudiooutput.md) | :heavy_minus_sign: | N/A | {<br/>"id": "audio_abc123",<br/>"expires_at": 1677652400,<br/>"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",<br/>"transcript": "Hello! How can I help you today?"<br/>} |
@@ -12,6 +12,6 @@ Streaming chat completion chunk
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | | `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | | `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
| `object` | [components.ChatStreamingResponseChunkObject](../components/chatstreamingresponsechunkobject.md) | :heavy_check_mark: | N/A | | | `object` | [components.ChatStreamingResponseChunkObject](../components/chatstreamingresponsechunkobject.md) | :heavy_check_mark: | N/A | |
| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | | `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb |
| `error` | [Optional[components.Error]](../components/error.md) | :heavy_minus_sign: | Error information | {<br/>"message": "Rate limit exceeded",<br/>"code": 429<br/>} | | `error` | [Optional[components.Error]](../components/error.md) | :heavy_minus_sign: | Error information | {<br/>"message": "Rate limit exceeded",<br/>"code": 429<br/>} |
| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | Token usage statistics | {<br/>"completion_tokens": 15,<br/>"prompt_tokens": 10,<br/>"total_tokens": 25,<br/>"completion_tokens_details": {<br/>"reasoning_tokens": 5<br/>},<br/>"prompt_tokens_details": {<br/>"cached_tokens": 2<br/>}<br/>} | | `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | Token usage statistics | {<br/>"completion_tokens": 15,<br/>"prompt_tokens": 10,<br/>"total_tokens": 25,<br/>"completion_tokens_details": {<br/>"reasoning_tokens": 5<br/>},<br/>"prompt_tokens_details": {<br/>"cached_tokens": 2<br/>}<br/>} |
+11
View File
@@ -0,0 +1,11 @@
# CompoundFilter
A compound filter that combines multiple comparison or compound filters
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `type` | [components.CompoundFilterType](../components/compoundfiltertype.md) | :heavy_check_mark: | N/A |
| `filters` | List[Dict[str, *Nullable[Any]*]] | :heavy_check_mark: | N/A |
+9
View File
@@ -0,0 +1,9 @@
# CompoundFilterType
## Values
| Name | Value |
| ----- | ----- |
| `AND` | and |
| `OR` | or |
@@ -0,0 +1,12 @@
# ConflictResponseErrorData
Error data for ConflictResponse
## Fields
| Field | Type | Required | Description |
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
| `code` | *int* | :heavy_check_mark: | N/A |
| `message` | *str* | :heavy_check_mark: | N/A |
| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A |
+15
View File
@@ -0,0 +1,15 @@
# ConnectorID
## Values
| Name | Value |
| --------------------------- | --------------------------- |
| `CONNECTOR_DROPBOX` | connector_dropbox |
| `CONNECTOR_GMAIL` | connector_gmail |
| `CONNECTOR_GOOGLECALENDAR` | connector_googlecalendar |
| `CONNECTOR_GOOGLEDRIVE` | connector_googledrive |
| `CONNECTOR_MICROSOFTTEAMS` | connector_microsoftteams |
| `CONNECTOR_OUTLOOKCALENDAR` | connector_outlookcalendar |
| `CONNECTOR_OUTLOOKEMAIL` | connector_outlookemail |
| `CONNECTOR_SHAREPOINT` | connector_sharepoint |
+17
View File
@@ -0,0 +1,17 @@
# Container
## Supported Types
### `str`
```python
value: str = /* values here */
```
### `components.ContainerAuto`
```python
value: components.ContainerAuto = /* values here */
```
+10
View File
@@ -0,0 +1,10 @@
# ContainerAuto
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `type` | [components.ContainerType](../components/containertype.md) | :heavy_check_mark: | N/A |
| `file_ids` | List[*str*] | :heavy_minus_sign: | N/A |
| `memory_limit` | [OptionalNullable[components.MemoryLimit]](../components/memorylimit.md) | :heavy_minus_sign: | N/A |
+8
View File
@@ -0,0 +1,8 @@
# ContainerType
## Values
| Name | Value |
| ------ | ------ |
| `AUTO` | auto |
@@ -0,0 +1,10 @@
# ContextCompressionEngine
The compression engine to use. Defaults to "middle-out".
## Values
| Name | Value |
| ------------ | ------------ |
| `MIDDLE_OUT` | middle-out |
+11
View File
@@ -0,0 +1,11 @@
# DatetimeServerTool
OpenRouter built-in server tool: returns the current date and time
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `type` | [components.DatetimeServerToolType](../components/datetimeservertooltype.md) | :heavy_check_mark: | N/A |
| `parameters` | [Optional[components.DatetimeServerToolParameters]](../components/datetimeservertoolparameters.md) | :heavy_minus_sign: | N/A |
@@ -0,0 +1,8 @@
# DatetimeServerToolParameters
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `timezone` | *Optional[str]* | :heavy_minus_sign: | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York |
@@ -0,0 +1,8 @@
# DatetimeServerToolType
## Values
| Name | Value |
| --------------------- | --------------------- |
| `OPENROUTER_DATETIME` | openrouter:datetime |
+4 -1
View File
@@ -9,4 +9,7 @@ Default parameters for this model
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `top_k` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `repetition_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
+12
View File
@@ -0,0 +1,12 @@
# Environment
## Values
| Name | Value |
| --------- | --------- |
| `WINDOWS` | windows |
| `MAC` | mac |
| `LINUX` | linux |
| `UBUNTU` | ubuntu |
| `BROWSER` | browser |
+10
View File
@@ -0,0 +1,10 @@
# File
## Fields
| Field | Type | Required | Description |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `file_data` | *Optional[str]* | :heavy_minus_sign: | File content as base64 data URL or URL |
| `file_id` | *Optional[str]* | :heavy_minus_sign: | File ID for previously uploaded files |
| `filename` | *Optional[str]* | :heavy_minus_sign: | Original filename |
+23
View File
@@ -0,0 +1,23 @@
# Filters
## Supported Types
### `components.OpenResponsesFileSearchToolFilters`
```python
value: components.OpenResponsesFileSearchToolFilters = /* values here */
```
### `components.CompoundFilter`
```python
value: components.CompoundFilter = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```
+13
View File
@@ -0,0 +1,13 @@
# FiltersType
## Values
| Name | Value |
| ----- | ----- |
| `EQ` | eq |
| `NE` | ne |
| `GT` | gt |
| `GTE` | gte |
| `LT` | lt |
| `LTE` | lte |
+17
View File
@@ -0,0 +1,17 @@
# Format
## Supported Types
### `components.FormatText`
```python
value: components.FormatText = /* values here */
```
### `components.FormatGrammar`
```python
value: components.FormatGrammar = /* values here */
```
+10
View File
@@ -0,0 +1,10 @@
# FormatGrammar
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `type` | [components.FormatTypeGrammar](../components/formattypegrammar.md) | :heavy_check_mark: | N/A |
| `definition` | *str* | :heavy_check_mark: | N/A |
| `syntax` | [components.Syntax](../components/syntax.md) | :heavy_check_mark: | N/A |
+8
View File
@@ -0,0 +1,8 @@
# FormatText
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `type` | [components.FormatTypeText](../components/formattypetext.md) | :heavy_check_mark: | N/A |
+8
View File
@@ -0,0 +1,8 @@
# FormatTypeGrammar
## Values
| Name | Value |
| --------- | --------- |
| `GRAMMAR` | grammar |
+8
View File
@@ -0,0 +1,8 @@
# FormatTypeText
## Values
| Name | Value |
| ------ | ------ |
| `TEXT` | text |
+9
View File
@@ -0,0 +1,9 @@
# InputFidelity
## Values
| Name | Value |
| ------ | ------ |
| `HIGH` | high |
| `LOW` | low |
+9
View File
@@ -0,0 +1,9 @@
# InputImageMask
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `file_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
+11
View File
@@ -0,0 +1,11 @@
# MemoryLimit
## Values
| Name | Value |
| ------------- | ------------- |
| `ONEG` | 1g |
| `FOURG` | 4g |
| `SIXTEENG` | 16g |
| `SIXTY_FOURG` | 64g |
+2 -1
View File
@@ -6,4 +6,5 @@
| Name | Value | | Name | Value |
| ------- | ------- | | ------- | ------- |
| `TEXT` | text | | `TEXT` | text |
| `IMAGE` | image | | `IMAGE` | image |
| `AUDIO` | audio |
+1 -1
View File
@@ -19,5 +19,5 @@ Information about an AI model available on OpenRouter
| `top_provider` | [components.TopProviderInfo](../components/topproviderinfo.md) | :heavy_check_mark: | Information about the top provider for this model | {<br/>"context_length": 8192,<br/>"max_completion_tokens": 4096,<br/>"is_moderated": true<br/>} | | `top_provider` | [components.TopProviderInfo](../components/topproviderinfo.md) | :heavy_check_mark: | Information about the top provider for this model | {<br/>"context_length": 8192,<br/>"max_completion_tokens": 4096,<br/>"is_moderated": true<br/>} |
| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.md) | :heavy_check_mark: | Per-request token limits | {<br/>"prompt_tokens": 1000,<br/>"completion_tokens": 1000<br/>} | | `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.md) | :heavy_check_mark: | Per-request token limits | {<br/>"prompt_tokens": 1000,<br/>"completion_tokens": 1000<br/>} |
| `supported_parameters` | List[[components.Parameter](../components/parameter.md)] | :heavy_check_mark: | List of supported parameters for this model | | | `supported_parameters` | List[[components.Parameter](../components/parameter.md)] | :heavy_check_mark: | List of supported parameters for this model | |
| `default_parameters` | [Nullable[components.DefaultParameters]](../components/defaultparameters.md) | :heavy_check_mark: | Default parameters for this model | {<br/>"temperature": 0.7,<br/>"top_p": 0.9,<br/>"frequency_penalty": 0<br/>} | | `default_parameters` | [Nullable[components.DefaultParameters]](../components/defaultparameters.md) | :heavy_check_mark: | Default parameters for this model | {<br/>"temperature": 0.7,<br/>"top_p": 0.9,<br/>"top_k": 0,<br/>"frequency_penalty": 0,<br/>"presence_penalty": 0,<br/>"repetition_penalty": 1<br/>} |
| `expiration_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | | `expiration_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 |
+9
View File
@@ -0,0 +1,9 @@
# ModelEnum
## Values
| Name | Value |
| ------------------ | ------------------ |
| `GPT_IMAGE_1` | gpt-image-1 |
| `GPT_IMAGE_1_MINI` | gpt-image-1-mini |
+9
View File
@@ -0,0 +1,9 @@
# Moderation
## Values
| Name | Value |
| ------ | ------ |
| `AUTO` | auto |
| `LOW` | low |
+8
View File
@@ -0,0 +1,8 @@
# Never
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
@@ -8,5 +8,5 @@
| `type` | [components.OpenAIResponsesInputTypeFunctionCallOutput](../components/openairesponsesinputtypefunctioncalloutput.md) | :heavy_check_mark: | N/A | | | `type` | [components.OpenAIResponsesInputTypeFunctionCallOutput](../components/openairesponsesinputtypefunctioncalloutput.md) | :heavy_check_mark: | N/A | |
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
| `call_id` | *str* | :heavy_check_mark: | N/A | | | `call_id` | *str* | :heavy_check_mark: | N/A | |
| `output` | *str* | :heavy_check_mark: | N/A | | | `output` | [components.OpenAIResponsesInputOutput2](../components/openairesponsesinputoutput2.md) | :heavy_check_mark: | N/A | |
| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed | | `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed |
@@ -3,8 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `type` | [Optional[components.OpenAIResponsesInputTypeMessage1]](../components/openairesponsesinputtypemessage1.md) | :heavy_minus_sign: | N/A | | `type` | [Optional[components.OpenAIResponsesInputTypeMessage1]](../components/openairesponsesinputtypemessage1.md) | :heavy_minus_sign: | N/A |
| `role` | [components.OpenAIResponsesInputRoleUnion1](../components/openairesponsesinputroleunion1.md) | :heavy_check_mark: | N/A | | `role` | [components.OpenAIResponsesInputRoleUnion1](../components/openairesponsesinputroleunion1.md) | :heavy_check_mark: | N/A |
| `content` | [components.OpenAIResponsesInputContent2](../components/openairesponsesinputcontent2.md) | :heavy_check_mark: | N/A | | `content` | [components.OpenAIResponsesInputContent2](../components/openairesponsesinputcontent2.md) | :heavy_check_mark: | N/A |
| `phase` | [OptionalNullable[components.OpenAIResponsesInputPhaseUnion]](../components/openairesponsesinputphaseunion.md) | :heavy_minus_sign: | N/A |
@@ -0,0 +1,23 @@
# OpenAIResponsesInputOutput1
## Supported Types
### `components.ResponseInputText`
```python
value: components.ResponseInputText = /* values here */
```
### `components.ResponseInputImage`
```python
value: components.ResponseInputImage = /* values here */
```
### `components.ResponseInputFile`
```python
value: components.ResponseInputFile = /* values here */
```
@@ -0,0 +1,17 @@
# OpenAIResponsesInputOutput2
## Supported Types
### `str`
```python
value: str = /* values here */
```
### `List[components.OpenAIResponsesInputOutput1]`
```python
value: List[components.OpenAIResponsesInputOutput1] = /* values here */
```
@@ -0,0 +1,8 @@
# OpenAIResponsesInputPhaseCommentary
## Values
| Name | Value |
| ------------ | ------------ |
| `COMMENTARY` | commentary |
@@ -0,0 +1,8 @@
# OpenAIResponsesInputPhaseFinalAnswer
## Values
| Name | Value |
| -------------- | -------------- |
| `FINAL_ANSWER` | final_answer |
@@ -0,0 +1,23 @@
# OpenAIResponsesInputPhaseUnion
## Supported Types
### `components.OpenAIResponsesInputPhaseCommentary`
```python
value: components.OpenAIResponsesInputPhaseCommentary = /* values here */
```
### `components.OpenAIResponsesInputPhaseFinalAnswer`
```python
value: components.OpenAIResponsesInputPhaseFinalAnswer = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```
@@ -0,0 +1,10 @@
# OpenResponsesApplyPatchTool
Apply patch tool configuration
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `type` | [components.OpenResponsesApplyPatchToolType](../components/openresponsesapplypatchtooltype.md) | :heavy_check_mark: | N/A |
@@ -0,0 +1,8 @@
# OpenResponsesApplyPatchToolType
## Values
| Name | Value |
| ------------- | ------------- |
| `APPLY_PATCH` | apply_patch |
@@ -0,0 +1,11 @@
# OpenResponsesCodeInterpreterTool
Code interpreter tool configuration
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `type` | [components.TypeCodeInterpreter](../components/typecodeinterpreter.md) | :heavy_check_mark: | N/A |
| `container` | [components.Container](../components/container.md) | :heavy_check_mark: | N/A |
@@ -0,0 +1,13 @@
# OpenResponsesComputerTool
Computer use preview tool configuration
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `type` | [components.OpenResponsesComputerToolType](../components/openresponsescomputertooltype.md) | :heavy_check_mark: | N/A |
| `display_height` | *float* | :heavy_check_mark: | N/A |
| `display_width` | *float* | :heavy_check_mark: | N/A |
| `environment` | [components.Environment](../components/environment.md) | :heavy_check_mark: | N/A |
@@ -0,0 +1,8 @@
# OpenResponsesComputerToolType
## Values
| Name | Value |
| ---------------------- | ---------------------- |
| `COMPUTER_USE_PREVIEW` | computer_use_preview |
@@ -0,0 +1,13 @@
# OpenResponsesCustomTool
Custom tool configuration
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `type` | [components.TypeCustom](../components/typecustom.md) | :heavy_check_mark: | N/A |
| `name` | *str* | :heavy_check_mark: | N/A |
| `description` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `format_` | [Optional[components.Format]](../components/format_.md) | :heavy_minus_sign: | N/A |
@@ -3,8 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [Optional[components.OpenResponsesEasyInputMessageTypeMessage]](../components/openresponseseasyinputmessagetypemessage.md) | :heavy_minus_sign: | N/A | | `type` | [Optional[components.OpenResponsesEasyInputMessageTypeMessage]](../components/openresponseseasyinputmessagetypemessage.md) | :heavy_minus_sign: | N/A | |
| `role` | [components.OpenResponsesEasyInputMessageRoleUnion](../components/openresponseseasyinputmessageroleunion.md) | :heavy_check_mark: | N/A | | `role` | [components.OpenResponsesEasyInputMessageRoleUnion](../components/openresponseseasyinputmessageroleunion.md) | :heavy_check_mark: | N/A | |
| `content` | [components.OpenResponsesEasyInputMessageContentUnion2](../components/openresponseseasyinputmessagecontentunion2.md) | :heavy_check_mark: | N/A | | `content` | [OptionalNullable[components.OpenResponsesEasyInputMessageContentUnion2]](../components/openresponseseasyinputmessagecontentunion2.md) | :heavy_minus_sign: | N/A | |
| `phase` | [OptionalNullable[components.OpenResponsesEasyInputMessagePhaseUnion]](../components/openresponseseasyinputmessagephaseunion.md) | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer |
@@ -15,3 +15,9 @@ value: List[components.OpenResponsesEasyInputMessageContentUnion1] = /* values h
value: str = /* values here */ value: str = /* values here */
``` ```
### `Any`
```python
value: Any = /* values here */
```
@@ -0,0 +1,8 @@
# OpenResponsesEasyInputMessagePhaseCommentary
## Values
| Name | Value |
| ------------ | ------------ |
| `COMMENTARY` | commentary |
@@ -0,0 +1,8 @@
# OpenResponsesEasyInputMessagePhaseFinalAnswer
## Values
| Name | Value |
| -------------- | -------------- |
| `FINAL_ANSWER` | final_answer |
@@ -0,0 +1,25 @@
# OpenResponsesEasyInputMessagePhaseUnion
The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages.
## Supported Types
### `components.OpenResponsesEasyInputMessagePhaseCommentary`
```python
value: components.OpenResponsesEasyInputMessagePhaseCommentary = /* values here */
```
### `components.OpenResponsesEasyInputMessagePhaseFinalAnswer`
```python
value: components.OpenResponsesEasyInputMessagePhaseFinalAnswer = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```
@@ -0,0 +1,14 @@
# OpenResponsesFileSearchTool
File search tool configuration
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `type` | [components.TypeFileSearch](../components/typefilesearch.md) | :heavy_check_mark: | N/A |
| `vector_store_ids` | List[*str*] | :heavy_check_mark: | N/A |
| `filters` | [OptionalNullable[components.Filters]](../components/filters.md) | :heavy_minus_sign: | N/A |
| `max_num_results` | *Optional[int]* | :heavy_minus_sign: | N/A |
| `ranking_options` | [Optional[components.RankingOptions]](../components/rankingoptions.md) | :heavy_minus_sign: | N/A |
@@ -0,0 +1,10 @@
# OpenResponsesFileSearchToolFilters
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A |
| `type` | [components.FiltersType](../components/filterstype.md) | :heavy_check_mark: | N/A |
| `value` | [components.Value2](../components/value2.md) | :heavy_check_mark: | N/A |
@@ -5,10 +5,10 @@ The output from a function call execution
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | [components.OpenResponsesFunctionCallOutputType](../components/openresponsesfunctioncalloutputtype.md) | :heavy_check_mark: | N/A | | | `type` | [components.OpenResponsesFunctionCallOutputTypeFunctionCallOutput](../components/openresponsesfunctioncalloutputtypefunctioncalloutput.md) | :heavy_check_mark: | N/A | |
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
| `call_id` | *str* | :heavy_check_mark: | N/A | | | `call_id` | *str* | :heavy_check_mark: | N/A | |
| `output` | *str* | :heavy_check_mark: | N/A | | | `output` | [components.OpenResponsesFunctionCallOutputOutputUnion2](../components/openresponsesfunctioncalloutputoutputunion2.md) | :heavy_check_mark: | N/A | |
| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed | | `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed |
@@ -0,0 +1,10 @@
# OpenResponsesFunctionCallOutputDetail
## Values
| Name | Value |
| ------ | ------ |
| `AUTO` | auto |
| `HIGH` | high |
| `LOW` | low |
@@ -0,0 +1,23 @@
# OpenResponsesFunctionCallOutputOutputUnion1
## Supported Types
### `components.ResponseInputText`
```python
value: components.ResponseInputText = /* values here */
```
### `components.OutputInputImage`
```python
value: components.OutputInputImage = /* values here */
```
### `components.ResponseInputFile`
```python
value: components.ResponseInputFile = /* values here */
```
@@ -0,0 +1,17 @@
# OpenResponsesFunctionCallOutputOutputUnion2
## Supported Types
### `str`
```python
value: str = /* values here */
```
### `List[components.OpenResponsesFunctionCallOutputOutputUnion1]`
```python
value: List[components.OpenResponsesFunctionCallOutputOutputUnion1] = /* values here */
```
@@ -1,4 +1,4 @@
# OpenResponsesFunctionCallOutputType # OpenResponsesFunctionCallOutputTypeFunctionCallOutput
## Values ## Values
@@ -0,0 +1,10 @@
# OpenResponsesFunctionShellTool
Shell tool configuration
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `type` | [components.OpenResponsesFunctionShellToolType](../components/openresponsesfunctionshelltooltype.md) | :heavy_check_mark: | N/A |
@@ -0,0 +1,8 @@
# OpenResponsesFunctionShellToolType
## Values
| Name | Value |
| ------- | ------- |
| `SHELL` | shell |
@@ -0,0 +1,20 @@
# OpenResponsesImageGenerationTool
Image generation tool configuration
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `type` | [components.OpenResponsesImageGenerationToolType](../components/openresponsesimagegenerationtooltype.md) | :heavy_check_mark: | N/A |
| `background` | [Optional[components.Background]](../components/background.md) | :heavy_minus_sign: | N/A |
| `input_fidelity` | [OptionalNullable[components.InputFidelity]](../components/inputfidelity.md) | :heavy_minus_sign: | N/A |
| `input_image_mask` | [Optional[components.InputImageMask]](../components/inputimagemask.md) | :heavy_minus_sign: | N/A |
| `model` | [Optional[components.ModelEnum]](../components/modelenum.md) | :heavy_minus_sign: | N/A |
| `moderation` | [Optional[components.Moderation]](../components/moderation.md) | :heavy_minus_sign: | N/A |
| `output_compression` | *Optional[float]* | :heavy_minus_sign: | N/A |
| `output_format` | [Optional[components.OutputFormat]](../components/outputformat.md) | :heavy_minus_sign: | N/A |
| `partial_images` | *Optional[float]* | :heavy_minus_sign: | N/A |
| `quality` | [Optional[components.Quality]](../components/quality.md) | :heavy_minus_sign: | N/A |
| `size` | [Optional[components.Size]](../components/size.md) | :heavy_minus_sign: | N/A |
@@ -0,0 +1,8 @@
# OpenResponsesImageGenerationToolType
## Values
| Name | Value |
| ------------------ | ------------------ |
| `IMAGE_GENERATION` | image_generation |
@@ -0,0 +1,17 @@
# OpenResponsesInputContent1
## Supported Types
### `components.ResponseOutputText`
```python
value: components.ResponseOutputText = /* values here */
```
### `components.OpenAIResponsesRefusalContent`
```python
value: components.OpenAIResponsesRefusalContent = /* values here */
```
@@ -0,0 +1,23 @@
# OpenResponsesInputContent2
## Supported Types
### `List[components.OpenResponsesInputContent1]`
```python
value: List[components.OpenResponsesInputContent1] = /* values here */
```
### `str`
```python
value: str = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```

Some files were not shown because too many files have changed in this diff Show More