@openrouter/sdk 0.0.1-beta.8 → 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +109 -1
- package/REACT_QUERY.md +109 -1
- package/README.md +52 -396
- package/esm/funcs/analyticsGetUserActivity.d.ts +1 -1
- package/esm/funcs/analyticsGetUserActivity.js +2 -2
- package/esm/funcs/apiKeysCreate.d.ts +1 -1
- package/esm/funcs/apiKeysCreate.js +2 -2
- package/esm/funcs/apiKeysDelete.d.ts +1 -1
- package/esm/funcs/apiKeysDelete.js +2 -2
- package/esm/funcs/apiKeysGet.d.ts +1 -1
- package/esm/funcs/apiKeysGet.js +2 -2
- package/esm/funcs/apiKeysGetCurrentKeyMetadata.d.ts +1 -1
- package/esm/funcs/apiKeysGetCurrentKeyMetadata.js +2 -2
- package/esm/funcs/apiKeysList.d.ts +1 -1
- package/esm/funcs/apiKeysList.js +2 -2
- package/esm/funcs/apiKeysUpdate.d.ts +1 -1
- package/esm/funcs/apiKeysUpdate.js +2 -2
- package/esm/funcs/betaResponsesSend.d.ts +9 -1
- package/esm/funcs/betaResponsesSend.js +38 -14
- package/esm/funcs/chatSend.d.ts +7 -0
- package/esm/funcs/chatSend.js +1 -7
- package/esm/funcs/creditsCreateCoinbaseCharge.d.ts +1 -1
- package/esm/funcs/creditsCreateCoinbaseCharge.js +15 -5
- package/esm/funcs/creditsGetCredits.d.ts +1 -1
- package/esm/funcs/creditsGetCredits.js +2 -2
- package/esm/funcs/endpointsList.d.ts +1 -1
- package/esm/funcs/endpointsList.js +2 -2
- package/esm/funcs/endpointsListZdrEndpoints.d.ts +2 -1
- package/esm/funcs/endpointsListZdrEndpoints.js +6 -2
- package/esm/funcs/generationsGetGeneration.d.ts +1 -1
- package/esm/funcs/generationsGetGeneration.js +13 -2
- package/esm/funcs/modelsCount.d.ts +3 -2
- package/esm/funcs/modelsCount.js +7 -3
- package/esm/funcs/modelsList.d.ts +3 -1
- package/esm/funcs/modelsList.js +8 -7
- package/esm/funcs/modelsListForUser.d.ts +3 -1
- package/esm/funcs/modelsListForUser.js +7 -3
- package/esm/funcs/oAuthCreateAuthCode.d.ts +18 -0
- package/esm/funcs/oAuthCreateAuthCode.js +82 -0
- package/esm/funcs/oAuthCreateAuthorizationUrl.d.ts +2 -2
- package/esm/funcs/oAuthExchangeAuthCodeForAPIKey.d.ts +18 -0
- package/esm/funcs/oAuthExchangeAuthCodeForAPIKey.js +82 -0
- package/esm/funcs/parametersGetParameters.d.ts +1 -1
- package/esm/funcs/parametersGetParameters.js +2 -2
- package/esm/funcs/providersList.d.ts +1 -1
- package/esm/funcs/providersList.js +1 -1
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/event-streams.d.ts +1 -1
- package/esm/models/badgatewayresponseerrordata.d.ts +40 -0
- package/esm/models/badgatewayresponseerrordata.js +35 -0
- package/esm/models/badrequestresponseerrordata.d.ts +40 -0
- package/esm/models/badrequestresponseerrordata.js +35 -0
- package/esm/models/chatgenerationparams.d.ts +12 -12
- package/esm/models/chatgenerationparams.js +16 -16
- package/esm/models/chatgenerationtokenusage.d.ts +2 -2
- package/esm/models/chatgenerationtokenusage.js +2 -4
- package/esm/models/chatmessagetokenlogprob.d.ts +15 -15
- package/esm/models/chatmessagetokenlogprob.js +16 -15
- package/esm/models/chatstreamingresponsechunk.d.ts +15 -15
- package/esm/models/chatstreamingresponsechunk.js +15 -15
- package/esm/models/completioncreateparams.d.ts +2 -2
- package/esm/models/completioncreateparams.js +2 -2
- package/esm/models/createchargerequest.d.ts +31 -2
- package/esm/models/createchargerequest.js +47 -2
- package/esm/models/defaultparameters.d.ts +36 -0
- package/esm/models/defaultparameters.js +46 -0
- package/esm/models/edgenetworktimeoutresponseerrordata.d.ts +40 -0
- package/esm/models/edgenetworktimeoutresponseerrordata.js +35 -0
- package/esm/models/endpointstatus.d.ts +26 -0
- package/esm/models/endpointstatus.js +36 -0
- package/esm/models/errors/badgatewayresponseerror.d.ts +52 -0
- package/esm/models/errors/badgatewayresponseerror.js +63 -0
- package/esm/models/errors/badrequestresponseerror.d.ts +52 -0
- package/esm/models/errors/badrequestresponseerror.js +63 -0
- package/esm/models/errors/edgenetworktimeoutresponseerror.d.ts +52 -0
- package/esm/models/errors/edgenetworktimeoutresponseerror.js +63 -0
- package/esm/models/errors/forbiddenresponseerror.d.ts +52 -0
- package/esm/models/errors/forbiddenresponseerror.js +63 -0
- package/esm/models/errors/index.d.ts +14 -2
- package/esm/models/errors/index.js +14 -2
- package/esm/models/errors/internalserverresponseerror.d.ts +52 -0
- package/esm/models/errors/internalserverresponseerror.js +63 -0
- package/esm/models/errors/notfoundresponseerror.d.ts +52 -0
- package/esm/models/errors/{errorresponse.js → notfoundresponseerror.js} +16 -17
- package/esm/models/errors/payloadtoolargeresponseerror.d.ts +52 -0
- package/esm/models/errors/payloadtoolargeresponseerror.js +63 -0
- package/esm/models/errors/paymentrequiredresponseerror.d.ts +52 -0
- package/esm/models/errors/paymentrequiredresponseerror.js +63 -0
- package/esm/models/errors/provideroverloadedresponseerror.d.ts +52 -0
- package/esm/models/errors/provideroverloadedresponseerror.js +63 -0
- package/esm/models/errors/requesttimeoutresponseerror.d.ts +52 -0
- package/esm/models/errors/requesttimeoutresponseerror.js +63 -0
- package/esm/models/errors/serviceunavailableresponseerror.d.ts +52 -0
- package/esm/models/errors/serviceunavailableresponseerror.js +63 -0
- package/esm/models/errors/toomanyrequestsresponseerror.d.ts +52 -0
- package/esm/models/errors/toomanyrequestsresponseerror.js +63 -0
- package/esm/models/errors/unauthorizedresponseerror.d.ts +52 -0
- package/esm/models/errors/unauthorizedresponseerror.js +63 -0
- package/esm/models/errors/unprocessableentityresponseerror.d.ts +52 -0
- package/esm/models/errors/unprocessableentityresponseerror.js +63 -0
- package/esm/models/filecitation.d.ts +58 -0
- package/esm/models/filecitation.js +65 -0
- package/esm/models/filepath.d.ts +56 -0
- package/esm/models/filepath.js +64 -0
- package/esm/models/forbiddenresponseerrordata.d.ts +40 -0
- package/esm/models/forbiddenresponseerrordata.js +35 -0
- package/esm/models/index.d.ts +67 -23
- package/esm/models/index.js +67 -23
- package/esm/models/inputmodality.d.ts +25 -0
- package/esm/models/inputmodality.js +35 -0
- package/esm/models/instructtype.d.ts +48 -0
- package/esm/models/instructtype.js +55 -0
- package/esm/models/internalserverresponseerrordata.d.ts +40 -0
- package/esm/models/internalserverresponseerrordata.js +35 -0
- package/esm/models/listendpointsresponse.d.ts +126 -2
- package/esm/models/listendpointsresponse.js +115 -2
- package/esm/models/model.d.ts +101 -0
- package/esm/models/model.js +82 -0
- package/esm/models/modelarchitecture.d.ts +104 -0
- package/esm/models/modelarchitecture.js +107 -0
- package/esm/models/modelgroup.d.ts +45 -0
- package/esm/models/modelgroup.js +53 -0
- package/esm/models/modelscountresponse.d.ts +40 -2
- package/esm/models/modelscountresponse.js +31 -2
- package/esm/models/modelslistresponse.d.ts +10 -2
- package/esm/models/modelslistresponse.js +7 -2
- package/esm/models/notfoundresponseerrordata.d.ts +40 -0
- package/esm/models/notfoundresponseerrordata.js +35 -0
- package/esm/models/openairesponsesannotation.d.ts +28 -0
- package/esm/models/openairesponsesannotation.js +38 -0
- package/esm/models/openairesponsesincludable.d.ts +25 -0
- package/esm/models/openairesponsesincludable.js +35 -0
- package/esm/models/openairesponsesincompletedetails.d.ts +49 -0
- package/esm/models/openairesponsesincompletedetails.js +58 -0
- package/esm/models/openairesponsesinputunion.d.ts +588 -0
- package/esm/models/openairesponsesinputunion.js +686 -0
- package/esm/models/openairesponsesprompt.d.ts +83 -0
- package/esm/models/openairesponsesprompt.js +97 -0
- package/esm/models/openairesponsesreasoningconfig.d.ts +33 -0
- package/esm/models/openairesponsesreasoningconfig.js +35 -0
- package/esm/models/openairesponsesreasoningeffort.d.ts +24 -0
- package/esm/models/openairesponsesreasoningeffort.js +34 -0
- package/esm/models/openairesponsesrefusalcontent.d.ts +54 -0
- package/esm/models/openairesponsesrefusalcontent.js +51 -0
- package/esm/models/openairesponsesresponsestatus.d.ts +26 -0
- package/esm/models/openairesponsesresponsestatus.js +36 -0
- package/esm/models/openairesponsesservicetier.d.ts +25 -0
- package/esm/models/openairesponsesservicetier.js +35 -0
- package/esm/models/openairesponsestoolchoiceunion.d.ts +231 -0
- package/esm/models/openairesponsestoolchoiceunion.js +233 -0
- package/esm/models/openairesponsestruncation.d.ts +22 -0
- package/esm/models/openairesponsestruncation.js +32 -0
- package/esm/models/openresponseseasyinputmessage.d.ts +75 -19
- package/esm/models/openresponseseasyinputmessage.js +105 -16
- package/esm/models/openresponseserrorevent.d.ts +63 -0
- package/esm/models/openresponseserrorevent.js +66 -0
- package/esm/models/openresponsesimagegencallcompleted.d.ts +61 -0
- package/esm/models/openresponsesimagegencallcompleted.js +68 -0
- package/esm/models/openresponsesimagegencallgenerating.d.ts +61 -0
- package/esm/models/openresponsesimagegencallgenerating.js +68 -0
- package/esm/models/openresponsesimagegencallinprogress.d.ts +61 -0
- package/esm/models/openresponsesimagegencallinprogress.js +68 -0
- package/esm/models/openresponsesimagegencallpartialimage.d.ts +65 -0
- package/esm/models/openresponsesimagegencallpartialimage.js +76 -0
- package/esm/models/openresponsesinput.d.ts +36 -5
- package/esm/models/openresponsesinput.js +82 -5
- package/esm/models/openresponsesinputmessageitem.d.ts +52 -8
- package/esm/models/openresponsesinputmessageitem.js +68 -5
- package/esm/models/openresponseslogprobs.d.ts +3 -32
- package/esm/models/openresponseslogprobs.js +3 -29
- package/esm/models/openresponsesnonstreamingresponse.d.ts +93 -123
- package/esm/models/openresponsesnonstreamingresponse.js +111 -145
- package/esm/models/openresponsesreasoning.d.ts +89 -0
- package/esm/models/openresponsesreasoning.js +93 -0
- package/esm/models/openresponsesreasoningconfig.d.ts +2 -23
- package/esm/models/openresponsesreasoningconfig.js +3 -33
- package/esm/models/openresponsesreasoningdeltaevent.d.ts +65 -0
- package/esm/models/openresponsesreasoningdeltaevent.js +74 -0
- package/esm/models/openresponsesreasoningdoneevent.d.ts +65 -0
- package/esm/models/openresponsesreasoningdoneevent.js +74 -0
- package/esm/models/openresponsesreasoningsummarypartaddedevent.d.ts +66 -0
- package/esm/models/openresponsesreasoningsummarypartaddedevent.js +75 -0
- package/esm/models/openresponsesreasoningsummarytextdeltaevent.d.ts +65 -0
- package/esm/models/openresponsesreasoningsummarytextdeltaevent.js +74 -0
- package/esm/models/openresponsesreasoningsummarytextdoneevent.d.ts +65 -0
- package/esm/models/openresponsesreasoningsummarytextdoneevent.js +74 -0
- package/esm/models/openresponsesrequest.d.ts +736 -2
- package/esm/models/openresponsesrequest.js +789 -2
- package/esm/models/openresponsesresponsetext.d.ts +59 -0
- package/esm/models/openresponsesresponsetext.js +64 -0
- package/esm/models/openresponsesstreamevent.d.ts +25 -612
- package/esm/models/openresponsesstreamevent.js +51 -742
- package/esm/models/openresponsestoplogprobs.d.ts +34 -0
- package/esm/models/openresponsestoplogprobs.js +33 -0
- package/esm/models/{responsesusage.d.ts → openresponsesusage.d.ts} +14 -14
- package/esm/models/{responsesusage.js → openresponsesusage.js} +14 -14
- package/esm/models/operations/createauthkeyscode.d.ts +145 -0
- package/esm/models/operations/createauthkeyscode.js +146 -0
- package/esm/models/operations/createresponses.d.ts +58 -0
- package/esm/models/operations/createresponses.js +80 -0
- package/esm/models/operations/exchangeauthcodeforapikey.d.ts +104 -0
- package/esm/models/operations/exchangeauthcodeforapikey.js +111 -0
- package/esm/models/operations/getmodels.d.ts +0 -26
- package/esm/models/operations/getmodels.js +0 -38
- package/esm/models/operations/getparameters.d.ts +1 -0
- package/esm/models/operations/getparameters.js +1 -0
- package/esm/models/operations/index.d.ts +3 -2
- package/esm/models/operations/index.js +3 -2
- package/esm/models/operations/listendpointszdr.d.ts +3 -24
- package/esm/models/operations/listendpointszdr.js +2 -29
- package/esm/models/operations/listmodelsuser.d.ts +0 -22
- package/esm/models/operations/listmodelsuser.js +0 -28
- package/esm/models/operations/listproviders.d.ts +0 -36
- package/esm/models/operations/listproviders.js +0 -28
- package/esm/models/operations/sendchatcompletionrequest.d.ts +1 -1
- package/esm/models/operations/sendchatcompletionrequest.js +2 -1
- package/esm/models/outputitemimagegenerationcall.d.ts +59 -0
- package/esm/models/outputitemimagegenerationcall.js +56 -0
- package/esm/models/outputmessage.d.ts +192 -0
- package/esm/models/outputmessage.js +202 -0
- package/esm/models/outputmodality.d.ts +23 -0
- package/esm/models/outputmodality.js +33 -0
- package/esm/models/parameter.d.ts +43 -0
- package/esm/models/parameter.js +54 -0
- package/esm/models/payloadtoolargeresponseerrordata.d.ts +40 -0
- package/esm/models/payloadtoolargeresponseerrordata.js +35 -0
- package/esm/models/paymentrequiredresponseerrordata.d.ts +40 -0
- package/esm/models/paymentrequiredresponseerrordata.js +35 -0
- package/esm/models/perrequestlimits.d.ts +40 -0
- package/esm/models/perrequestlimits.js +44 -0
- package/esm/models/providername.d.ts +106 -0
- package/esm/models/providername.js +116 -0
- package/esm/models/provideroverloadedresponseerrordata.d.ts +40 -0
- package/esm/models/provideroverloadedresponseerrordata.js +35 -0
- package/esm/models/publicendpoint.d.ts +140 -2
- package/esm/models/publicendpoint.js +156 -2
- package/esm/models/publicpricing.d.ts +87 -0
- package/esm/models/publicpricing.js +73 -0
- package/esm/models/quantization.d.ts +29 -0
- package/esm/models/quantization.js +39 -0
- package/esm/models/requesttimeoutresponseerrordata.d.ts +40 -0
- package/esm/models/requesttimeoutresponseerrordata.js +35 -0
- package/esm/models/responseformattextconfig.d.ts +31 -0
- package/esm/models/responseformattextconfig.js +38 -0
- package/esm/models/responseinputfile.d.ts +63 -0
- package/esm/models/responseinputfile.js +70 -0
- package/esm/models/responseinputimage.d.ts +79 -0
- package/esm/models/responseinputimage.js +90 -0
- package/esm/models/responseinputtext.d.ts +57 -0
- package/esm/models/responseinputtext.js +51 -0
- package/esm/models/responseoutputtext.d.ts +57 -0
- package/esm/models/responseoutputtext.js +54 -0
- package/esm/models/responseserrorfield.d.ts +25 -10
- package/esm/models/responseserrorfield.js +29 -14
- package/esm/models/responsesformatjsonobject.d.ts +55 -0
- package/esm/models/responsesformatjsonobject.js +49 -0
- package/esm/models/responsesformattext.d.ts +55 -0
- package/esm/models/responsesformattext.js +49 -0
- package/esm/models/responsesformattextjsonschemaconfig.d.ts +67 -0
- package/esm/models/responsesformattextjsonschemaconfig.js +57 -0
- package/esm/models/responsesoutputitemfunctioncall.d.ts +89 -0
- package/esm/models/responsesoutputitemfunctioncall.js +93 -0
- package/esm/models/responsesoutputitemreasoning.d.ts +92 -0
- package/esm/models/responsesoutputitemreasoning.js +93 -0
- package/esm/models/responsesoutputmessage.d.ts +45 -42
- package/esm/models/responsesoutputmessage.js +76 -65
- package/esm/models/responsetextconfig.d.ts +59 -0
- package/esm/models/responsetextconfig.js +62 -0
- package/esm/models/serviceunavailableresponseerrordata.d.ts +40 -0
- package/esm/models/serviceunavailableresponseerrordata.js +35 -0
- package/esm/models/toomanyrequestsresponseerrordata.d.ts +40 -0
- package/esm/models/toomanyrequestsresponseerrordata.js +35 -0
- package/esm/models/topproviderinfo.d.ts +45 -0
- package/esm/models/topproviderinfo.js +48 -0
- package/esm/models/unauthorizedresponseerrordata.d.ts +40 -0
- package/esm/models/unauthorizedresponseerrordata.js +35 -0
- package/esm/models/unprocessableentityresponseerrordata.d.ts +40 -0
- package/esm/models/unprocessableentityresponseerrordata.js +35 -0
- package/esm/models/urlcitation.d.ts +60 -0
- package/esm/models/urlcitation.js +69 -0
- package/esm/react-query/betaResponsesSend.d.ts +1 -1
- package/esm/react-query/index.d.ts +2 -0
- package/esm/react-query/index.js +2 -0
- package/esm/react-query/modelsCount.d.ts +2 -2
- package/esm/react-query/modelsList.d.ts +2 -7
- package/esm/react-query/modelsList.js +0 -2
- package/esm/react-query/modelsListForUser.d.ts +2 -1
- package/esm/react-query/oAuthCreateAuthCode.d.ts +23 -0
- package/esm/react-query/oAuthCreateAuthCode.js +42 -0
- package/esm/react-query/oAuthExchangeAuthCodeForAPIKey.d.ts +23 -0
- package/esm/react-query/oAuthExchangeAuthCodeForAPIKey.js +42 -0
- package/esm/sdk/chat.d.ts +7 -0
- package/esm/sdk/chat.js +0 -6
- package/esm/sdk/models.d.ts +4 -3
- package/esm/sdk/oauth.d.ts +46 -0
- package/esm/sdk/oauth.js +67 -0
- package/esm/sdk/responses.d.ts +8 -1
- package/esm/sdk/responses.js +0 -6
- package/esm/sdk/sdk.d.ts +3 -0
- package/esm/sdk/sdk.js +4 -0
- package/jsr.json +1 -1
- package/package.json +3 -1
- package/vitest.config.ts +26 -0
- package/esm/models/errorresponse.d.ts +0 -155
- package/esm/models/errorresponse.js +0 -167
- package/esm/models/errors/errorresponse.d.ts +0 -46
- package/esm/models/errors/listproviders.d.ts +0 -49
- package/esm/models/errors/listproviders.js +0 -51
- package/esm/models/filecitationannotation.d.ts +0 -58
- package/esm/models/filecitationannotation.js +0 -64
- package/esm/models/filepathannotation.d.ts +0 -56
- package/esm/models/filepathannotation.js +0 -62
- package/esm/models/openresponsesformatjsonobject.d.ts +0 -55
- package/esm/models/openresponsesformatjsonobject.js +0 -49
- package/esm/models/openresponsesformatjsonschema.d.ts +0 -67
- package/esm/models/openresponsesformatjsonschema.js +0 -57
- package/esm/models/openresponsesformattext.d.ts +0 -55
- package/esm/models/openresponsesformattext.js +0 -49
- package/esm/models/openresponsesformattextconfig.d.ts +0 -31
- package/esm/models/openresponsesformattextconfig.js +0 -38
- package/esm/models/openresponsesinputcontent.d.ts +0 -43
- package/esm/models/openresponsesinputcontent.js +0 -50
- package/esm/models/openresponsesinputfile.d.ts +0 -63
- package/esm/models/openresponsesinputfile.js +0 -70
- package/esm/models/openresponsesinputimage.d.ts +0 -79
- package/esm/models/openresponsesinputimage.js +0 -90
- package/esm/models/openresponsesinputitem.d.ts +0 -39
- package/esm/models/openresponsesinputitem.js +0 -62
- package/esm/models/openresponsesinputtext.d.ts +0 -57
- package/esm/models/openresponsesinputtext.js +0 -51
- package/esm/models/openresponsesoutputtext.d.ts +0 -80
- package/esm/models/openresponsesoutputtext.js +0 -93
- package/esm/models/openresponsesprompt.d.ts +0 -39
- package/esm/models/openresponsesprompt.js +0 -34
- package/esm/models/openresponsesrefusalcontent.d.ts +0 -54
- package/esm/models/openresponsesrefusalcontent.js +0 -51
- package/esm/models/openresponsestextconfig.d.ts +0 -59
- package/esm/models/openresponsestextconfig.js +0 -63
- package/esm/models/openresponsestoolchoice.d.ts +0 -148
- package/esm/models/openresponsestoolchoice.js +0 -139
- package/esm/models/openresponsestoolunion.d.ts +0 -95
- package/esm/models/openresponsestoolunion.js +0 -94
- package/esm/models/operations/createapialpharesponses.d.ts +0 -58
- package/esm/models/operations/createapialpharesponses.js +0 -83
- package/esm/models/operations/listmodelscount.d.ts +0 -26
- package/esm/models/operations/listmodelscount.js +0 -34
- package/esm/models/outputtextcontent.d.ts +0 -80
- package/esm/models/outputtextcontent.js +0 -93
- package/esm/models/refusalcontent.d.ts +0 -54
- package/esm/models/refusalcontent.js +0 -51
- package/esm/models/toolchoicetypes.d.ts +0 -164
- package/esm/models/toolchoicetypes.js +0 -167
- package/esm/models/urlcitationannotation.d.ts +0 -60
- package/esm/models/urlcitationannotation.js +0 -68
package/README.md
CHANGED
|
@@ -1,29 +1,14 @@
|
|
|
1
|
+

|
|
2
|
+
|
|
1
3
|
# OpenRouter SDK (Beta)
|
|
2
4
|
|
|
3
|
-
The [OpenRouter](https://openrouter.ai/)
|
|
5
|
+
The [OpenRouter SDK](https://openrouter.ai/docs/sdks/typescript) is a TypeScript toolkit designed to help you build AI-powered features and solutions in any JS or TS based runtime. Giving you easy access to over 300 models across providers in an easy and type-safe way.
|
|
6
|
+
|
|
7
|
+
To learn more about how to use the OpenRouter SDK, check out our [API Reference](https://openrouter.ai/docs/sdks/typescript/reference) and [Documentation](https://openrouter.ai/docs/sdks/typescript).
|
|
4
8
|
|
|
5
9
|
<!-- No Summary [summary] -->
|
|
6
10
|
|
|
7
|
-
<!--
|
|
8
|
-
## Table of Contents
|
|
9
|
-
<!-- $toc-max-depth=2 -->
|
|
10
|
-
* [OpenRouter SDK (Beta)](#openrouter-sdk-beta)
|
|
11
|
-
* [SDK Installation](#sdk-installation)
|
|
12
|
-
* [Requirements](#requirements)
|
|
13
|
-
* [SDK Example Usage](#sdk-example-usage)
|
|
14
|
-
* [Authentication](#authentication)
|
|
15
|
-
* [Available Resources and Operations](#available-resources-and-operations)
|
|
16
|
-
* [Standalone functions](#standalone-functions)
|
|
17
|
-
* [React hooks with TanStack Query](#react-hooks-with-tanstack-query)
|
|
18
|
-
* [Server-sent event streaming](#server-sent-event-streaming)
|
|
19
|
-
* [Retries](#retries)
|
|
20
|
-
* [Error Handling](#error-handling)
|
|
21
|
-
* [Debugging](#debugging)
|
|
22
|
-
* [Development](#development)
|
|
23
|
-
* [Maturity](#maturity)
|
|
24
|
-
* [Contributions](#contributions)
|
|
25
|
-
|
|
26
|
-
<!-- End Table of Contents [toc] -->
|
|
11
|
+
<!-- No Table of Contents [toc] -->
|
|
27
12
|
|
|
28
13
|
<!-- Start SDK Installation [installation] -->
|
|
29
14
|
## SDK Installation
|
|
@@ -73,396 +58,48 @@ yarn add @tanstack/react-query react react-dom
|
|
|
73
58
|
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
|
74
59
|
<!-- End Requirements [requirements] -->
|
|
75
60
|
|
|
76
|
-
<!--
|
|
77
|
-
## SDK
|
|
78
|
-
|
|
79
|
-
### Example
|
|
61
|
+
<!-- No SDK Example Usage [usage] -->
|
|
62
|
+
## SDK Usage
|
|
80
63
|
|
|
81
64
|
```typescript
|
|
82
65
|
import { OpenRouter } from "@openrouter/sdk";
|
|
83
66
|
|
|
84
|
-
const openRouter = new OpenRouter({
|
|
85
|
-
apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
|
|
86
|
-
});
|
|
87
|
-
|
|
88
|
-
async function run() {
|
|
89
|
-
const result = await openRouter.beta.responses.send({});
|
|
90
|
-
|
|
91
|
-
console.log(result);
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
run();
|
|
95
|
-
|
|
96
|
-
```
|
|
97
|
-
<!-- End SDK Example Usage [usage] -->
|
|
98
|
-
|
|
99
|
-
<!-- Start Authentication [security] -->
|
|
100
|
-
## Authentication
|
|
101
|
-
|
|
102
|
-
### Per-Client Security Schemes
|
|
103
|
-
|
|
104
|
-
This SDK supports the following security scheme globally:
|
|
105
|
-
|
|
106
|
-
| Name | Type | Scheme | Environment Variable |
|
|
107
|
-
| -------- | ---- | ----------- | -------------------- |
|
|
108
|
-
| `apiKey` | http | HTTP Bearer | `OPENROUTER_API_KEY` |
|
|
109
|
-
|
|
110
|
-
To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
|
|
111
|
-
```typescript
|
|
112
|
-
import { OpenRouter } from "@openrouter/sdk";
|
|
113
|
-
|
|
114
|
-
const openRouter = new OpenRouter({
|
|
115
|
-
apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
|
|
116
|
-
});
|
|
117
|
-
|
|
118
|
-
async function run() {
|
|
119
|
-
const result = await openRouter.beta.responses.send({});
|
|
120
|
-
|
|
121
|
-
console.log(result);
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
run();
|
|
125
|
-
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
### Per-Operation Security Schemes
|
|
129
|
-
|
|
130
|
-
Some operations in this SDK require the security scheme to be specified at the request level. For example:
|
|
131
|
-
```typescript
|
|
132
|
-
import { OpenRouter } from "@openrouter/sdk";
|
|
133
|
-
|
|
134
67
|
const openRouter = new OpenRouter();
|
|
135
68
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
console.log(result);
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
run();
|
|
145
|
-
|
|
146
|
-
```
|
|
147
|
-
<!-- End Authentication [security] -->
|
|
148
|
-
|
|
149
|
-
<!-- Start Available Resources and Operations [operations] -->
|
|
150
|
-
## Available Resources and Operations
|
|
151
|
-
|
|
152
|
-
<details open>
|
|
153
|
-
<summary>Available methods</summary>
|
|
154
|
-
|
|
155
|
-
### [analytics](docs/sdks/analytics/README.md)
|
|
156
|
-
|
|
157
|
-
* [getUserActivity](docs/sdks/analytics/README.md#getuseractivity) - Get user activity grouped by endpoint
|
|
158
|
-
|
|
159
|
-
### [apiKeys](docs/sdks/apikeys/README.md)
|
|
160
|
-
|
|
161
|
-
* [list](docs/sdks/apikeys/README.md#list) - List API keys
|
|
162
|
-
* [create](docs/sdks/apikeys/README.md#create) - Create a new API key
|
|
163
|
-
* [update](docs/sdks/apikeys/README.md#update) - Update an API key
|
|
164
|
-
* [delete](docs/sdks/apikeys/README.md#delete) - Delete an API key
|
|
165
|
-
* [get](docs/sdks/apikeys/README.md#get) - Get a single API key
|
|
166
|
-
* [getCurrentKeyMetadata](docs/sdks/apikeys/README.md#getcurrentkeymetadata) - Get current API key
|
|
167
|
-
|
|
168
|
-
#### [beta.responses](docs/sdks/responses/README.md)
|
|
169
|
-
|
|
170
|
-
* [send](docs/sdks/responses/README.md#send) - Create a response
|
|
171
|
-
|
|
172
|
-
### [chat](docs/sdks/chat/README.md)
|
|
173
|
-
|
|
174
|
-
* [send](docs/sdks/chat/README.md#send) - Create a chat completion
|
|
175
|
-
|
|
176
|
-
### [completions](docs/sdks/completions/README.md)
|
|
177
|
-
|
|
178
|
-
* [generate](docs/sdks/completions/README.md#generate) - Create a completion
|
|
179
|
-
|
|
180
|
-
### [credits](docs/sdks/credits/README.md)
|
|
181
|
-
|
|
182
|
-
* [getCredits](docs/sdks/credits/README.md#getcredits) - Get remaining credits
|
|
183
|
-
* [createCoinbaseCharge](docs/sdks/credits/README.md#createcoinbasecharge) - Create a Coinbase charge for crypto payment
|
|
184
|
-
|
|
185
|
-
### [endpoints](docs/sdks/endpoints/README.md)
|
|
186
|
-
|
|
187
|
-
* [list](docs/sdks/endpoints/README.md#list) - List all endpoints for a model
|
|
188
|
-
* [listZdrEndpoints](docs/sdks/endpoints/README.md#listzdrendpoints) - Preview the impact of ZDR on the available endpoints
|
|
189
|
-
|
|
190
|
-
### [generations](docs/sdks/generations/README.md)
|
|
191
|
-
|
|
192
|
-
* [getGeneration](docs/sdks/generations/README.md#getgeneration) - Get request & usage metadata for a generation
|
|
193
|
-
|
|
194
|
-
### [models](docs/sdks/models/README.md)
|
|
195
|
-
|
|
196
|
-
* [count](docs/sdks/models/README.md#count) - Get total count of available models
|
|
197
|
-
* [list](docs/sdks/models/README.md#list) - List all models and their properties
|
|
198
|
-
* [listForUser](docs/sdks/models/README.md#listforuser) - List models filtered by user provider preferences
|
|
199
|
-
|
|
200
|
-
### [parameters](docs/sdks/parameters/README.md)
|
|
201
|
-
|
|
202
|
-
* [getParameters](docs/sdks/parameters/README.md#getparameters) - Get a model's supported parameters and data about which are most popular
|
|
203
|
-
|
|
204
|
-
### [providers](docs/sdks/providers/README.md)
|
|
205
|
-
|
|
206
|
-
* [list](docs/sdks/providers/README.md#list) - List all providers
|
|
207
|
-
|
|
208
|
-
</details>
|
|
209
|
-
<!-- End Available Resources and Operations [operations] -->
|
|
210
|
-
|
|
211
|
-
<!-- Start Standalone functions [standalone-funcs] -->
|
|
212
|
-
## Standalone functions
|
|
213
|
-
|
|
214
|
-
All the methods listed above are available as standalone functions. These
|
|
215
|
-
functions are ideal for use in applications running in the browser, serverless
|
|
216
|
-
runtimes or other environments where application bundle size is a primary
|
|
217
|
-
concern. When using a bundler to build your application, all unused
|
|
218
|
-
functionality will be either excluded from the final bundle or tree-shaken away.
|
|
219
|
-
|
|
220
|
-
To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
221
|
-
|
|
222
|
-
<details>
|
|
223
|
-
|
|
224
|
-
<summary>Available standalone functions</summary>
|
|
225
|
-
|
|
226
|
-
- [`analyticsGetUserActivity`](docs/sdks/analytics/README.md#getuseractivity) - Get user activity grouped by endpoint
|
|
227
|
-
- [`apiKeysCreate`](docs/sdks/apikeys/README.md#create) - Create a new API key
|
|
228
|
-
- [`apiKeysDelete`](docs/sdks/apikeys/README.md#delete) - Delete an API key
|
|
229
|
-
- [`apiKeysGet`](docs/sdks/apikeys/README.md#get) - Get a single API key
|
|
230
|
-
- [`apiKeysGetCurrentKeyMetadata`](docs/sdks/apikeys/README.md#getcurrentkeymetadata) - Get current API key
|
|
231
|
-
- [`apiKeysList`](docs/sdks/apikeys/README.md#list) - List API keys
|
|
232
|
-
- [`apiKeysUpdate`](docs/sdks/apikeys/README.md#update) - Update an API key
|
|
233
|
-
- [`betaResponsesSend`](docs/sdks/responses/README.md#send) - Create a response
|
|
234
|
-
- [`chatSend`](docs/sdks/chat/README.md#send) - Create a chat completion
|
|
235
|
-
- [`completionsGenerate`](docs/sdks/completions/README.md#generate) - Create a completion
|
|
236
|
-
- [`creditsCreateCoinbaseCharge`](docs/sdks/credits/README.md#createcoinbasecharge) - Create a Coinbase charge for crypto payment
|
|
237
|
-
- [`creditsGetCredits`](docs/sdks/credits/README.md#getcredits) - Get remaining credits
|
|
238
|
-
- [`endpointsList`](docs/sdks/endpoints/README.md#list) - List all endpoints for a model
|
|
239
|
-
- [`endpointsListZdrEndpoints`](docs/sdks/endpoints/README.md#listzdrendpoints) - Preview the impact of ZDR on the available endpoints
|
|
240
|
-
- [`generationsGetGeneration`](docs/sdks/generations/README.md#getgeneration) - Get request & usage metadata for a generation
|
|
241
|
-
- [`modelsCount`](docs/sdks/models/README.md#count) - Get total count of available models
|
|
242
|
-
- [`modelsList`](docs/sdks/models/README.md#list) - List all models and their properties
|
|
243
|
-
- [`modelsListForUser`](docs/sdks/models/README.md#listforuser) - List models filtered by user provider preferences
|
|
244
|
-
- [`parametersGetParameters`](docs/sdks/parameters/README.md#getparameters) - Get a model's supported parameters and data about which are most popular
|
|
245
|
-
- [`providersList`](docs/sdks/providers/README.md#list) - List all providers
|
|
246
|
-
|
|
247
|
-
</details>
|
|
248
|
-
<!-- End Standalone functions [standalone-funcs] -->
|
|
249
|
-
|
|
250
|
-
<!-- Start React hooks with TanStack Query [react-query] -->
|
|
251
|
-
## React hooks with TanStack Query
|
|
252
|
-
|
|
253
|
-
React hooks built on [TanStack Query][tanstack-query] are included in this SDK.
|
|
254
|
-
These hooks and the utility functions provided alongside them can be used to
|
|
255
|
-
build rich applications that pull data from the API using one of the most
|
|
256
|
-
popular asynchronous state management library.
|
|
257
|
-
|
|
258
|
-
[tanstack-query]: https://tanstack.com/query/v5/docs/framework/react/overview
|
|
259
|
-
|
|
260
|
-
To learn about this feature and how to get started, check
|
|
261
|
-
[REACT_QUERY.md](./REACT_QUERY.md).
|
|
262
|
-
|
|
263
|
-
> [!WARNING]
|
|
264
|
-
>
|
|
265
|
-
> This feature is currently in **preview** and is subject to breaking changes
|
|
266
|
-
> within the current major version of the SDK as we gather user feedback on it.
|
|
267
|
-
|
|
268
|
-
<details>
|
|
269
|
-
|
|
270
|
-
<summary>Available React hooks</summary>
|
|
271
|
-
|
|
272
|
-
- [`useAnalyticsGetUserActivity`](docs/sdks/analytics/README.md#getuseractivity) - Get user activity grouped by endpoint
|
|
273
|
-
- [`useApiKeysCreateMutation`](docs/sdks/apikeys/README.md#create) - Create a new API key
|
|
274
|
-
- [`useApiKeysDeleteMutation`](docs/sdks/apikeys/README.md#delete) - Delete an API key
|
|
275
|
-
- [`useApiKeysGet`](docs/sdks/apikeys/README.md#get) - Get a single API key
|
|
276
|
-
- [`useApiKeysGetCurrentKeyMetadata`](docs/sdks/apikeys/README.md#getcurrentkeymetadata) - Get current API key
|
|
277
|
-
- [`useApiKeysList`](docs/sdks/apikeys/README.md#list) - List API keys
|
|
278
|
-
- [`useApiKeysUpdateMutation`](docs/sdks/apikeys/README.md#update) - Update an API key
|
|
279
|
-
- [`useBetaResponsesSendMutation`](docs/sdks/responses/README.md#send) - Create a response
|
|
280
|
-
- [`useChatSendMutation`](docs/sdks/chat/README.md#send) - Create a chat completion
|
|
281
|
-
- [`useCompletionsGenerateMutation`](docs/sdks/completions/README.md#generate) - Create a completion
|
|
282
|
-
- [`useCreditsCreateCoinbaseChargeMutation`](docs/sdks/credits/README.md#createcoinbasecharge) - Create a Coinbase charge for crypto payment
|
|
283
|
-
- [`useCreditsGetCredits`](docs/sdks/credits/README.md#getcredits) - Get remaining credits
|
|
284
|
-
- [`useEndpointsList`](docs/sdks/endpoints/README.md#list) - List all endpoints for a model
|
|
285
|
-
- [`useEndpointsListZdrEndpoints`](docs/sdks/endpoints/README.md#listzdrendpoints) - Preview the impact of ZDR on the available endpoints
|
|
286
|
-
- [`useGenerationsGetGeneration`](docs/sdks/generations/README.md#getgeneration) - Get request & usage metadata for a generation
|
|
287
|
-
- [`useModelsCount`](docs/sdks/models/README.md#count) - Get total count of available models
|
|
288
|
-
- [`useModelsList`](docs/sdks/models/README.md#list) - List all models and their properties
|
|
289
|
-
- [`useModelsListForUser`](docs/sdks/models/README.md#listforuser) - List models filtered by user provider preferences
|
|
290
|
-
- [`useParametersGetParameters`](docs/sdks/parameters/README.md#getparameters) - Get a model's supported parameters and data about which are most popular
|
|
291
|
-
- [`useProvidersList`](docs/sdks/providers/README.md#list) - List all providers
|
|
292
|
-
|
|
293
|
-
</details>
|
|
294
|
-
<!-- End React hooks with TanStack Query [react-query] -->
|
|
295
|
-
|
|
296
|
-
<!-- Start Server-sent event streaming [eventstream] -->
|
|
297
|
-
## Server-sent event streaming
|
|
298
|
-
|
|
299
|
-
[Server-sent events][mdn-sse] are used to stream content from certain
|
|
300
|
-
operations. These operations will expose the stream as an async iterable that
|
|
301
|
-
can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will
|
|
302
|
-
terminate when the server no longer has any events to send and closes the
|
|
303
|
-
underlying connection.
|
|
304
|
-
|
|
305
|
-
```typescript
|
|
306
|
-
import { OpenRouter } from "@openrouter/sdk";
|
|
307
|
-
|
|
308
|
-
const openRouter = new OpenRouter({
|
|
309
|
-
apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
|
|
310
|
-
});
|
|
311
|
-
|
|
312
|
-
async function run() {
|
|
313
|
-
const result = await openRouter.beta.responses.send({});
|
|
314
|
-
|
|
315
|
-
console.log(result);
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
run();
|
|
319
|
-
|
|
320
|
-
```
|
|
321
|
-
|
|
322
|
-
[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
|
|
323
|
-
[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
|
324
|
-
<!-- End Server-sent event streaming [eventstream] -->
|
|
325
|
-
|
|
326
|
-
<!-- Start Retries [retries] -->
|
|
327
|
-
## Retries
|
|
328
|
-
|
|
329
|
-
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
|
|
330
|
-
|
|
331
|
-
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
|
|
332
|
-
```typescript
|
|
333
|
-
import { OpenRouter } from "@openrouter/sdk";
|
|
334
|
-
|
|
335
|
-
const openRouter = new OpenRouter({
|
|
336
|
-
apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
|
|
337
|
-
});
|
|
338
|
-
|
|
339
|
-
async function run() {
|
|
340
|
-
const result = await openRouter.beta.responses.send({}, {
|
|
341
|
-
retries: {
|
|
342
|
-
strategy: "backoff",
|
|
343
|
-
backoff: {
|
|
344
|
-
initialInterval: 1,
|
|
345
|
-
maxInterval: 50,
|
|
346
|
-
exponent: 1.1,
|
|
347
|
-
maxElapsedTime: 100,
|
|
348
|
-
},
|
|
349
|
-
retryConnectionErrors: false,
|
|
69
|
+
const result = await openRouter.chat.send({
|
|
70
|
+
messages: [
|
|
71
|
+
{
|
|
72
|
+
role: "user",
|
|
73
|
+
content: "Hello, how are you?",
|
|
350
74
|
},
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
run();
|
|
357
|
-
|
|
358
|
-
```
|
|
359
|
-
|
|
360
|
-
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
|
|
361
|
-
```typescript
|
|
362
|
-
import { OpenRouter } from "@openrouter/sdk";
|
|
363
|
-
|
|
364
|
-
const openRouter = new OpenRouter({
|
|
365
|
-
retryConfig: {
|
|
366
|
-
strategy: "backoff",
|
|
367
|
-
backoff: {
|
|
368
|
-
initialInterval: 1,
|
|
369
|
-
maxInterval: 50,
|
|
370
|
-
exponent: 1.1,
|
|
371
|
-
maxElapsedTime: 100,
|
|
372
|
-
},
|
|
373
|
-
retryConnectionErrors: false,
|
|
75
|
+
],
|
|
76
|
+
model: "openai/gpt-5"
|
|
77
|
+
provider: {
|
|
78
|
+
zdr: true,
|
|
79
|
+
sort: "price",
|
|
374
80
|
},
|
|
375
|
-
|
|
376
|
-
});
|
|
377
|
-
|
|
378
|
-
async function run() {
|
|
379
|
-
const result = await openRouter.beta.responses.send({});
|
|
380
|
-
|
|
381
|
-
console.log(result);
|
|
382
|
-
}
|
|
383
|
-
|
|
384
|
-
run();
|
|
385
|
-
|
|
386
|
-
```
|
|
387
|
-
<!-- End Retries [retries] -->
|
|
388
|
-
|
|
389
|
-
<!-- Start Error Handling [errors] -->
|
|
390
|
-
## Error Handling
|
|
391
|
-
|
|
392
|
-
[`OpenRouterError`](./src/models/errors/openroutererror.ts) is the base class for all HTTP error responses. It has the following properties:
|
|
393
|
-
|
|
394
|
-
| Property | Type | Description |
|
|
395
|
-
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
|
|
396
|
-
| `error.message` | `string` | Error message |
|
|
397
|
-
| `error.statusCode` | `number` | HTTP response status code eg `404` |
|
|
398
|
-
| `error.headers` | `Headers` | HTTP response headers |
|
|
399
|
-
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
|
|
400
|
-
| `error.rawResponse` | `Response` | Raw HTTP response |
|
|
401
|
-
| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
|
|
402
|
-
|
|
403
|
-
### Example
|
|
404
|
-
```typescript
|
|
405
|
-
import { OpenRouter } from "@openrouter/sdk";
|
|
406
|
-
import * as errors from "@openrouter/sdk/models/errors";
|
|
407
|
-
|
|
408
|
-
const openRouter = new OpenRouter({
|
|
409
|
-
apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
|
|
81
|
+
stream: true
|
|
410
82
|
});
|
|
411
83
|
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
const result = await openRouter.analytics.getUserActivity({
|
|
415
|
-
date: "2025-08-24",
|
|
416
|
-
});
|
|
417
|
-
|
|
418
|
-
console.log(result);
|
|
419
|
-
} catch (error) {
|
|
420
|
-
// The base class for HTTP error responses
|
|
421
|
-
if (error instanceof errors.OpenRouterError) {
|
|
422
|
-
console.log(error.message);
|
|
423
|
-
console.log(error.statusCode);
|
|
424
|
-
console.log(error.body);
|
|
425
|
-
console.log(error.headers);
|
|
426
|
-
|
|
427
|
-
// Depending on the method different errors may be thrown
|
|
428
|
-
if (error instanceof errors.ErrorResponse) {
|
|
429
|
-
console.log(error.data$.error); // models.ErrorResponseError
|
|
430
|
-
console.log(error.data$.userId); // string
|
|
431
|
-
}
|
|
432
|
-
}
|
|
433
|
-
}
|
|
84
|
+
for await (const chunk of stream) {
|
|
85
|
+
console.log(hunk.choices[0].delta.content)
|
|
434
86
|
}
|
|
435
87
|
|
|
436
|
-
run();
|
|
437
|
-
|
|
438
88
|
```
|
|
439
89
|
|
|
440
|
-
|
|
441
|
-
**Primary error:**
|
|
442
|
-
* [`OpenRouterError`](./src/models/errors/openroutererror.ts): The base class for HTTP error responses.
|
|
90
|
+
<!-- No Authentication [security] -->
|
|
443
91
|
|
|
444
|
-
|
|
92
|
+
<!-- No Available Resources and Operations [operations] -->
|
|
445
93
|
|
|
446
|
-
|
|
94
|
+
<!-- No Standalone functions [standalone-funcs] -->
|
|
447
95
|
|
|
448
|
-
|
|
449
|
-
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
|
|
450
|
-
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
|
|
451
|
-
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
|
|
452
|
-
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
|
|
453
|
-
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
|
|
96
|
+
<!-- No React hooks with TanStack Query [react-query] -->
|
|
454
97
|
|
|
98
|
+
<!-- No Server-sent event streaming [eventstream] -->
|
|
455
99
|
|
|
456
|
-
|
|
457
|
-
* [`ErrorResponse`](./src/models/errors/errorresponse.ts): Error response. Applicable to 12 of 20 methods.*
|
|
458
|
-
* [`ChatError`](./src/models/errors/chaterror.ts): Bad request - invalid parameters. Applicable to 2 of 20 methods.*
|
|
459
|
-
* [`InternalServerError`](./src/models/errors/internalservererror.ts): Internal Server Error. Status code `500`. Applicable to 1 of 20 methods.*
|
|
460
|
-
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
|
100
|
+
<!-- No Retries [retries] -->
|
|
461
101
|
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
|
|
465
|
-
<!-- End Error Handling [errors] -->
|
|
102
|
+
<!-- No Error Handling [errors] -->
|
|
466
103
|
|
|
467
104
|
<!-- No Server Selection [server] -->
|
|
468
105
|
|
|
@@ -491,13 +128,32 @@ You can also enable a default debug logger by setting an environment variable `O
|
|
|
491
128
|
|
|
492
129
|
# Development
|
|
493
130
|
|
|
131
|
+
## Running Tests
|
|
132
|
+
|
|
133
|
+
To run the test suite, you'll need to set up your environment with an OpenRouter API key.
|
|
134
|
+
|
|
135
|
+
### Local Development
|
|
136
|
+
|
|
137
|
+
1. Copy the example environment file:
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
cp .env.example .env
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
2. Edit `.env` and add your OpenRouter API key:
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
OPENROUTER_API_KEY=your_api_key_here
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
3. Run the tests:
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
npx vitest
|
|
153
|
+
```
|
|
154
|
+
|
|
494
155
|
## Maturity
|
|
495
156
|
|
|
496
157
|
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
|
497
158
|
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
|
498
159
|
looking for the latest version.
|
|
499
|
-
|
|
500
|
-
## Contributions
|
|
501
|
-
|
|
502
|
-
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
|
|
503
|
-
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
|
|
@@ -14,5 +14,5 @@ import { Result } from "../types/fp.js";
|
|
|
14
14
|
* @remarks
|
|
15
15
|
* Returns user activity data grouped by endpoint for the last 30 (completed) UTC days
|
|
16
16
|
*/
|
|
17
|
-
export declare function analyticsGetUserActivity(client: OpenRouterCore, request?: operations.GetUserActivityRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.GetUserActivityResponse, errors.
|
|
17
|
+
export declare function analyticsGetUserActivity(client: OpenRouterCore, request?: operations.GetUserActivityRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.GetUserActivityResponse, errors.BadRequestResponseError | errors.UnauthorizedResponseError | errors.ForbiddenResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=analyticsGetUserActivity.d.ts.map
|
|
@@ -65,7 +65,7 @@ async function $do(client, request, options) {
|
|
|
65
65
|
const req = requestRes.value;
|
|
66
66
|
const doResult = await client._do(req, {
|
|
67
67
|
context,
|
|
68
|
-
errorCodes: ["4XX", "5XX"],
|
|
68
|
+
errorCodes: ["400", "401", "403", "4XX", "500", "5XX"],
|
|
69
69
|
retryConfig: context.retryConfig,
|
|
70
70
|
retryCodes: context.retryCodes,
|
|
71
71
|
});
|
|
@@ -76,7 +76,7 @@ async function $do(client, request, options) {
|
|
|
76
76
|
const responseFields = {
|
|
77
77
|
HttpMeta: { Response: response, Request: req },
|
|
78
78
|
};
|
|
79
|
-
const [result] = await M.match(M.json(200, operations.GetUserActivityResponse$inboundSchema), M.jsonErr(
|
|
79
|
+
const [result] = await M.match(M.json(200, operations.GetUserActivityResponse$inboundSchema), M.jsonErr(400, errors.BadRequestResponseError$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(403, errors.ForbiddenResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
80
80
|
if (!result.ok) {
|
|
81
81
|
return [result, { status: "complete", request: req, response }];
|
|
82
82
|
}
|
|
@@ -11,5 +11,5 @@ import { Result } from "../types/fp.js";
|
|
|
11
11
|
/**
|
|
12
12
|
* Create a new API key
|
|
13
13
|
*/
|
|
14
|
-
export declare function apiKeysCreate(client: OpenRouterCore, request: operations.CreateKeysRequest, options?: RequestOptions): APIPromise<Result<operations.CreateKeysResponse, errors.
|
|
14
|
+
export declare function apiKeysCreate(client: OpenRouterCore, request: operations.CreateKeysRequest, options?: RequestOptions): APIPromise<Result<operations.CreateKeysResponse, errors.BadRequestResponseError | errors.UnauthorizedResponseError | errors.TooManyRequestsResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
15
15
|
//# sourceMappingURL=apiKeysCreate.d.ts.map
|
|
@@ -59,7 +59,7 @@ async function $do(client, request, options) {
|
|
|
59
59
|
const req = requestRes.value;
|
|
60
60
|
const doResult = await client._do(req, {
|
|
61
61
|
context,
|
|
62
|
-
errorCodes: ["4XX", "5XX"],
|
|
62
|
+
errorCodes: ["400", "401", "429", "4XX", "500", "5XX"],
|
|
63
63
|
retryConfig: context.retryConfig,
|
|
64
64
|
retryCodes: context.retryCodes,
|
|
65
65
|
});
|
|
@@ -70,7 +70,7 @@ async function $do(client, request, options) {
|
|
|
70
70
|
const responseFields = {
|
|
71
71
|
HttpMeta: { Response: response, Request: req },
|
|
72
72
|
};
|
|
73
|
-
const [result] = await M.match(M.json(201, operations.CreateKeysResponse$inboundSchema), M.jsonErr(
|
|
73
|
+
const [result] = await M.match(M.json(201, operations.CreateKeysResponse$inboundSchema), M.jsonErr(400, errors.BadRequestResponseError$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(429, errors.TooManyRequestsResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
74
74
|
if (!result.ok) {
|
|
75
75
|
return [result, { status: "complete", request: req, response }];
|
|
76
76
|
}
|
|
@@ -11,5 +11,5 @@ import { Result } from "../types/fp.js";
|
|
|
11
11
|
/**
|
|
12
12
|
* Delete an API key
|
|
13
13
|
*/
|
|
14
|
-
export declare function apiKeysDelete(client: OpenRouterCore, request: operations.DeleteKeysRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteKeysResponse, errors.
|
|
14
|
+
export declare function apiKeysDelete(client: OpenRouterCore, request: operations.DeleteKeysRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteKeysResponse, errors.UnauthorizedResponseError | errors.NotFoundResponseError | errors.TooManyRequestsResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
15
15
|
//# sourceMappingURL=apiKeysDelete.d.ts.map
|
|
@@ -64,7 +64,7 @@ async function $do(client, request, options) {
|
|
|
64
64
|
const req = requestRes.value;
|
|
65
65
|
const doResult = await client._do(req, {
|
|
66
66
|
context,
|
|
67
|
-
errorCodes: ["4XX", "5XX"],
|
|
67
|
+
errorCodes: ["401", "404", "429", "4XX", "500", "5XX"],
|
|
68
68
|
retryConfig: context.retryConfig,
|
|
69
69
|
retryCodes: context.retryCodes,
|
|
70
70
|
});
|
|
@@ -75,7 +75,7 @@ async function $do(client, request, options) {
|
|
|
75
75
|
const responseFields = {
|
|
76
76
|
HttpMeta: { Response: response, Request: req },
|
|
77
77
|
};
|
|
78
|
-
const [result] = await M.match(M.json(200, operations.DeleteKeysResponse$inboundSchema), M.jsonErr(
|
|
78
|
+
const [result] = await M.match(M.json(200, operations.DeleteKeysResponse$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(404, errors.NotFoundResponseError$inboundSchema), M.jsonErr(429, errors.TooManyRequestsResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
79
79
|
if (!result.ok) {
|
|
80
80
|
return [result, { status: "complete", request: req, response }];
|
|
81
81
|
}
|
|
@@ -11,5 +11,5 @@ import { Result } from "../types/fp.js";
|
|
|
11
11
|
/**
|
|
12
12
|
* Get a single API key
|
|
13
13
|
*/
|
|
14
|
-
export declare function apiKeysGet(client: OpenRouterCore, request: operations.GetKeyRequest, options?: RequestOptions): APIPromise<Result<operations.GetKeyResponse, errors.
|
|
14
|
+
export declare function apiKeysGet(client: OpenRouterCore, request: operations.GetKeyRequest, options?: RequestOptions): APIPromise<Result<operations.GetKeyResponse, errors.UnauthorizedResponseError | errors.NotFoundResponseError | errors.TooManyRequestsResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
15
15
|
//# sourceMappingURL=apiKeysGet.d.ts.map
|
package/esm/funcs/apiKeysGet.js
CHANGED
|
@@ -64,7 +64,7 @@ async function $do(client, request, options) {
|
|
|
64
64
|
const req = requestRes.value;
|
|
65
65
|
const doResult = await client._do(req, {
|
|
66
66
|
context,
|
|
67
|
-
errorCodes: ["4XX", "5XX"],
|
|
67
|
+
errorCodes: ["401", "404", "429", "4XX", "500", "5XX"],
|
|
68
68
|
retryConfig: context.retryConfig,
|
|
69
69
|
retryCodes: context.retryCodes,
|
|
70
70
|
});
|
|
@@ -75,7 +75,7 @@ async function $do(client, request, options) {
|
|
|
75
75
|
const responseFields = {
|
|
76
76
|
HttpMeta: { Response: response, Request: req },
|
|
77
77
|
};
|
|
78
|
-
const [result] = await M.match(M.json(200, operations.GetKeyResponse$inboundSchema), M.jsonErr(
|
|
78
|
+
const [result] = await M.match(M.json(200, operations.GetKeyResponse$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(404, errors.NotFoundResponseError$inboundSchema), M.jsonErr(429, errors.TooManyRequestsResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
79
79
|
if (!result.ok) {
|
|
80
80
|
return [result, { status: "complete", request: req, response }];
|
|
81
81
|
}
|
|
@@ -14,5 +14,5 @@ import { Result } from "../types/fp.js";
|
|
|
14
14
|
* @remarks
|
|
15
15
|
* Get information on the API key associated with the current authentication session
|
|
16
16
|
*/
|
|
17
|
-
export declare function apiKeysGetCurrentKeyMetadata(client: OpenRouterCore, options?: RequestOptions): APIPromise<Result<operations.GetCurrentKeyResponse, errors.
|
|
17
|
+
export declare function apiKeysGetCurrentKeyMetadata(client: OpenRouterCore, options?: RequestOptions): APIPromise<Result<operations.GetCurrentKeyResponse, errors.UnauthorizedResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=apiKeysGetCurrentKeyMetadata.d.ts.map
|
|
@@ -52,7 +52,7 @@ async function $do(client, options) {
|
|
|
52
52
|
const req = requestRes.value;
|
|
53
53
|
const doResult = await client._do(req, {
|
|
54
54
|
context,
|
|
55
|
-
errorCodes: ["4XX", "5XX"],
|
|
55
|
+
errorCodes: ["401", "4XX", "500", "5XX"],
|
|
56
56
|
retryConfig: context.retryConfig,
|
|
57
57
|
retryCodes: context.retryCodes,
|
|
58
58
|
});
|
|
@@ -63,7 +63,7 @@ async function $do(client, options) {
|
|
|
63
63
|
const responseFields = {
|
|
64
64
|
HttpMeta: { Response: response, Request: req },
|
|
65
65
|
};
|
|
66
|
-
const [result] = await M.match(M.json(200, operations.GetCurrentKeyResponse$inboundSchema), M.jsonErr(
|
|
66
|
+
const [result] = await M.match(M.json(200, operations.GetCurrentKeyResponse$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
67
67
|
if (!result.ok) {
|
|
68
68
|
return [result, { status: "complete", request: req, response }];
|
|
69
69
|
}
|
|
@@ -11,5 +11,5 @@ import { Result } from "../types/fp.js";
|
|
|
11
11
|
/**
|
|
12
12
|
* List API keys
|
|
13
13
|
*/
|
|
14
|
-
export declare function apiKeysList(client: OpenRouterCore, request?: operations.ListRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.ListResponse, errors.
|
|
14
|
+
export declare function apiKeysList(client: OpenRouterCore, request?: operations.ListRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.ListResponse, errors.UnauthorizedResponseError | errors.TooManyRequestsResponseError | errors.InternalServerResponseError | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
15
15
|
//# sourceMappingURL=apiKeysList.d.ts.map
|
package/esm/funcs/apiKeysList.js
CHANGED
|
@@ -63,7 +63,7 @@ async function $do(client, request, options) {
|
|
|
63
63
|
const req = requestRes.value;
|
|
64
64
|
const doResult = await client._do(req, {
|
|
65
65
|
context,
|
|
66
|
-
errorCodes: ["4XX", "5XX"],
|
|
66
|
+
errorCodes: ["401", "429", "4XX", "500", "5XX"],
|
|
67
67
|
retryConfig: context.retryConfig,
|
|
68
68
|
retryCodes: context.retryCodes,
|
|
69
69
|
});
|
|
@@ -74,7 +74,7 @@ async function $do(client, request, options) {
|
|
|
74
74
|
const responseFields = {
|
|
75
75
|
HttpMeta: { Response: response, Request: req },
|
|
76
76
|
};
|
|
77
|
-
const [result] = await M.match(M.json(200, operations.ListResponse$inboundSchema), M.jsonErr(
|
|
77
|
+
const [result] = await M.match(M.json(200, operations.ListResponse$inboundSchema), M.jsonErr(401, errors.UnauthorizedResponseError$inboundSchema), M.jsonErr(429, errors.TooManyRequestsResponseError$inboundSchema), M.jsonErr(500, errors.InternalServerResponseError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
78
78
|
if (!result.ok) {
|
|
79
79
|
return [result, { status: "complete", request: req, response }];
|
|
80
80
|
}
|