mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-31 12:30:30 +08:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 OpenRouter Team
|
9193488c2b | ||
|
robert-j-yandGitHub
|
0c791b04d1 | ||
|
OpenRouter Team
|
5f2c0ee2ea | ||
|
robert-j-yandGitHub
|
5832c0495b | ||
|
Robert Yeakel
|
f5dfc30997 | ||
|
Shashank GoyalandGitHub
|
a56ffbf5f3 | ||
|
Shashank Goyal
|
cc2b002c5c | ||
|
Shashank Goyal
|
9774c726fd |
+358
-76
@@ -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: 331e8a1f7c97c6a4a6b57eaddc80fc39
|
docChecksum: 86bc0c01844e23d7e1921008d13372b9
|
||||||
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.0.18
|
releaseVersion: 0.5.1
|
||||||
configChecksum: 1f58284fadb5b2b9029e9ef747f2a7e9
|
configChecksum: 7f34271a911f5490f6f17a4e27f8ef7f
|
||||||
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
|
||||||
@@ -53,31 +53,14 @@ generatedFiles:
|
|||||||
- 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/assistantmessageimageurl.md
|
||||||
- docs/components/badgatewayresponseerrordata.md
|
- docs/components/badgatewayresponseerrordata.md
|
||||||
- docs/components/badrequestresponseerrordata.md
|
- docs/components/badrequestresponseerrordata.md
|
||||||
- docs/components/chainid.md
|
- docs/components/chainid.md
|
||||||
- docs/components/chatcompletionfinishreason.md
|
- docs/components/chatcompletionfinishreason.md
|
||||||
- docs/components/chaterrorerror.md
|
- docs/components/chaterrorerror.md
|
||||||
- docs/components/chatgenerationparams.md
|
- docs/components/chatgenerationparams.md
|
||||||
- docs/components/chatgenerationparamsdatacollection.md
|
|
||||||
- docs/components/chatgenerationparamsimageconfig.md
|
- docs/components/chatgenerationparamsimageconfig.md
|
||||||
- docs/components/chatgenerationparamsmaxprice.md
|
|
||||||
- docs/components/chatgenerationparamspluginautorouter.md
|
|
||||||
- docs/components/chatgenerationparamspluginfileparser.md
|
|
||||||
- docs/components/chatgenerationparamspluginmoderation.md
|
|
||||||
- docs/components/chatgenerationparamspluginresponsehealing.md
|
|
||||||
- docs/components/chatgenerationparamspluginunion.md
|
|
||||||
- docs/components/chatgenerationparamspluginweb.md
|
|
||||||
- docs/components/chatgenerationparamspreferredmaxlatency.md
|
|
||||||
- docs/components/chatgenerationparamspreferredmaxlatencyunion.md
|
|
||||||
- docs/components/chatgenerationparamspreferredminthroughput.md
|
|
||||||
- docs/components/chatgenerationparamspreferredminthroughputunion.md
|
|
||||||
- docs/components/chatgenerationparamsprovider.md
|
|
||||||
- docs/components/chatgenerationparamsresponseformatjsonobject.md
|
|
||||||
- docs/components/chatgenerationparamsresponseformatpython.md
|
|
||||||
- docs/components/chatgenerationparamsresponseformattext.md
|
|
||||||
- docs/components/chatgenerationparamsresponseformatunion.md
|
|
||||||
- docs/components/chatgenerationparamsstop.md
|
|
||||||
- docs/components/chatgenerationtokenusage.md
|
- docs/components/chatgenerationtokenusage.md
|
||||||
- docs/components/chatmessagecontentitem.md
|
- docs/components/chatmessagecontentitem.md
|
||||||
- docs/components/chatmessagecontentitemaudio.md
|
- docs/components/chatmessagecontentitemaudio.md
|
||||||
@@ -85,6 +68,7 @@ generatedFiles:
|
|||||||
- docs/components/chatmessagecontentitemcachecontrol.md
|
- docs/components/chatmessagecontentitemcachecontrol.md
|
||||||
- docs/components/chatmessagecontentitemimage.md
|
- docs/components/chatmessagecontentitemimage.md
|
||||||
- docs/components/chatmessagecontentitemimagedetail.md
|
- docs/components/chatmessagecontentitemimagedetail.md
|
||||||
|
- docs/components/chatmessagecontentitemimageimageurl.md
|
||||||
- docs/components/chatmessagecontentitemtext.md
|
- docs/components/chatmessagecontentitemtext.md
|
||||||
- docs/components/chatmessagecontentitemvideo.md
|
- docs/components/chatmessagecontentitemvideo.md
|
||||||
- docs/components/chatmessagecontentitemvideoinputvideo.md
|
- docs/components/chatmessagecontentitemvideoinputvideo.md
|
||||||
@@ -107,23 +91,15 @@ generatedFiles:
|
|||||||
- docs/components/chatstreamoptions.md
|
- docs/components/chatstreamoptions.md
|
||||||
- docs/components/code.md
|
- docs/components/code.md
|
||||||
- docs/components/codeenum.md
|
- docs/components/codeenum.md
|
||||||
- docs/components/completionchoice.md
|
- docs/components/completion.md
|
||||||
- docs/components/completioncreateparams.md
|
|
||||||
- docs/components/completioncreateparamsresponseformatjsonobject.md
|
|
||||||
- docs/components/completioncreateparamsresponseformatpython.md
|
|
||||||
- docs/components/completioncreateparamsresponseformattext.md
|
|
||||||
- docs/components/completioncreateparamsresponseformatunion.md
|
|
||||||
- docs/components/completioncreateparamsstop.md
|
|
||||||
- docs/components/completionfinishreason.md
|
|
||||||
- docs/components/completionlogprobs.md
|
|
||||||
- docs/components/completionresponse.md
|
|
||||||
- docs/components/completiontokensdetails.md
|
- docs/components/completiontokensdetails.md
|
||||||
- docs/components/completionusage.md
|
|
||||||
- docs/components/costdetails.md
|
- docs/components/costdetails.md
|
||||||
- docs/components/createchargerequest.md
|
- docs/components/createchargerequest.md
|
||||||
- docs/components/datacollection.md
|
- docs/components/datacollection.md
|
||||||
- docs/components/debug.md
|
- docs/components/debug.md
|
||||||
- docs/components/defaultparameters.md
|
- docs/components/defaultparameters.md
|
||||||
|
- docs/components/developermessage.md
|
||||||
|
- docs/components/developermessagecontent.md
|
||||||
- docs/components/edgenetworktimeoutresponseerrordata.md
|
- docs/components/edgenetworktimeoutresponseerrordata.md
|
||||||
- docs/components/effort.md
|
- docs/components/effort.md
|
||||||
- docs/components/endpointstatus.md
|
- docs/components/endpointstatus.md
|
||||||
@@ -138,8 +114,8 @@ generatedFiles:
|
|||||||
- docs/components/idmoderation.md
|
- docs/components/idmoderation.md
|
||||||
- docs/components/idresponsehealing.md
|
- docs/components/idresponsehealing.md
|
||||||
- docs/components/idweb.md
|
- docs/components/idweb.md
|
||||||
|
- docs/components/image.md
|
||||||
- docs/components/imagegenerationstatus.md
|
- docs/components/imagegenerationstatus.md
|
||||||
- docs/components/imageurl.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
|
||||||
@@ -148,8 +124,6 @@ generatedFiles:
|
|||||||
- docs/components/listendpointsresponse.md
|
- docs/components/listendpointsresponse.md
|
||||||
- docs/components/logprob.md
|
- docs/components/logprob.md
|
||||||
- docs/components/message.md
|
- docs/components/message.md
|
||||||
- docs/components/messagecontent.md
|
|
||||||
- docs/components/messagedeveloper.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
|
||||||
@@ -271,13 +245,6 @@ generatedFiles:
|
|||||||
- docs/components/openresponsesrequestmaxprice.md
|
- docs/components/openresponsesrequestmaxprice.md
|
||||||
- docs/components/openresponsesrequestonly.md
|
- docs/components/openresponsesrequestonly.md
|
||||||
- docs/components/openresponsesrequestorder.md
|
- docs/components/openresponsesrequestorder.md
|
||||||
- docs/components/openresponsesrequestpluginautorouter.md
|
|
||||||
- docs/components/openresponsesrequestpluginfileparser.md
|
|
||||||
- docs/components/openresponsesrequestpluginmoderation.md
|
|
||||||
- docs/components/openresponsesrequestpluginresponsehealing.md
|
|
||||||
- docs/components/openresponsesrequestpluginunion.md
|
|
||||||
- docs/components/openresponsesrequestpluginweb.md
|
|
||||||
- docs/components/openresponsesrequestprovider.md
|
|
||||||
- docs/components/openresponsesrequestsort.md
|
- docs/components/openresponsesrequestsort.md
|
||||||
- docs/components/openresponsesrequesttoolfunction.md
|
- docs/components/openresponsesrequesttoolfunction.md
|
||||||
- docs/components/openresponsesrequesttoolunion.md
|
- docs/components/openresponsesrequesttoolunion.md
|
||||||
@@ -340,11 +307,18 @@ generatedFiles:
|
|||||||
- docs/components/percentilestats.md
|
- docs/components/percentilestats.md
|
||||||
- docs/components/percentilethroughputcutoffs.md
|
- docs/components/percentilethroughputcutoffs.md
|
||||||
- docs/components/perrequestlimits.md
|
- docs/components/perrequestlimits.md
|
||||||
|
- docs/components/plugin.md
|
||||||
|
- docs/components/pluginautorouter.md
|
||||||
|
- docs/components/pluginfileparser.md
|
||||||
|
- docs/components/pluginmoderation.md
|
||||||
|
- docs/components/pluginresponsehealing.md
|
||||||
|
- docs/components/pluginweb.md
|
||||||
- docs/components/preferredmaxlatency.md
|
- docs/components/preferredmaxlatency.md
|
||||||
- docs/components/preferredminthroughput.md
|
- docs/components/preferredminthroughput.md
|
||||||
- docs/components/pricing.md
|
- docs/components/pricing.md
|
||||||
- docs/components/prompt.md
|
- docs/components/prompt.md
|
||||||
- docs/components/prompttokensdetails.md
|
- docs/components/prompttokensdetails.md
|
||||||
|
- docs/components/provider.md
|
||||||
- docs/components/providername.md
|
- docs/components/providername.md
|
||||||
- docs/components/provideroverloadedresponseerrordata.md
|
- docs/components/provideroverloadedresponseerrordata.md
|
||||||
- docs/components/providerpreferences.md
|
- docs/components/providerpreferences.md
|
||||||
@@ -365,7 +339,6 @@ generatedFiles:
|
|||||||
- docs/components/publicendpointquantization.md
|
- docs/components/publicendpointquantization.md
|
||||||
- docs/components/publicpricing.md
|
- docs/components/publicpricing.md
|
||||||
- docs/components/quantization.md
|
- docs/components/quantization.md
|
||||||
- docs/components/quantizations.md
|
|
||||||
- docs/components/reason.md
|
- docs/components/reason.md
|
||||||
- docs/components/reasoning.md
|
- docs/components/reasoning.md
|
||||||
- docs/components/reasoningsummarytext.md
|
- docs/components/reasoningsummarytext.md
|
||||||
@@ -374,7 +347,11 @@ 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/responseformat.md
|
||||||
|
- docs/components/responseformatjsonobject.md
|
||||||
- docs/components/responseformatjsonschema.md
|
- docs/components/responseformatjsonschema.md
|
||||||
|
- docs/components/responseformatpython.md
|
||||||
|
- docs/components/responseformattext.md
|
||||||
- docs/components/responseformattextconfig.md
|
- docs/components/responseformattextconfig.md
|
||||||
- docs/components/responseformattextgrammar.md
|
- docs/components/responseformattextgrammar.md
|
||||||
- docs/components/responseinputaudio.md
|
- docs/components/responseinputaudio.md
|
||||||
@@ -436,17 +413,30 @@ generatedFiles:
|
|||||||
- docs/components/responsetextconfigverbosity.md
|
- docs/components/responsetextconfigverbosity.md
|
||||||
- docs/components/route.md
|
- docs/components/route.md
|
||||||
- docs/components/schema0.md
|
- docs/components/schema0.md
|
||||||
- docs/components/schema0enum.md
|
- docs/components/schema10.md
|
||||||
|
- docs/components/schema14.md
|
||||||
|
- docs/components/schema15.md
|
||||||
|
- docs/components/schema15union.md
|
||||||
|
- docs/components/schema17.md
|
||||||
|
- docs/components/schema17autorouter.md
|
||||||
|
- docs/components/schema17fileparser.md
|
||||||
|
- docs/components/schema17moderation.md
|
||||||
|
- docs/components/schema17responsehealing.md
|
||||||
|
- docs/components/schema17web.md
|
||||||
|
- docs/components/schema19.md
|
||||||
|
- docs/components/schema19reasoningencrypted.md
|
||||||
|
- docs/components/schema19reasoningsummary.md
|
||||||
|
- docs/components/schema19reasoningtext.md
|
||||||
|
- docs/components/schema21.md
|
||||||
- docs/components/schema3.md
|
- docs/components/schema3.md
|
||||||
- docs/components/schema3reasoningencrypted.md
|
|
||||||
- docs/components/schema3reasoningsummary.md
|
|
||||||
- docs/components/schema3reasoningtext.md
|
|
||||||
- docs/components/schema5.md
|
- docs/components/schema5.md
|
||||||
|
- docs/components/schema5enum.md
|
||||||
|
- docs/components/schema8.md
|
||||||
- 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/sortenum.md
|
- docs/components/sortenum.md
|
||||||
- docs/components/streamoptions.md
|
- docs/components/stop.md
|
||||||
- docs/components/systemmessage.md
|
- docs/components/systemmessage.md
|
||||||
- docs/components/systemmessagecontent.md
|
- docs/components/systemmessagecontent.md
|
||||||
- docs/components/tokenizer.md
|
- docs/components/tokenizer.md
|
||||||
@@ -508,73 +498,166 @@ generatedFiles:
|
|||||||
- docs/models/internal/globals.md
|
- docs/models/internal/globals.md
|
||||||
- docs/models/utils/retryconfig.md
|
- docs/models/utils/retryconfig.md
|
||||||
- docs/operations/apitype.md
|
- docs/operations/apitype.md
|
||||||
|
- docs/operations/bulkassignkeystoguardrailglobals.md
|
||||||
|
- docs/operations/bulkassignkeystoguardrailrequest.md
|
||||||
|
- docs/operations/bulkassignkeystoguardrailrequestbody.md
|
||||||
|
- docs/operations/bulkassignkeystoguardrailresponse.md
|
||||||
|
- docs/operations/bulkassignmemberstoguardrailglobals.md
|
||||||
|
- docs/operations/bulkassignmemberstoguardrailrequest.md
|
||||||
|
- docs/operations/bulkassignmemberstoguardrailrequestbody.md
|
||||||
|
- docs/operations/bulkassignmemberstoguardrailresponse.md
|
||||||
|
- docs/operations/bulkunassignkeysfromguardrailglobals.md
|
||||||
|
- docs/operations/bulkunassignkeysfromguardrailrequest.md
|
||||||
|
- docs/operations/bulkunassignkeysfromguardrailrequestbody.md
|
||||||
|
- docs/operations/bulkunassignkeysfromguardrailresponse.md
|
||||||
|
- docs/operations/bulkunassignmembersfromguardrailglobals.md
|
||||||
|
- docs/operations/bulkunassignmembersfromguardrailrequest.md
|
||||||
|
- docs/operations/bulkunassignmembersfromguardrailrequestbody.md
|
||||||
|
- docs/operations/bulkunassignmembersfromguardrailresponse.md
|
||||||
- docs/operations/calldata.md
|
- docs/operations/calldata.md
|
||||||
|
- docs/operations/category.md
|
||||||
- docs/operations/content.md
|
- docs/operations/content.md
|
||||||
- docs/operations/contentimageurl.md
|
- docs/operations/contentimageurl.md
|
||||||
- docs/operations/contenttext.md
|
- docs/operations/contenttext.md
|
||||||
- docs/operations/createauthkeyscodecodechallengemethod.md
|
- docs/operations/createauthkeyscodecodechallengemethod.md
|
||||||
- docs/operations/createauthkeyscodedata.md
|
- docs/operations/createauthkeyscodedata.md
|
||||||
|
- docs/operations/createauthkeyscodeglobals.md
|
||||||
- docs/operations/createauthkeyscoderequest.md
|
- docs/operations/createauthkeyscoderequest.md
|
||||||
|
- docs/operations/createauthkeyscoderequestbody.md
|
||||||
- docs/operations/createauthkeyscoderesponse.md
|
- docs/operations/createauthkeyscoderesponse.md
|
||||||
- docs/operations/createcoinbasechargedata.md
|
- docs/operations/createcoinbasechargedata.md
|
||||||
|
- docs/operations/createcoinbasechargeglobals.md
|
||||||
|
- docs/operations/createcoinbasechargerequest.md
|
||||||
- docs/operations/createcoinbasechargeresponse.md
|
- docs/operations/createcoinbasechargeresponse.md
|
||||||
- docs/operations/createcoinbasechargesecurity.md
|
- docs/operations/createcoinbasechargesecurity.md
|
||||||
- docs/operations/createembeddingsdata.md
|
- docs/operations/createembeddingsdata.md
|
||||||
|
- docs/operations/createembeddingsglobals.md
|
||||||
- docs/operations/createembeddingsrequest.md
|
- docs/operations/createembeddingsrequest.md
|
||||||
|
- docs/operations/createembeddingsrequestbody.md
|
||||||
- docs/operations/createembeddingsresponse.md
|
- docs/operations/createembeddingsresponse.md
|
||||||
- docs/operations/createembeddingsresponsebody.md
|
- docs/operations/createembeddingsresponsebody.md
|
||||||
|
- docs/operations/createguardraildata.md
|
||||||
|
- docs/operations/createguardrailglobals.md
|
||||||
|
- docs/operations/createguardrailrequest.md
|
||||||
|
- docs/operations/createguardrailrequestbody.md
|
||||||
|
- docs/operations/createguardrailresetintervalrequest.md
|
||||||
|
- docs/operations/createguardrailresetintervalresponse.md
|
||||||
|
- docs/operations/createguardrailresponse.md
|
||||||
- docs/operations/createkeysdata.md
|
- docs/operations/createkeysdata.md
|
||||||
|
- docs/operations/createkeysglobals.md
|
||||||
- docs/operations/createkeyslimitreset.md
|
- docs/operations/createkeyslimitreset.md
|
||||||
- docs/operations/createkeysrequest.md
|
- docs/operations/createkeysrequest.md
|
||||||
|
- docs/operations/createkeysrequestbody.md
|
||||||
- docs/operations/createkeysresponse.md
|
- docs/operations/createkeysresponse.md
|
||||||
|
- docs/operations/createresponsesglobals.md
|
||||||
|
- docs/operations/createresponsesrequest.md
|
||||||
- docs/operations/createresponsesresponse.md
|
- docs/operations/createresponsesresponse.md
|
||||||
- docs/operations/createresponsesresponsebody.md
|
- docs/operations/createresponsesresponsebody.md
|
||||||
|
- docs/operations/deleteguardrailglobals.md
|
||||||
|
- docs/operations/deleteguardrailrequest.md
|
||||||
|
- docs/operations/deleteguardrailresponse.md
|
||||||
|
- docs/operations/deletekeysglobals.md
|
||||||
- docs/operations/deletekeysrequest.md
|
- docs/operations/deletekeysrequest.md
|
||||||
- docs/operations/deletekeysresponse.md
|
- docs/operations/deletekeysresponse.md
|
||||||
- docs/operations/embedding.md
|
- docs/operations/embedding.md
|
||||||
- docs/operations/encodingformat.md
|
- docs/operations/encodingformat.md
|
||||||
- docs/operations/exchangeauthcodeforapikeycodechallengemethod.md
|
- docs/operations/exchangeauthcodeforapikeycodechallengemethod.md
|
||||||
|
- docs/operations/exchangeauthcodeforapikeyglobals.md
|
||||||
- docs/operations/exchangeauthcodeforapikeyrequest.md
|
- docs/operations/exchangeauthcodeforapikeyrequest.md
|
||||||
|
- docs/operations/exchangeauthcodeforapikeyrequestbody.md
|
||||||
- docs/operations/exchangeauthcodeforapikeyresponse.md
|
- docs/operations/exchangeauthcodeforapikeyresponse.md
|
||||||
- docs/operations/getcreditsdata.md
|
- docs/operations/getcreditsdata.md
|
||||||
|
- docs/operations/getcreditsglobals.md
|
||||||
|
- docs/operations/getcreditsrequest.md
|
||||||
- docs/operations/getcreditsresponse.md
|
- docs/operations/getcreditsresponse.md
|
||||||
- docs/operations/getcurrentkeydata.md
|
- docs/operations/getcurrentkeydata.md
|
||||||
|
- docs/operations/getcurrentkeyglobals.md
|
||||||
|
- docs/operations/getcurrentkeyrequest.md
|
||||||
- docs/operations/getcurrentkeyresponse.md
|
- docs/operations/getcurrentkeyresponse.md
|
||||||
- docs/operations/getgenerationdata.md
|
- docs/operations/getgenerationdata.md
|
||||||
|
- docs/operations/getgenerationglobals.md
|
||||||
- docs/operations/getgenerationrequest.md
|
- docs/operations/getgenerationrequest.md
|
||||||
- docs/operations/getgenerationresponse.md
|
- docs/operations/getgenerationresponse.md
|
||||||
|
- docs/operations/getguardraildata.md
|
||||||
|
- docs/operations/getguardrailglobals.md
|
||||||
|
- docs/operations/getguardrailrequest.md
|
||||||
|
- docs/operations/getguardrailresetinterval.md
|
||||||
|
- docs/operations/getguardrailresponse.md
|
||||||
- docs/operations/getkeydata.md
|
- docs/operations/getkeydata.md
|
||||||
|
- docs/operations/getkeyglobals.md
|
||||||
- docs/operations/getkeyrequest.md
|
- docs/operations/getkeyrequest.md
|
||||||
- docs/operations/getkeyresponse.md
|
- docs/operations/getkeyresponse.md
|
||||||
|
- docs/operations/getmodelsglobals.md
|
||||||
- docs/operations/getmodelsrequest.md
|
- docs/operations/getmodelsrequest.md
|
||||||
- docs/operations/getparametersdata.md
|
- docs/operations/getuseractivityglobals.md
|
||||||
- docs/operations/getparametersrequest.md
|
|
||||||
- docs/operations/getparametersresponse.md
|
|
||||||
- docs/operations/getparameterssecurity.md
|
|
||||||
- docs/operations/getuseractivityrequest.md
|
- docs/operations/getuseractivityrequest.md
|
||||||
- docs/operations/getuseractivityresponse.md
|
- docs/operations/getuseractivityresponse.md
|
||||||
- docs/operations/imageurl.md
|
- docs/operations/imageurl.md
|
||||||
- docs/operations/input.md
|
- docs/operations/input.md
|
||||||
- docs/operations/inputunion.md
|
- docs/operations/inputunion.md
|
||||||
- docs/operations/listdata.md
|
- docs/operations/listdata.md
|
||||||
|
- docs/operations/listembeddingsmodelsglobals.md
|
||||||
|
- docs/operations/listembeddingsmodelsrequest.md
|
||||||
|
- docs/operations/listendpointsglobals.md
|
||||||
- docs/operations/listendpointsrequest.md
|
- docs/operations/listendpointsrequest.md
|
||||||
- docs/operations/listendpointsresponse.md
|
- docs/operations/listendpointsresponse.md
|
||||||
|
- docs/operations/listendpointszdrglobals.md
|
||||||
|
- docs/operations/listendpointszdrrequest.md
|
||||||
- docs/operations/listendpointszdrresponse.md
|
- docs/operations/listendpointszdrresponse.md
|
||||||
|
- docs/operations/listglobals.md
|
||||||
|
- docs/operations/listguardrailkeyassignmentsdata.md
|
||||||
|
- docs/operations/listguardrailkeyassignmentsglobals.md
|
||||||
|
- docs/operations/listguardrailkeyassignmentsrequest.md
|
||||||
|
- docs/operations/listguardrailkeyassignmentsresponse.md
|
||||||
|
- docs/operations/listguardrailmemberassignmentsdata.md
|
||||||
|
- docs/operations/listguardrailmemberassignmentsglobals.md
|
||||||
|
- docs/operations/listguardrailmemberassignmentsrequest.md
|
||||||
|
- docs/operations/listguardrailmemberassignmentsresponse.md
|
||||||
|
- docs/operations/listguardrailsdata.md
|
||||||
|
- docs/operations/listguardrailsglobals.md
|
||||||
|
- docs/operations/listguardrailsrequest.md
|
||||||
|
- docs/operations/listguardrailsresetinterval.md
|
||||||
|
- docs/operations/listguardrailsresponse.md
|
||||||
|
- docs/operations/listkeyassignmentsdata.md
|
||||||
|
- docs/operations/listkeyassignmentsglobals.md
|
||||||
|
- docs/operations/listkeyassignmentsrequest.md
|
||||||
|
- docs/operations/listkeyassignmentsresponse.md
|
||||||
|
- docs/operations/listmemberassignmentsdata.md
|
||||||
|
- docs/operations/listmemberassignmentsglobals.md
|
||||||
|
- docs/operations/listmemberassignmentsrequest.md
|
||||||
|
- docs/operations/listmemberassignmentsresponse.md
|
||||||
|
- docs/operations/listmodelscountglobals.md
|
||||||
|
- docs/operations/listmodelscountrequest.md
|
||||||
|
- docs/operations/listmodelsuserglobals.md
|
||||||
|
- docs/operations/listmodelsuserrequest.md
|
||||||
- docs/operations/listmodelsusersecurity.md
|
- docs/operations/listmodelsusersecurity.md
|
||||||
- docs/operations/listprovidersdata.md
|
- docs/operations/listprovidersdata.md
|
||||||
|
- docs/operations/listprovidersglobals.md
|
||||||
|
- docs/operations/listprovidersrequest.md
|
||||||
- docs/operations/listprovidersresponse.md
|
- docs/operations/listprovidersresponse.md
|
||||||
- docs/operations/listrequest.md
|
- docs/operations/listrequest.md
|
||||||
- docs/operations/listresponse.md
|
- docs/operations/listresponse.md
|
||||||
- docs/operations/metadata.md
|
- docs/operations/metadata.md
|
||||||
- docs/operations/object.md
|
- docs/operations/object.md
|
||||||
- docs/operations/objectembedding.md
|
- docs/operations/objectembedding.md
|
||||||
|
- docs/operations/providername.md
|
||||||
|
- docs/operations/providerresponse.md
|
||||||
- docs/operations/ratelimit.md
|
- docs/operations/ratelimit.md
|
||||||
|
- docs/operations/sendchatcompletionrequestglobals.md
|
||||||
|
- docs/operations/sendchatcompletionrequestrequest.md
|
||||||
- docs/operations/sendchatcompletionrequestresponse.md
|
- docs/operations/sendchatcompletionrequestresponse.md
|
||||||
- docs/operations/supportedparameter.md
|
|
||||||
- docs/operations/transferintent.md
|
- docs/operations/transferintent.md
|
||||||
- docs/operations/typeimageurl.md
|
- docs/operations/typeimageurl.md
|
||||||
- docs/operations/typetext.md
|
- docs/operations/typetext.md
|
||||||
|
- docs/operations/updateguardraildata.md
|
||||||
|
- docs/operations/updateguardrailglobals.md
|
||||||
|
- docs/operations/updateguardrailrequest.md
|
||||||
|
- docs/operations/updateguardrailrequestbody.md
|
||||||
|
- docs/operations/updateguardrailresetintervalrequest.md
|
||||||
|
- docs/operations/updateguardrailresetintervalresponse.md
|
||||||
|
- docs/operations/updateguardrailresponse.md
|
||||||
- docs/operations/updatekeysdata.md
|
- docs/operations/updatekeysdata.md
|
||||||
|
- docs/operations/updatekeysglobals.md
|
||||||
- docs/operations/updatekeyslimitreset.md
|
- docs/operations/updatekeyslimitreset.md
|
||||||
- docs/operations/updatekeysrequest.md
|
- docs/operations/updatekeysrequest.md
|
||||||
- docs/operations/updatekeysrequestbody.md
|
- docs/operations/updatekeysrequestbody.md
|
||||||
@@ -584,14 +667,13 @@ generatedFiles:
|
|||||||
- docs/sdks/analytics/README.md
|
- docs/sdks/analytics/README.md
|
||||||
- docs/sdks/apikeys/README.md
|
- docs/sdks/apikeys/README.md
|
||||||
- docs/sdks/chat/README.md
|
- docs/sdks/chat/README.md
|
||||||
- docs/sdks/completions/README.md
|
|
||||||
- docs/sdks/credits/README.md
|
- docs/sdks/credits/README.md
|
||||||
- docs/sdks/embeddings/README.md
|
- docs/sdks/embeddings/README.md
|
||||||
- docs/sdks/endpoints/README.md
|
- docs/sdks/endpoints/README.md
|
||||||
- docs/sdks/generations/README.md
|
- docs/sdks/generations/README.md
|
||||||
|
- docs/sdks/guardrails/README.md
|
||||||
- docs/sdks/models/README.md
|
- docs/sdks/models/README.md
|
||||||
- docs/sdks/oauth/README.md
|
- docs/sdks/oauth/README.md
|
||||||
- docs/sdks/parameters/README.md
|
|
||||||
- docs/sdks/providers/README.md
|
- docs/sdks/providers/README.md
|
||||||
- docs/sdks/responses/README.md
|
- docs/sdks/responses/README.md
|
||||||
- py.typed
|
- py.typed
|
||||||
@@ -608,10 +690,12 @@ generatedFiles:
|
|||||||
- src/openrouter/basesdk.py
|
- src/openrouter/basesdk.py
|
||||||
- src/openrouter/beta.py
|
- src/openrouter/beta.py
|
||||||
- src/openrouter/chat.py
|
- src/openrouter/chat.py
|
||||||
- src/openrouter/completions.py
|
|
||||||
- src/openrouter/components/__init__.py
|
- src/openrouter/components/__init__.py
|
||||||
- src/openrouter/components/_schema0.py
|
- src/openrouter/components/_schema10.py
|
||||||
- src/openrouter/components/_schema3.py
|
- src/openrouter/components/_schema14.py
|
||||||
|
- src/openrouter/components/_schema17.py
|
||||||
|
- src/openrouter/components/_schema19.py
|
||||||
|
- src/openrouter/components/_schema5.py
|
||||||
- src/openrouter/components/activityitem.py
|
- src/openrouter/components/activityitem.py
|
||||||
- src/openrouter/components/assistantmessage.py
|
- src/openrouter/components/assistantmessage.py
|
||||||
- src/openrouter/components/badgatewayresponseerrordata.py
|
- src/openrouter/components/badgatewayresponseerrordata.py
|
||||||
@@ -636,14 +720,10 @@ 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/completionchoice.py
|
|
||||||
- src/openrouter/components/completioncreateparams.py
|
|
||||||
- src/openrouter/components/completionlogprobs.py
|
|
||||||
- src/openrouter/components/completionresponse.py
|
|
||||||
- src/openrouter/components/completionusage.py
|
|
||||||
- src/openrouter/components/createchargerequest.py
|
- src/openrouter/components/createchargerequest.py
|
||||||
- src/openrouter/components/datacollection.py
|
- src/openrouter/components/datacollection.py
|
||||||
- src/openrouter/components/defaultparameters.py
|
- src/openrouter/components/defaultparameters.py
|
||||||
|
- src/openrouter/components/developermessage.py
|
||||||
- src/openrouter/components/edgenetworktimeoutresponseerrordata.py
|
- src/openrouter/components/edgenetworktimeoutresponseerrordata.py
|
||||||
- src/openrouter/components/endpointstatus.py
|
- src/openrouter/components/endpointstatus.py
|
||||||
- src/openrouter/components/filecitation.py
|
- src/openrouter/components/filecitation.py
|
||||||
@@ -793,6 +873,7 @@ generatedFiles:
|
|||||||
- src/openrouter/errors/unauthorizedresponse_error.py
|
- src/openrouter/errors/unauthorizedresponse_error.py
|
||||||
- src/openrouter/errors/unprocessableentityresponse_error.py
|
- src/openrouter/errors/unprocessableentityresponse_error.py
|
||||||
- src/openrouter/generations.py
|
- src/openrouter/generations.py
|
||||||
|
- src/openrouter/guardrails.py
|
||||||
- src/openrouter/httpclient.py
|
- src/openrouter/httpclient.py
|
||||||
- src/openrouter/models/__init__.py
|
- src/openrouter/models/__init__.py
|
||||||
- src/openrouter/models/internal/__init__.py
|
- src/openrouter/models/internal/__init__.py
|
||||||
@@ -800,28 +881,41 @@ generatedFiles:
|
|||||||
- src/openrouter/models_.py
|
- src/openrouter/models_.py
|
||||||
- src/openrouter/oauth.py
|
- src/openrouter/oauth.py
|
||||||
- src/openrouter/operations/__init__.py
|
- src/openrouter/operations/__init__.py
|
||||||
|
- src/openrouter/operations/bulkassignkeystoguardrail.py
|
||||||
|
- src/openrouter/operations/bulkassignmemberstoguardrail.py
|
||||||
|
- src/openrouter/operations/bulkunassignkeysfromguardrail.py
|
||||||
|
- src/openrouter/operations/bulkunassignmembersfromguardrail.py
|
||||||
- src/openrouter/operations/createauthkeyscode.py
|
- src/openrouter/operations/createauthkeyscode.py
|
||||||
- src/openrouter/operations/createcoinbasecharge.py
|
- src/openrouter/operations/createcoinbasecharge.py
|
||||||
- src/openrouter/operations/createembeddings.py
|
- src/openrouter/operations/createembeddings.py
|
||||||
|
- src/openrouter/operations/createguardrail.py
|
||||||
- src/openrouter/operations/createkeys.py
|
- src/openrouter/operations/createkeys.py
|
||||||
- src/openrouter/operations/createresponses.py
|
- src/openrouter/operations/createresponses.py
|
||||||
|
- src/openrouter/operations/deleteguardrail.py
|
||||||
- src/openrouter/operations/deletekeys.py
|
- src/openrouter/operations/deletekeys.py
|
||||||
- src/openrouter/operations/exchangeauthcodeforapikey.py
|
- src/openrouter/operations/exchangeauthcodeforapikey.py
|
||||||
- src/openrouter/operations/getcredits.py
|
- src/openrouter/operations/getcredits.py
|
||||||
- src/openrouter/operations/getcurrentkey.py
|
- src/openrouter/operations/getcurrentkey.py
|
||||||
- src/openrouter/operations/getgeneration.py
|
- src/openrouter/operations/getgeneration.py
|
||||||
|
- src/openrouter/operations/getguardrail.py
|
||||||
- src/openrouter/operations/getkey.py
|
- src/openrouter/operations/getkey.py
|
||||||
- src/openrouter/operations/getmodels.py
|
- src/openrouter/operations/getmodels.py
|
||||||
- src/openrouter/operations/getparameters.py
|
|
||||||
- src/openrouter/operations/getuseractivity.py
|
- src/openrouter/operations/getuseractivity.py
|
||||||
- src/openrouter/operations/list.py
|
- src/openrouter/operations/list.py
|
||||||
|
- src/openrouter/operations/listembeddingsmodels.py
|
||||||
- src/openrouter/operations/listendpoints.py
|
- src/openrouter/operations/listendpoints.py
|
||||||
- src/openrouter/operations/listendpointszdr.py
|
- src/openrouter/operations/listendpointszdr.py
|
||||||
|
- src/openrouter/operations/listguardrailkeyassignments.py
|
||||||
|
- src/openrouter/operations/listguardrailmemberassignments.py
|
||||||
|
- src/openrouter/operations/listguardrails.py
|
||||||
|
- src/openrouter/operations/listkeyassignments.py
|
||||||
|
- src/openrouter/operations/listmemberassignments.py
|
||||||
|
- src/openrouter/operations/listmodelscount.py
|
||||||
- src/openrouter/operations/listmodelsuser.py
|
- src/openrouter/operations/listmodelsuser.py
|
||||||
- src/openrouter/operations/listproviders.py
|
- src/openrouter/operations/listproviders.py
|
||||||
- src/openrouter/operations/sendchatcompletionrequest.py
|
- src/openrouter/operations/sendchatcompletionrequest.py
|
||||||
|
- src/openrouter/operations/updateguardrail.py
|
||||||
- src/openrouter/operations/updatekeys.py
|
- src/openrouter/operations/updatekeys.py
|
||||||
- src/openrouter/parameters.py
|
|
||||||
- src/openrouter/providers.py
|
- src/openrouter/providers.py
|
||||||
- src/openrouter/py.typed
|
- src/openrouter/py.typed
|
||||||
- src/openrouter/responses.py
|
- src/openrouter/responses.py
|
||||||
@@ -966,7 +1060,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"}}
|
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": []}}
|
||||||
"401":
|
"401":
|
||||||
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
"402":
|
"402":
|
||||||
@@ -1008,6 +1102,8 @@ 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"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
listEndpoints:
|
listEndpoints:
|
||||||
speakeasy-default-list-endpoints:
|
speakeasy-default-list-endpoints:
|
||||||
parameters:
|
parameters:
|
||||||
@@ -1016,7 +1112,7 @@ examples:
|
|||||||
slug: "<value>"
|
slug: "<value>"
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
application/json: {"data": {"id": "openai/gpt-4", "name": "GPT-4", "created": 1692901234, "description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.", "architecture": {"tokenizer": "GPT", "instruct_type": "chatml", "modality": "text->text", "input_modalities": ["text"], "output_modalities": ["text"]}, "endpoints": [{"name": "OpenAI: GPT-4", "model_name": "GPT-4", "context_length": 8192, "pricing": {"prompt": "0.00003", "completion": "0.00006"}, "provider_name": "OpenAI", "tag": "openai", "quantization": "fp16", "max_completion_tokens": 4096, "max_prompt_tokens": 8192, "supported_parameters": ["temperature", "top_p", "max_tokens", "frequency_penalty", "presence_penalty"], "uptime_last_30m": 99.5, "supports_implicit_caching": true, "latency_last_30m": {"p50": 0.25, "p75": 0.35, "p90": 0.48, "p99": 0.85}, "throughput_last_30m": {"p50": 45.2, "p75": 38.5, "p90": 28.3, "p99": 15.1}}]}}
|
application/json: {"data": {"id": "openai/gpt-4", "name": "GPT-4", "created": 1692901234, "description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.", "architecture": {"tokenizer": "GPT", "instruct_type": "chatml", "modality": "text->text", "input_modalities": ["text"], "output_modalities": ["text"]}, "endpoints": [{"name": "OpenAI: GPT-4", "model_id": "openai/gpt-4", "model_name": "GPT-4", "context_length": 8192, "pricing": {"prompt": "0.00003", "completion": "0.00006"}, "provider_name": "OpenAI", "tag": "openai", "quantization": "fp16", "max_completion_tokens": 4096, "max_prompt_tokens": 8192, "supported_parameters": ["temperature", "top_p", "max_tokens", "frequency_penalty", "presence_penalty"], "uptime_last_30m": 99.5, "supports_implicit_caching": true, "latency_last_30m": {"p50": 0.25, "p75": 0.35, "p90": 0.48, "p99": 0.85}, "throughput_last_30m": {"p50": 45.2, "p75": 38.5, "p90": 28.3, "p99": 15.1}}]}}
|
||||||
"404":
|
"404":
|
||||||
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
"500":
|
"500":
|
||||||
@@ -1025,7 +1121,7 @@ examples:
|
|||||||
speakeasy-default-list-endpoints-zdr:
|
speakeasy-default-list-endpoints-zdr:
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
application/json: {"data": [{"name": "OpenAI: GPT-4", "model_name": "GPT-4", "context_length": 8192, "pricing": {"prompt": "0.00003", "completion": "0.00006"}, "provider_name": "OpenAI", "tag": "openai", "quantization": "fp16", "max_completion_tokens": 4096, "max_prompt_tokens": 8192, "supported_parameters": ["temperature", "top_p", "max_tokens"], "uptime_last_30m": 99.5, "supports_implicit_caching": true, "latency_last_30m": {"p50": 25.5, "p75": 35.2, "p90": 48.7, "p99": 85.3}, "throughput_last_30m": {"p50": 25.5, "p75": 35.2, "p90": 48.7, "p99": 85.3}}]}
|
application/json: {"data": [{"name": "OpenAI: GPT-4", "model_id": "openai/gpt-4", "model_name": "GPT-4", "context_length": 8192, "pricing": {"prompt": "0.00003", "completion": "0.00006"}, "provider_name": "OpenAI", "tag": "openai", "quantization": "fp16", "max_completion_tokens": 4096, "max_prompt_tokens": 8192, "supported_parameters": ["temperature", "top_p", "max_tokens"], "uptime_last_30m": 99.5, "supports_implicit_caching": true, "latency_last_30m": {"p50": 25.5, "p75": 35.2, "p90": 48.7, "p99": 85.3}, "throughput_last_30m": {"p50": 25.5, "p75": 35.2, "p90": 48.7, "p99": 85.3}}]}
|
||||||
"500":
|
"500":
|
||||||
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
getParameters:
|
getParameters:
|
||||||
@@ -1058,7 +1154,7 @@ examples:
|
|||||||
offset: "0"
|
offset: "0"
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
application/json: {"data": [{"hash": "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", "name": "My Production Key", "label": "Production API Key", "disabled": false, "limit": 100, "limit_remaining": 74.5, "limit_reset": "monthly", "include_byok_in_limit": false, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "created_at": "2025-08-24T10:30:00Z", "updated_at": "2025-08-24T15:45:00Z"}]}
|
application/json: {"data": [{"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", "name": "My Production Key", "label": "Production API Key", "disabled": false, "limit": 100, "limit_remaining": 74.5, "limit_reset": "monthly", "include_byok_in_limit": false, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "created_at": "2025-08-24T10:30:00Z", "updated_at": "2025-08-24T15:45:00Z"}]}
|
||||||
"401":
|
"401":
|
||||||
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
"429":
|
"429":
|
||||||
@@ -1071,7 +1167,7 @@ examples:
|
|||||||
application/json: {"name": "My New API Key"}
|
application/json: {"name": "My New API Key"}
|
||||||
responses:
|
responses:
|
||||||
"201":
|
"201":
|
||||||
application/json: {"data": {"hash": "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", "name": "My New API Key", "label": "My New API Key", "disabled": false, "limit": 50, "limit_remaining": 50, "limit_reset": "monthly", "include_byok_in_limit": true, "usage": 0, "usage_daily": 0, "usage_weekly": 0, "usage_monthly": 0, "byok_usage": 0, "byok_usage_daily": 0, "byok_usage_weekly": 0, "byok_usage_monthly": 0, "created_at": "2025-08-24T10:30:00Z", "updated_at": null}, "key": "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"}
|
application/json: {"data": {"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", "name": "My New API Key", "label": "My New API Key", "disabled": false, "limit": 50, "limit_remaining": 50, "limit_reset": "monthly", "include_byok_in_limit": true, "usage": 0, "usage_daily": 0, "usage_weekly": 0, "usage_monthly": 0, "byok_usage": 0, "byok_usage_daily": 0, "byok_usage_weekly": 0, "byok_usage_monthly": 0, "created_at": "2025-08-24T10:30:00Z", "updated_at": null}, "key": "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"}
|
||||||
"400":
|
"400":
|
||||||
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
||||||
"401":
|
"401":
|
||||||
@@ -1084,12 +1180,12 @@ examples:
|
|||||||
speakeasy-default-update-keys:
|
speakeasy-default-update-keys:
|
||||||
parameters:
|
parameters:
|
||||||
path:
|
path:
|
||||||
hash: "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"
|
hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
|
||||||
requestBody:
|
requestBody:
|
||||||
application/json: {}
|
application/json: {}
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
application/json: {"data": {"hash": "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", "name": "Updated API Key Name", "label": "Updated API Key Name", "disabled": false, "limit": 75, "limit_remaining": 49.5, "limit_reset": "daily", "include_byok_in_limit": true, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "created_at": "2025-08-24T10:30:00Z", "updated_at": "2025-08-24T16:00:00Z"}}
|
application/json: {"data": {"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", "name": "Updated API Key Name", "label": "Updated API Key Name", "disabled": false, "limit": 75, "limit_remaining": 49.5, "limit_reset": "daily", "include_byok_in_limit": true, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "created_at": "2025-08-24T10:30:00Z", "updated_at": "2025-08-24T16:00:00Z"}}
|
||||||
"400":
|
"400":
|
||||||
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
||||||
"401":
|
"401":
|
||||||
@@ -1104,7 +1200,7 @@ examples:
|
|||||||
speakeasy-default-delete-keys:
|
speakeasy-default-delete-keys:
|
||||||
parameters:
|
parameters:
|
||||||
path:
|
path:
|
||||||
hash: "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"
|
hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
application/json: {"deleted": true}
|
application/json: {"deleted": true}
|
||||||
@@ -1120,10 +1216,10 @@ examples:
|
|||||||
speakeasy-default-get-key:
|
speakeasy-default-get-key:
|
||||||
parameters:
|
parameters:
|
||||||
path:
|
path:
|
||||||
hash: "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"
|
hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
application/json: {"data": {"hash": "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", "name": "My Production Key", "label": "Production API Key", "disabled": false, "limit": 100, "limit_remaining": 74.5, "limit_reset": "monthly", "include_byok_in_limit": false, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "created_at": "2025-08-24T10:30:00Z", "updated_at": "2025-08-24T15:45:00Z"}}
|
application/json: {"data": {"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", "name": "My Production Key", "label": "Production API Key", "disabled": false, "limit": 100, "limit_remaining": 74.5, "limit_reset": "monthly", "include_byok_in_limit": false, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "created_at": "2025-08-24T10:30:00Z", "updated_at": "2025-08-24T15:45:00Z"}}
|
||||||
"401":
|
"401":
|
||||||
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
"404":
|
"404":
|
||||||
@@ -1136,7 +1232,7 @@ examples:
|
|||||||
speakeasy-default-get-current-key:
|
speakeasy-default-get-current-key:
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
application/json: {"data": {"label": "sk-or-v1-au78b3456789012345678901234567890", "limit": 100, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "is_free_tier": false, "is_provisioning_key": false, "limit_remaining": 74.5, "limit_reset": "monthly", "include_byok_in_limit": false, "rate_limit": {"requests": 1000, "interval": "1h", "note": "This field is deprecated and safe to ignore."}}}
|
application/json: {"data": {"label": "sk-or-v1-au7...890", "limit": 100, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "is_free_tier": false, "is_provisioning_key": false, "limit_remaining": 74.5, "limit_reset": "monthly", "include_byok_in_limit": false, "rate_limit": {"requests": 1000, "interval": "1h", "note": "This field is deprecated and safe to ignore."}}}
|
||||||
"401":
|
"401":
|
||||||
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
"500":
|
"500":
|
||||||
@@ -1189,4 +1285,190 @@ examples:
|
|||||||
application/json: {"error": {"code": "<value>", "message": "<value>"}}
|
application/json: {"error": {"code": "<value>", "message": "<value>"}}
|
||||||
"500":
|
"500":
|
||||||
application/json: {"error": {"code": "<value>", "message": "<value>"}}
|
application/json: {"error": {"code": "<value>", "message": "<value>"}}
|
||||||
|
listGuardrails:
|
||||||
|
speakeasy-default-list-guardrails:
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"data": [{"id": "550e8400-e29b-41d4-a716-446655440000", "name": "Production Guardrail", "created_at": "2025-08-24T10:30:00Z"}], "total_count": 1}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
createGuardrail:
|
||||||
|
speakeasy-default-create-guardrail:
|
||||||
|
requestBody:
|
||||||
|
application/json: {"name": "My New Guardrail"}
|
||||||
|
responses:
|
||||||
|
"201":
|
||||||
|
application/json: {"data": {"id": "550e8400-e29b-41d4-a716-446655440000", "name": "My New Guardrail", "created_at": "2025-08-24T10:30:00Z"}}
|
||||||
|
"400":
|
||||||
|
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
getGuardrail:
|
||||||
|
speakeasy-default-get-guardrail:
|
||||||
|
parameters:
|
||||||
|
path:
|
||||||
|
id: "550e8400-e29b-41d4-a716-446655440000"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"data": {"id": "550e8400-e29b-41d4-a716-446655440000", "name": "Production Guardrail", "created_at": "2025-08-24T10:30:00Z"}}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
updateGuardrail:
|
||||||
|
speakeasy-default-update-guardrail:
|
||||||
|
parameters:
|
||||||
|
path:
|
||||||
|
id: "550e8400-e29b-41d4-a716-446655440000"
|
||||||
|
requestBody:
|
||||||
|
application/json: {}
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"data": {"id": "550e8400-e29b-41d4-a716-446655440000", "name": "Updated Guardrail Name", "created_at": "2025-08-24T10:30:00Z"}}
|
||||||
|
"400":
|
||||||
|
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
deleteGuardrail:
|
||||||
|
speakeasy-default-delete-guardrail:
|
||||||
|
parameters:
|
||||||
|
path:
|
||||||
|
id: "550e8400-e29b-41d4-a716-446655440000"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"deleted": true}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
listKeyAssignments:
|
||||||
|
speakeasy-default-list-key-assignments:
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"data": [{"id": "550e8400-e29b-41d4-a716-446655440000", "key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", "guardrail_id": "550e8400-e29b-41d4-a716-446655440001", "key_name": "Production Key", "key_label": "prod-key", "assigned_by": "user_abc123", "created_at": "2025-08-24T10:30:00Z"}], "total_count": 25}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
listMemberAssignments:
|
||||||
|
speakeasy-default-list-member-assignments:
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"data": [{"id": "550e8400-e29b-41d4-a716-446655440000", "user_id": "user_abc123", "organization_id": "org_xyz789", "guardrail_id": "550e8400-e29b-41d4-a716-446655440001", "assigned_by": "user_abc123", "created_at": "2025-08-24T10:30:00Z"}], "total_count": 10}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
listGuardrailKeyAssignments:
|
||||||
|
speakeasy-default-list-guardrail-key-assignments:
|
||||||
|
parameters:
|
||||||
|
path:
|
||||||
|
id: "550e8400-e29b-41d4-a716-446655440000"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"data": [], "total_count": 25}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
bulkAssignKeysToGuardrail:
|
||||||
|
speakeasy-default-bulk-assign-keys-to-guardrail:
|
||||||
|
parameters:
|
||||||
|
path:
|
||||||
|
id: "550e8400-e29b-41d4-a716-446655440000"
|
||||||
|
requestBody:
|
||||||
|
application/json: {"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"assigned_count": 3}
|
||||||
|
"400":
|
||||||
|
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
listGuardrailMemberAssignments:
|
||||||
|
speakeasy-default-list-guardrail-member-assignments:
|
||||||
|
parameters:
|
||||||
|
path:
|
||||||
|
id: "550e8400-e29b-41d4-a716-446655440000"
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"data": [{"id": "550e8400-e29b-41d4-a716-446655440000", "user_id": "user_abc123", "organization_id": "org_xyz789", "guardrail_id": "550e8400-e29b-41d4-a716-446655440001", "assigned_by": "user_abc123", "created_at": "2025-08-24T10:30:00Z"}], "total_count": 10}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
bulkAssignMembersToGuardrail:
|
||||||
|
speakeasy-default-bulk-assign-members-to-guardrail:
|
||||||
|
parameters:
|
||||||
|
path:
|
||||||
|
id: "550e8400-e29b-41d4-a716-446655440000"
|
||||||
|
requestBody:
|
||||||
|
application/json: {"member_user_ids": ["user_abc123", "user_def456"]}
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"assigned_count": 2}
|
||||||
|
"400":
|
||||||
|
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
bulkUnassignKeysFromGuardrail:
|
||||||
|
speakeasy-default-bulk-unassign-keys-from-guardrail:
|
||||||
|
parameters:
|
||||||
|
path:
|
||||||
|
id: "550e8400-e29b-41d4-a716-446655440000"
|
||||||
|
requestBody:
|
||||||
|
application/json: {"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"unassigned_count": 3}
|
||||||
|
"400":
|
||||||
|
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
|
bulkUnassignMembersFromGuardrail:
|
||||||
|
speakeasy-default-bulk-unassign-members-from-guardrail:
|
||||||
|
parameters:
|
||||||
|
path:
|
||||||
|
id: "550e8400-e29b-41d4-a716-446655440000"
|
||||||
|
requestBody:
|
||||||
|
application/json: {"member_user_ids": ["user_abc123", "user_def456"]}
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
application/json: {"unassigned_count": 2}
|
||||||
|
"400":
|
||||||
|
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
|
||||||
|
"401":
|
||||||
|
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
|
||||||
|
"404":
|
||||||
|
application/json: {"error": {"code": 404, "message": "Resource not found"}}
|
||||||
|
"500":
|
||||||
|
application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
|
||||||
examplesVersion: 1.0.2
|
examplesVersion: 1.0.2
|
||||||
|
|||||||
+1
-1
@@ -31,7 +31,7 @@ generation:
|
|||||||
skipResponseBodyAssertions: false
|
skipResponseBodyAssertions: false
|
||||||
preApplyUnionDiscriminators: true
|
preApplyUnionDiscriminators: true
|
||||||
python:
|
python:
|
||||||
version: 0.0.18
|
version: 0.5.1
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dev: {}
|
dev: {}
|
||||||
main: {}
|
main: {}
|
||||||
|
|||||||
+5462
-764
File diff suppressed because it is too large
Load Diff
+5539
-755
File diff suppressed because it is too large
Load Diff
@@ -33,3 +33,11 @@ actions:
|
|||||||
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.
|
||||||
|
|
||||||
|
# Add header parameters to all paths so Speakeasy matches them with globals
|
||||||
|
- target: $.paths[*]
|
||||||
|
description: Reference app identification headers on all paths so Speakeasy injects them via globals
|
||||||
|
update:
|
||||||
|
parameters:
|
||||||
|
- $ref: "#/components/parameters/AppIdentifier"
|
||||||
|
- $ref: "#/components/parameters/AppDisplayName"
|
||||||
|
|||||||
@@ -8,19 +8,20 @@ sources:
|
|||||||
- latest
|
- latest
|
||||||
OpenRouter API:
|
OpenRouter API:
|
||||||
sourceNamespace: open-router-chat-completions-api
|
sourceNamespace: open-router-chat-completions-api
|
||||||
sourceRevisionDigest: sha256:74aa60ddccc9442b797432138c9ea1577f922ae537a659f129b4102d3a8124d7
|
sourceRevisionDigest: sha256:9d0580abfbe319bbd1e3d51fa921b5c97134ae4ef84ee4b1254beb0e92bf4fd9
|
||||||
sourceBlobDigest: sha256:c9ae686141914431fb09ce7f0ff685c5b20c19006a92ade6d8686358616f6925
|
sourceBlobDigest: sha256:8555ff45ab0e3c22ae07af40cc4581ef14107b4d62c38bde3c25512fd4aae199
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
|
- main
|
||||||
- 1.0.0
|
- 1.0.0
|
||||||
targets:
|
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:74aa60ddccc9442b797432138c9ea1577f922ae537a659f129b4102d3a8124d7
|
sourceRevisionDigest: sha256:9d0580abfbe319bbd1e3d51fa921b5c97134ae4ef84ee4b1254beb0e92bf4fd9
|
||||||
sourceBlobDigest: sha256:c9ae686141914431fb09ce7f0ff685c5b20c19006a92ade6d8686358616f6925
|
sourceBlobDigest: sha256:8555ff45ab0e3c22ae07af40cc4581ef14107b4d62c38bde3c25512fd4aae199
|
||||||
codeSamplesNamespace: open-router-python-code-samples
|
codeSamplesNamespace: open-router-python-code-samples
|
||||||
codeSamplesRevisionDigest: sha256:95a78f7dc072063abfd68a880ad1054c27a9a9077449cbf667d07de13a15112a
|
codeSamplesRevisionDigest: sha256:e44fdec134bc5f249b3e785da067ea31d1bba8f9891bca0f6c19d7ace670ab11
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: 1.666.0
|
speakeasyVersion: 1.666.0
|
||||||
|
|||||||
@@ -182,6 +182,8 @@ import os
|
|||||||
def main():
|
def main():
|
||||||
|
|
||||||
with OpenRouter(
|
with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_title="<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...
|
||||||
@@ -191,6 +193,8 @@ def main():
|
|||||||
async def amain():
|
async def amain():
|
||||||
|
|
||||||
async with OpenRouter(
|
async with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_title="<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...
|
||||||
|
|||||||
@@ -6,6 +6,8 @@ import os
|
|||||||
|
|
||||||
|
|
||||||
with OpenRouter(
|
with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_title="<value>",
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
|
|
||||||
@@ -30,6 +32,8 @@ import os
|
|||||||
async def main():
|
async def main():
|
||||||
|
|
||||||
async with OpenRouter(
|
async with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_title="<value>",
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
|
|
||||||
|
|||||||
@@ -10,4 +10,6 @@
|
|||||||
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
| `tool_calls` | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)] | :heavy_minus_sign: | N/A |
|
| `tool_calls` | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)] | :heavy_minus_sign: | N/A |
|
||||||
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
||||||
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `reasoning_details` | List[[components.Schema19](../components/schema19.md)] | :heavy_minus_sign: | N/A |
|
||||||
|
| `images` | List[[components.Image](../components/image.md)] | :heavy_minus_sign: | N/A |
|
||||||
+2
-2
@@ -1,8 +1,8 @@
|
|||||||
# GetParametersSecurity
|
# AssistantMessageImageURL
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `bearer` | *str* | :heavy_check_mark: | N/A |
|
| `url` | *str* | :heavy_check_mark: | N/A |
|
||||||
@@ -3,34 +3,34 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
| `provider` | [OptionalNullable[components.ChatGenerationParamsProvider]](../components/chatgenerationparamsprovider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. |
|
| `provider` | [OptionalNullable[components.Schema0]](../components/schema0.md) | :heavy_minus_sign: | N/A |
|
||||||
| `plugins` | List[[components.ChatGenerationParamsPluginUnion](../components/chatgenerationparamspluginunion.md)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. |
|
| `plugins` | List[[components.Schema17](../components/schema17.md)] | :heavy_minus_sign: | N/A |
|
||||||
| `route` | [OptionalNullable[components.Route]](../components/route.md) | :heavy_minus_sign: | N/A |
|
| `route` | [OptionalNullable[components.Route]](../components/route.md) | :heavy_minus_sign: | N/A |
|
||||||
| `user` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
| `user` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
| `session_id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters. |
|
| `session_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
| `messages` | List[[components.Message](../components/message.md)] | :heavy_check_mark: | N/A |
|
| `messages` | List[[components.Message](../components/message.md)] | :heavy_check_mark: | N/A |
|
||||||
| `model` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
| `model` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
| `models` | List[*str*] | :heavy_minus_sign: | N/A |
|
| `models` | List[*str*] | :heavy_minus_sign: | N/A |
|
||||||
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | N/A |
|
| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | N/A |
|
||||||
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
||||||
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | N/A |
|
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | N/A |
|
||||||
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
| `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | N/A |
|
| `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | N/A |
|
||||||
| `response_format` | [Optional[components.ChatGenerationParamsResponseFormatUnion]](../components/chatgenerationparamsresponseformatunion.md) | :heavy_minus_sign: | N/A |
|
| `response_format` | [Optional[components.ResponseFormat]](../components/responseformat.md) | :heavy_minus_sign: | N/A |
|
||||||
| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
|
| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
|
||||||
| `stop` | [OptionalNullable[components.ChatGenerationParamsStop]](../components/chatgenerationparamsstop.md) | :heavy_minus_sign: | N/A |
|
| `stop` | [OptionalNullable[components.Stop]](../components/stop.md) | :heavy_minus_sign: | N/A |
|
||||||
| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
||||||
| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.md) | :heavy_minus_sign: | N/A |
|
| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.md) | :heavy_minus_sign: | N/A |
|
||||||
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
| `tool_choice` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
| `tool_choice` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
||||||
| `tools` | List[[components.ToolDefinitionJSON](../components/tooldefinitionjson.md)] | :heavy_minus_sign: | N/A |
|
| `tools` | List[[components.ToolDefinitionJSON](../components/tooldefinitionjson.md)] | :heavy_minus_sign: | N/A |
|
||||||
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
| `debug` | [Optional[components.Debug]](../components/debug.md) | :heavy_minus_sign: | N/A |
|
| `debug` | [Optional[components.Debug]](../components/debug.md) | :heavy_minus_sign: | N/A |
|
||||||
| `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](../components/chatgenerationparamsimageconfig.md)] | :heavy_minus_sign: | N/A |
|
| `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](../components/chatgenerationparamsimageconfig.md)] | :heavy_minus_sign: | N/A |
|
||||||
| `modalities` | List[[components.Modality](../components/modality.md)] | :heavy_minus_sign: | N/A |
|
| `modalities` | List[[components.Modality](../components/modality.md)] | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatGenerationParamsDataCollection
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------- | ------- |
|
|
||||||
| `DENY` | deny |
|
|
||||||
| `ALLOW` | allow |
|
|
||||||
@@ -15,3 +15,9 @@ value: str = /* values here */
|
|||||||
value: float = /* values here */
|
value: float = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### `List[Any]`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: List[Any] = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -1,14 +0,0 @@
|
|||||||
# ChatGenerationParamsMaxPrice
|
|
||||||
|
|
||||||
The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `prompt` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `completion` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `image` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `audio` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `request` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
# ChatGenerationParamsPluginUnion
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginAutoRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginAutoRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginModeration`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginModeration = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginWeb`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginWeb = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginFileParser`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginFileParser = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginResponseHealing`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginResponseHealing = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# ChatGenerationParamsPreferredMaxLatencyUnion
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `float`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: float = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPreferredMaxLatency`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPreferredMaxLatency = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ChatGenerationParamsPreferredMinThroughput
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
|
||||||
| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# ChatGenerationParamsPreferredMinThroughputUnion
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `float`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: float = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPreferredMinThroughput`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPreferredMinThroughput = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
# ChatGenerationParamsProvider
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `allow_fallbacks` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to allow backup providers to serve requests<br/>- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.<br/>- false: use only the primary/custom provider, and return the upstream error if it's unavailable.<br/> |
|
|
||||||
| `require_parameters` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. |
|
|
||||||
| `data_collection` | [OptionalNullable[components.ChatGenerationParamsDataCollection]](../components/chatgenerationparamsdatacollection.md) | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.<br/>- allow: (default) allow providers which store user data non-transiently and may train on it<br/><br/>- deny: use only providers which do not collect user data. |
|
|
||||||
| `zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `enforce_distillable_text` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `order` | List[[components.Schema0](../components/schema0.md)] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. |
|
|
||||||
| `only` | List[[components.Schema0](../components/schema0.md)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. |
|
|
||||||
| `ignore` | List[[components.Schema0](../components/schema0.md)] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. |
|
|
||||||
| `quantizations` | List[[components.Quantizations](../components/quantizations.md)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. |
|
|
||||||
| `sort` | [OptionalNullable[components.ProviderSortUnion]](../components/providersortunion.md) | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. |
|
|
||||||
| `max_price` | [Optional[components.ChatGenerationParamsMaxPrice]](../components/chatgenerationparamsmaxprice.md) | :heavy_minus_sign: | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. |
|
|
||||||
| `preferred_min_throughput` | [OptionalNullable[components.ChatGenerationParamsPreferredMinThroughputUnion]](../components/chatgenerationparamspreferredminthroughputunion.md) | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. |
|
|
||||||
| `preferred_max_latency` | [OptionalNullable[components.ChatGenerationParamsPreferredMaxLatencyUnion]](../components/chatgenerationparamspreferredmaxlatencyunion.md) | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. |
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
# ChatGenerationParamsResponseFormatUnion
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsResponseFormatText`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsResponseFormatText = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsResponseFormatJSONObject`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsResponseFormatJSONObject = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ResponseFormatJSONSchema`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ResponseFormatJSONSchema = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ResponseFormatTextGrammar`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ResponseFormatTextGrammar = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsResponseFormatPython`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsResponseFormatPython = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
| `type` | *Literal["image_url"]* | :heavy_check_mark: | N/A |
|
| `type` | *Literal["image_url"]* | :heavy_check_mark: | N/A |
|
||||||
| `image_url` | [components.ImageURL](../components/imageurl.md) | :heavy_check_mark: | N/A |
|
| `image_url` | [components.ChatMessageContentItemImageImageURL](../components/chatmessagecontentitemimageimageurl.md) | :heavy_check_mark: | N/A |
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# ImageURL
|
# ChatMessageContentItemImageImageURL
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -8,5 +8,4 @@
|
|||||||
| `finish_reason` | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md) | :heavy_check_mark: | N/A |
|
| `finish_reason` | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md) | :heavy_check_mark: | N/A |
|
||||||
| `index` | *float* | :heavy_check_mark: | N/A |
|
| `index` | *float* | :heavy_check_mark: | N/A |
|
||||||
| `message` | [components.AssistantMessage](../components/assistantmessage.md) | :heavy_check_mark: | N/A |
|
| `message` | [components.AssistantMessage](../components/assistantmessage.md) | :heavy_check_mark: | N/A |
|
||||||
| `reasoning_details` | List[[components.Schema3](../components/schema3.md)] | :heavy_minus_sign: | N/A |
|
|
||||||
| `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | N/A |
|
| `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -10,4 +10,4 @@
|
|||||||
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
||||||
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
||||||
| `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | N/A |
|
| `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | N/A |
|
||||||
| `reasoning_details` | List[[components.Schema3](../components/schema3.md)] | :heavy_minus_sign: | N/A |
|
| `reasoning_details` | List[[components.Schema19](../components/schema19.md)] | :heavy_minus_sign: | N/A |
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Completion
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `float`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: float = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `str`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: str = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `Any`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: Any = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
# CompletionChoice
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `text` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `index` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `logprobs` | [Nullable[components.CompletionLogprobs]](../components/completionlogprobs.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `finish_reason` | [Nullable[components.CompletionFinishReason]](../components/completionfinishreason.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `native_finish_reason` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
# CompletionCreateParams
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `model` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `models` | List[*str*] | :heavy_minus_sign: | N/A |
|
|
||||||
| `prompt` | [components.Prompt](../components/prompt.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `best_of` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `echo` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | N/A |
|
|
||||||
| `logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `n` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `stop` | [OptionalNullable[components.CompletionCreateParamsStop]](../components/completioncreateparamsstop.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `stream_options` | [OptionalNullable[components.StreamOptions]](../components/streamoptions.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `suffix` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `user` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | N/A |
|
|
||||||
| `response_format` | [OptionalNullable[components.CompletionCreateParamsResponseFormatUnion]](../components/completioncreateparamsresponseformatunion.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# CompletionCreateParamsResponseFormatJSONObject
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
|
||||||
| `type` | *Literal["json_object"]* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# CompletionCreateParamsResponseFormatPython
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- |
|
|
||||||
| `type` | *Literal["python"]* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# CompletionCreateParamsResponseFormatText
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `type` | *Literal["text"]* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
# CompletionCreateParamsResponseFormatUnion
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.CompletionCreateParamsResponseFormatText`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.CompletionCreateParamsResponseFormatText = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.CompletionCreateParamsResponseFormatJSONObject`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.CompletionCreateParamsResponseFormatJSONObject = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ResponseFormatJSONSchema`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ResponseFormatJSONSchema = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ResponseFormatTextGrammar`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ResponseFormatTextGrammar = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.CompletionCreateParamsResponseFormatPython`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.CompletionCreateParamsResponseFormatPython = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# CompletionCreateParamsStop
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `List[str]`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: List[str] = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# CompletionFinishReason
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `STOP` | stop |
|
|
||||||
| `LENGTH` | length |
|
|
||||||
| `CONTENT_FILTER` | content_filter |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# CompletionLogprobs
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
|
||||||
| `tokens` | List[*str*] | :heavy_check_mark: | N/A |
|
|
||||||
| `token_logprobs` | List[*float*] | :heavy_check_mark: | N/A |
|
|
||||||
| `top_logprobs` | List[Dict[str, *float*]] | :heavy_check_mark: | N/A |
|
|
||||||
| `text_offset` | List[*float*] | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# CompletionResponse
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
|
||||||
| `id` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `object` | *Literal["text_completion"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `created` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `model` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `provider` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `choices` | List[[components.CompletionChoice](../components/completionchoice.md)] | :heavy_check_mark: | N/A |
|
|
||||||
| `usage` | [Optional[components.CompletionUsage]](../components/completionusage.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# CompletionUsage
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- |
|
|
||||||
| `prompt_tokens` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `completion_tokens` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `total_tokens` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# DeveloperMessage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||||
|
| `role` | *Literal["developer"]* | :heavy_check_mark: | N/A |
|
||||||
|
| `content` | [components.DeveloperMessageContent](../components/developermessagecontent.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# MessageContent
|
# DeveloperMessageContent
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Image
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||||
|
| `image_url` | [components.AssistantMessageImageURL](../components/assistantmessageimageurl.md) | :heavy_check_mark: | N/A |
|
||||||
@@ -15,10 +15,10 @@ value: components.SystemMessage = /* values here */
|
|||||||
value: components.UserMessage = /* values here */
|
value: components.UserMessage = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
### `components.MessageDeveloper`
|
### `components.DeveloperMessage`
|
||||||
|
|
||||||
```python
|
```python
|
||||||
value: components.MessageDeveloper = /* values here */
|
value: components.DeveloperMessage = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
### `components.AssistantMessage`
|
### `components.AssistantMessage`
|
||||||
|
|||||||
@@ -1,10 +0,0 @@
|
|||||||
# MessageDeveloper
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
||||||
| `role` | *Literal["developer"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `content` | [components.MessageContent](../components/messagecontent.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -19,4 +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/>"frequency_penalty": 0<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 |
|
||||||
@@ -37,7 +37,7 @@ Request schema for Responses endpoint
|
|||||||
| `service_tier` | [Optional[components.ServiceTier]](../components/servicetier.md) | :heavy_minus_sign: | N/A | |
|
| `service_tier` | [Optional[components.ServiceTier]](../components/servicetier.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `truncation` | [OptionalNullable[components.Truncation]](../components/truncation.md) | :heavy_minus_sign: | N/A | auto |
|
| `truncation` | [OptionalNullable[components.Truncation]](../components/truncation.md) | :heavy_minus_sign: | N/A | auto |
|
||||||
| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
|
| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
|
||||||
| `provider` | [OptionalNullable[components.OpenResponsesRequestProvider]](../components/openresponsesrequestprovider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | |
|
| `provider` | [OptionalNullable[components.Provider]](../components/provider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | |
|
||||||
| `plugins` | List[[components.OpenResponsesRequestPluginUnion](../components/openresponsesrequestpluginunion.md)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | |
|
| `plugins` | List[[components.Plugin](../components/plugin.md)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | |
|
||||||
| `user` | *Optional[str]* | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 128 characters. | |
|
| `user` | *Optional[str]* | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 128 characters. | |
|
||||||
| `session_id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters. | |
|
| `session_id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters. | |
|
||||||
@@ -5,10 +5,10 @@ The object specifying the maximum price you want to pay for this request. USD pr
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
| `prompt` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `prompt` | *Optional[str]* | :heavy_minus_sign: | Price per million prompt tokens | 1000 |
|
||||||
| `completion` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `completion` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `image` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `image` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `audio` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `audio` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `request` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `request` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
# OpenResponsesRequestPluginUnion
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.OpenResponsesRequestPluginAutoRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.OpenResponsesRequestPluginAutoRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.OpenResponsesRequestPluginModeration`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.OpenResponsesRequestPluginModeration = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.OpenResponsesRequestPluginWeb`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.OpenResponsesRequestPluginWeb = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.OpenResponsesRequestPluginFileParser`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.OpenResponsesRequestPluginFileParser = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.OpenResponsesRequestPluginResponseHealing`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.OpenResponsesRequestPluginResponseHealing = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -7,4 +7,5 @@
|
|||||||
| ------------ | ------------ |
|
| ------------ | ------------ |
|
||||||
| `TEXT` | text |
|
| `TEXT` | text |
|
||||||
| `IMAGE` | image |
|
| `IMAGE` | image |
|
||||||
| `EMBEDDINGS` | embeddings |
|
| `EMBEDDINGS` | embeddings |
|
||||||
|
| `AUDIO` | audio |
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# Plugin
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `components.PluginAutoRouter`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.PluginAutoRouter = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.PluginModeration`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.PluginModeration = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.PluginWeb`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.PluginWeb = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.PluginFileParser`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.PluginFileParser = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.PluginResponseHealing`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.PluginResponseHealing = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# OpenResponsesRequestPluginAutoRouter
|
# PluginAutoRouter
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# OpenResponsesRequestPluginFileParser
|
# PluginFileParser
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# OpenResponsesRequestPluginModeration
|
# PluginModeration
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# OpenResponsesRequestPluginResponseHealing
|
# PluginResponseHealing
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# OpenResponsesRequestPluginWeb
|
# PluginWeb
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+16
-15
@@ -3,18 +3,19 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||||
| `prompt` | *str* | :heavy_check_mark: | A value in string format that is a large number | 1000 |
|
| `prompt` | *str* | :heavy_check_mark: | N/A | 1000 |
|
||||||
| `completion` | *str* | :heavy_check_mark: | A value in string format that is a large number | 1000 |
|
| `completion` | *str* | :heavy_check_mark: | N/A | 1000 |
|
||||||
| `request` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `request` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `image` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `image` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `image_token` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `image_token` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `image_output` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `image_output` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `audio` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `audio` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `audio_output` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `web_search` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `web_search` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `discount` | *Optional[float]* | :heavy_minus_sign: | N/A | |
|
| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `discount` | *Optional[float]* | :heavy_minus_sign: | N/A | |
|
||||||
@@ -3,27 +3,21 @@
|
|||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
|
|
||||||
|
### `float`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: float = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
### `str`
|
### `str`
|
||||||
|
|
||||||
```python
|
```python
|
||||||
value: str = /* values here */
|
value: str = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
### `List[str]`
|
### `Any`
|
||||||
|
|
||||||
```python
|
```python
|
||||||
value: List[str] = /* values here */
|
value: Any = /* values here */
|
||||||
```
|
|
||||||
|
|
||||||
### `List[float]`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: List[float] = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `List[List[float]]`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: List[List[float]] = /* values here */
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# OpenResponsesRequestProvider
|
# Provider
|
||||||
|
|
||||||
When multiple model providers are available, optionally indicate your routing preference.
|
When multiple model providers are available, optionally indicate your routing preference.
|
||||||
|
|
||||||
@@ -8,6 +8,7 @@
|
|||||||
| `AI21` | AI21 |
|
| `AI21` | AI21 |
|
||||||
| `AION_LABS` | AionLabs |
|
| `AION_LABS` | AionLabs |
|
||||||
| `ALIBABA` | Alibaba |
|
| `ALIBABA` | Alibaba |
|
||||||
|
| `AMBIENT` | Ambient |
|
||||||
| `AMAZON_BEDROCK` | Amazon Bedrock |
|
| `AMAZON_BEDROCK` | Amazon Bedrock |
|
||||||
| `AMAZON_NOVA` | Amazon Nova |
|
| `AMAZON_NOVA` | Amazon Nova |
|
||||||
| `ANTHROPIC` | Anthropic |
|
| `ANTHROPIC` | Anthropic |
|
||||||
@@ -64,6 +65,7 @@
|
|||||||
| `SEED` | Seed |
|
| `SEED` | Seed |
|
||||||
| `SILICON_FLOW` | SiliconFlow |
|
| `SILICON_FLOW` | SiliconFlow |
|
||||||
| `SOURCEFUL` | Sourceful |
|
| `SOURCEFUL` | Sourceful |
|
||||||
|
| `STEP_FUN` | StepFun |
|
||||||
| `STEALTH` | Stealth |
|
| `STEALTH` | Stealth |
|
||||||
| `STREAM_LAKE` | StreamLake |
|
| `STREAM_LAKE` | StreamLake |
|
||||||
| `SWITCHPOINT` | Switchpoint |
|
| `SWITCHPOINT` | Switchpoint |
|
||||||
|
|||||||
@@ -5,10 +5,10 @@ The object specifying the maximum price you want to pay for this request. USD pr
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
| `prompt` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `prompt` | *Optional[str]* | :heavy_minus_sign: | Price per million prompt tokens | 1000 |
|
||||||
| `completion` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `completion` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `image` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `image` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `audio` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `audio` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `request` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `request` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
@@ -8,6 +8,7 @@ Information about a specific model endpoint
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `name` | *str* | :heavy_check_mark: | N/A | |
|
| `name` | *str* | :heavy_check_mark: | N/A | |
|
||||||
|
| `model_id` | *str* | :heavy_check_mark: | The unique identifier for the model (permaslug) | openai/gpt-4 |
|
||||||
| `model_name` | *str* | :heavy_check_mark: | N/A | |
|
| `model_name` | *str* | :heavy_check_mark: | N/A | |
|
||||||
| `context_length` | *float* | :heavy_check_mark: | N/A | |
|
| `context_length` | *float* | :heavy_check_mark: | N/A | |
|
||||||
| `pricing` | [components.Pricing](../components/pricing.md) | :heavy_check_mark: | N/A | |
|
| `pricing` | [components.Pricing](../components/pricing.md) | :heavy_check_mark: | N/A | |
|
||||||
|
|||||||
@@ -5,18 +5,19 @@ Pricing information for the model
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||||
| `prompt` | *str* | :heavy_check_mark: | A value in string format that is a large number | 1000 |
|
| `prompt` | *str* | :heavy_check_mark: | N/A | 1000 |
|
||||||
| `completion` | *str* | :heavy_check_mark: | A value in string format that is a large number | 1000 |
|
| `completion` | *str* | :heavy_check_mark: | N/A | 1000 |
|
||||||
| `request` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `request` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `image` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `image` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `image_token` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `image_token` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `image_output` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `image_output` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `audio` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `audio` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `audio_output` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `web_search` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `web_search` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 |
|
| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
| `discount` | *Optional[float]* | :heavy_minus_sign: | N/A | |
|
| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `discount` | *Optional[float]* | :heavy_minus_sign: | N/A | |
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# ResponseFormat
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `components.ResponseFormatText`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.ResponseFormatText = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.ResponseFormatJSONObject`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.ResponseFormatJSONObject = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.ResponseFormatJSONSchema`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.ResponseFormatJSONSchema = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.ResponseFormatTextGrammar`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.ResponseFormatTextGrammar = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.ResponseFormatPython`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.ResponseFormatPython = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsResponseFormatJSONObject
|
# ResponseFormatJSONObject
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsResponseFormatPython
|
# ResponseFormatPython
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsResponseFormatText
|
# ResponseFormatText
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+16
-13
@@ -1,17 +1,20 @@
|
|||||||
# Schema0
|
# Schema0
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
## Fields
|
||||||
|
|
||||||
### `components.Schema0Enum`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.Schema0Enum = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
|
| `allow_fallbacks` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `require_parameters` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `data_collection` | [OptionalNullable[components.Schema3]](../components/schema3.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `enforce_distillable_text` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `order` | List[[components.Schema5](../components/schema5.md)] | :heavy_minus_sign: | N/A |
|
||||||
|
| `only` | List[[components.Schema5](../components/schema5.md)] | :heavy_minus_sign: | N/A |
|
||||||
|
| `ignore` | List[[components.Schema5](../components/schema5.md)] | :heavy_minus_sign: | N/A |
|
||||||
|
| `quantizations` | List[[components.Schema8](../components/schema8.md)] | :heavy_minus_sign: | N/A |
|
||||||
|
| `sort` | [OptionalNullable[components.ProviderSortUnion]](../components/providersortunion.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `max_price` | [Optional[components.Schema10]](../components/schema10.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `preferred_min_throughput` | [OptionalNullable[components.Schema15Union]](../components/schema15union.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `preferred_max_latency` | [OptionalNullable[components.Schema15Union]](../components/schema15union.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Schema10
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| `prompt` | [Optional[components.Prompt]](../components/prompt.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `completion` | [Optional[components.Completion]](../components/completion.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `image` | [Optional[components.Schema14]](../components/schema14.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `audio` | [Optional[components.Schema14]](../components/schema14.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `request` | [Optional[components.Schema14]](../components/schema14.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Schema14
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `float`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: float = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `str`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: str = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `Any`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: Any = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsPreferredMaxLatency
|
# Schema15
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# Schema15Union
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `float`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: float = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.Schema15`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema15 = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# Schema17
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `components.Schema17AutoRouter`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema17AutoRouter = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.Schema17Moderation`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema17Moderation = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.Schema17Web`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema17Web = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.Schema17FileParser`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema17FileParser = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.Schema17ResponseHealing`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema17ResponseHealing = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsPluginAutoRouter
|
# Schema17AutoRouter
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsPluginFileParser
|
# Schema17FileParser
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsPluginModeration
|
# Schema17Moderation
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsPluginResponseHealing
|
# Schema17ResponseHealing
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsPluginWeb
|
# Schema17Web
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Schema19
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `components.Schema19ReasoningSummary`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema19ReasoningSummary = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.Schema19ReasoningEncrypted`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema19ReasoningEncrypted = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `components.Schema19ReasoningText`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema19ReasoningText = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Schema19ReasoningEncrypted
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `type` | *Literal["reasoning.encrypted"]* | :heavy_check_mark: | N/A |
|
||||||
|
| `data` | *str* | :heavy_check_mark: | N/A |
|
||||||
|
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `format_` | [OptionalNullable[components.Schema21]](../components/schema21.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Schema19ReasoningSummary
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `type` | *Literal["reasoning.summary"]* | :heavy_check_mark: | N/A |
|
||||||
|
| `summary` | *str* | :heavy_check_mark: | N/A |
|
||||||
|
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `format_` | [OptionalNullable[components.Schema21]](../components/schema21.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# Schema19ReasoningText
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `type` | *Literal["reasoning.text"]* | :heavy_check_mark: | N/A |
|
||||||
|
| `text` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `format_` | [OptionalNullable[components.Schema21]](../components/schema21.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# Schema21
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------------------------- | --------------------------- |
|
||||||
|
| `UNKNOWN` | unknown |
|
||||||
|
| `OPENAI_RESPONSES_V1` | openai-responses-v1 |
|
||||||
|
| `AZURE_OPENAI_RESPONSES_V1` | azure-openai-responses-v1 |
|
||||||
|
| `XAI_RESPONSES_V1` | xai-responses-v1 |
|
||||||
|
| `ANTHROPIC_CLAUDE_V1` | anthropic-claude-v1 |
|
||||||
|
| `GOOGLE_GEMINI_V1` | google-gemini-v1 |
|
||||||
@@ -1,23 +1,9 @@
|
|||||||
# Schema3
|
# Schema3
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
## Values
|
||||||
|
|
||||||
### `components.Schema3ReasoningSummary`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.Schema3ReasoningSummary = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.Schema3ReasoningEncrypted`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.Schema3ReasoningEncrypted = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.Schema3ReasoningText`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.Schema3ReasoningText = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `DENY` | deny |
|
||||||
|
| `ALLOW` | allow |
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# Schema3ReasoningEncrypted
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
||||||
| `type` | *Literal["reasoning.encrypted"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `data` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `format_` | [OptionalNullable[components.Schema5]](../components/schema5.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# Schema3ReasoningSummary
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
||||||
| `type` | *Literal["reasoning.summary"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `summary` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `format_` | [OptionalNullable[components.Schema5]](../components/schema5.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
# Schema3ReasoningText
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
||||||
| `type` | *Literal["reasoning.text"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `text` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `format_` | [OptionalNullable[components.Schema5]](../components/schema5.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,13 +1,17 @@
|
|||||||
# Schema5
|
# Schema5
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Supported Types
|
||||||
|
|
||||||
|
### `components.Schema5Enum`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: components.Schema5Enum = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### `str`
|
||||||
|
|
||||||
|
```python
|
||||||
|
value: str = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------------------------- | --------------------------- |
|
|
||||||
| `UNKNOWN` | unknown |
|
|
||||||
| `OPENAI_RESPONSES_V1` | openai-responses-v1 |
|
|
||||||
| `AZURE_OPENAI_RESPONSES_V1` | azure-openai-responses-v1 |
|
|
||||||
| `XAI_RESPONSES_V1` | xai-responses-v1 |
|
|
||||||
| `ANTHROPIC_CLAUDE_V1` | anthropic-claude-v1 |
|
|
||||||
| `GOOGLE_GEMINI_V1` | google-gemini-v1 |
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# Schema0Enum
|
# Schema5Enum
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
@@ -8,6 +8,7 @@
|
|||||||
| `AI21` | AI21 |
|
| `AI21` | AI21 |
|
||||||
| `AION_LABS` | AionLabs |
|
| `AION_LABS` | AionLabs |
|
||||||
| `ALIBABA` | Alibaba |
|
| `ALIBABA` | Alibaba |
|
||||||
|
| `AMBIENT` | Ambient |
|
||||||
| `AMAZON_BEDROCK` | Amazon Bedrock |
|
| `AMAZON_BEDROCK` | Amazon Bedrock |
|
||||||
| `AMAZON_NOVA` | Amazon Nova |
|
| `AMAZON_NOVA` | Amazon Nova |
|
||||||
| `ANTHROPIC` | Anthropic |
|
| `ANTHROPIC` | Anthropic |
|
||||||
@@ -64,6 +65,7 @@
|
|||||||
| `SEED` | Seed |
|
| `SEED` | Seed |
|
||||||
| `SILICON_FLOW` | SiliconFlow |
|
| `SILICON_FLOW` | SiliconFlow |
|
||||||
| `SOURCEFUL` | Sourceful |
|
| `SOURCEFUL` | Sourceful |
|
||||||
|
| `STEP_FUN` | StepFun |
|
||||||
| `STEALTH` | Stealth |
|
| `STEALTH` | Stealth |
|
||||||
| `STREAM_LAKE` | StreamLake |
|
| `STREAM_LAKE` | StreamLake |
|
||||||
| `SWITCHPOINT` | Switchpoint |
|
| `SWITCHPOINT` | Switchpoint |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# Quantizations
|
# Schema8
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# ChatGenerationParamsStop
|
# Stop
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# StreamOptions
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
|
||||||
| `include_usage` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# BulkAssignKeysToGuardrailGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.<br/>This is used to track API usage per application.<br/> |
|
||||||
|
| `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> |
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# BulkAssignKeysToGuardrailRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.<br/>This is used to track API usage per application.<br/> | |
|
||||||
|
| `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
|
||||||
|
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 |
|
||||||
|
| `request_body` | [operations.BulkAssignKeysToGuardrailRequestBody](../operations/bulkassignkeystoguardrailrequestbody.md) | :heavy_check_mark: | N/A | |
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# BulkAssignKeysToGuardrailRequestBody
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||||
|
| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [<br/>"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"<br/>] |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# BulkAssignKeysToGuardrailResponse
|
||||||
|
|
||||||
|
Assignment result
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
|
| `assigned_count` | *float* | :heavy_check_mark: | Number of keys successfully assigned | 3 |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# BulkAssignMembersToGuardrailGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.<br/>This is used to track API usage per application.<br/> |
|
||||||
|
| `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> |
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# BulkAssignMembersToGuardrailRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.<br/>This is used to track API usage per application.<br/> | |
|
||||||
|
| `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
|
||||||
|
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 |
|
||||||
|
| `request_body` | [operations.BulkAssignMembersToGuardrailRequestBody](../operations/bulkassignmemberstoguardrailrequestbody.md) | :heavy_check_mark: | N/A | |
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# BulkAssignMembersToGuardrailRequestBody
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
|
| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [<br/>"user_abc123",<br/>"user_def456"<br/>] |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# BulkAssignMembersToGuardrailResponse
|
||||||
|
|
||||||
|
Assignment result
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||||
|
| `assigned_count` | *float* | :heavy_check_mark: | Number of members successfully assigned | 2 |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# BulkUnassignKeysFromGuardrailGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.<br/>This is used to track API usage per application.<br/> |
|
||||||
|
| `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> |
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# BulkUnassignKeysFromGuardrailRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.<br/>This is used to track API usage per application.<br/> | |
|
||||||
|
| `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
|
||||||
|
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 |
|
||||||
|
| `request_body` | [operations.BulkUnassignKeysFromGuardrailRequestBody](../operations/bulkunassignkeysfromguardrailrequestbody.md) | :heavy_check_mark: | N/A | |
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# BulkUnassignKeysFromGuardrailRequestBody
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||||
|
| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [<br/>"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"<br/>] |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# BulkUnassignKeysFromGuardrailResponse
|
||||||
|
|
||||||
|
Unassignment result
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||||
|
| `unassigned_count` | *float* | :heavy_check_mark: | Number of keys successfully unassigned | 3 |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user