Compare commits

..
3 Commits
Author SHA1 Message Date
OpenRouter Team faad3acf8d Commits included in this export:
- 5dbab2094bc744db4a90b3097520d897e5d0d634
  - 4c47d1af1735db18a1c1a7f463e801c7f71ad4e5

GitOrigin-RevId: 5dbab2094bc744db4a90b3097520d897e5d0d634
2026-02-08 06:52:31 +00:00
Shashank GoyalandGitHub b2098ff28e chore: sync from monorepo (#49) 2026-02-05 20:45:13 -05:00
OpenRouter Team 1cad51abb6 Commits included in this export:
- 6ddaaa6989d725bbe966e45f7aed0c1bd72f9153
  - 4779741b6ba710b1299612b82e8544516bd9dd6a
  - 22083fcc8f58884d8212d6f3314b231c4ddd21cd
  - a925a620f97196d509e073a163caac053bd82316
  - 5c05d8829784601ffd151acef1a6978c266f913d
  - 6f4fff535fbf4274255c255ae23620b8e00e614f
  - ef358e96cb01e469b77d44683603a602b0813116
  - e6299b4ebfe5c2eed6c598771f0fd99f84555401
  - 24d3f0ee1c2aa19a62f7902836034080b9246813
  - 68922847c2969b773887310eb7aa9a814e199c5a
  - 729ee2338c39df22461526153e7f4ba868fd498e
  - e1074ff86fccf5e48406b7595298873106d3cc5a
  - 123bbdaf841d299162a82ee2573adfbb70a45b8f
  - ac457b8a8dad98fdf5ddcae8dd4711361cea3084
  - ea825199f4c59dd68fec01cf8d18a582963c9f25
  - 4d48e4f6bb936e785787314a965298da6b78fea0
  - 718729a573ee98893a4408d5a52ab4686661fe54
  - b867adcde6b64f3f2a11c4626254b39098e4b0b4
  - 21912c097b4066d109766c6b4492826595cd57c5
  - bc1ed85adc976a4634ca8a41b82e4fc2c39a864f
  - d145c89c941937a312ed1357590d2bfda9a3603d
  - 12f05b5dee397ead47cfcd545a7a2e3c7ff57524
  - dd28f75a19a015809797c7abf3f8758f7c37262e
  - c96e569781e07ab44172d9c69940ec17bafd81f4
  - c9d5a90e3c2b5077a2bdd49773f1a46d1a5a79c7
  - 58b08f87116ceab9076de2fdc0a4c74c919b44c4

GitOrigin-RevId: 6ddaaa6989d725bbe966e45f7aed0c1bd72f9153
2026-02-05 23:15:21 +00:00
166 changed files with 6128 additions and 1110 deletions
+67 -11
View File
@@ -1,12 +1,12 @@
lockVersion: 2.0.0 lockVersion: 2.0.0
id: cfd52247-6a25-4c6d-bbce-fe6fce0cd69d id: cfd52247-6a25-4c6d-bbce-fe6fce0cd69d
management: management:
docChecksum: 4cc0fd0666832ffd4990d56ea4d60d8a docChecksum: a8fed71df7458c6d948fc393e17aa9bc
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.4.1 releaseVersion: 0.7.0
configChecksum: 25abf1229cf681cc15488099121619e5 configChecksum: fb83a92d2ee84da7390a12353d622d23
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
@@ -14,6 +14,7 @@ features:
python: python:
acceptHeaders: 3.0.0 acceptHeaders: 3.0.0
additionalDependencies: 1.0.0 additionalDependencies: 1.0.0
additionalProperties: 1.0.1
constsAndDefaults: 1.0.5 constsAndDefaults: 1.0.5
core: 5.23.13 core: 5.23.13
defaultEnabledRetries: 0.2.0 defaultEnabledRetries: 0.2.0
@@ -424,10 +425,11 @@ generatedFiles:
- docs/components/schema17responsehealing.md - docs/components/schema17responsehealing.md
- docs/components/schema17web.md - docs/components/schema17web.md
- docs/components/schema19.md - docs/components/schema19.md
- docs/components/schema19reasoningencrypted.md - docs/components/schema20.md
- docs/components/schema19reasoningsummary.md - docs/components/schema20reasoningencrypted.md
- docs/components/schema19reasoningtext.md - docs/components/schema20reasoningsummary.md
- docs/components/schema21.md - docs/components/schema20reasoningtext.md
- docs/components/schema22.md
- docs/components/schema3.md - docs/components/schema3.md
- docs/components/schema5.md - docs/components/schema5.md
- docs/components/schema5enum.md - docs/components/schema5enum.md
@@ -447,6 +449,7 @@ generatedFiles:
- docs/components/toolresponsemessagecontent.md - docs/components/toolresponsemessagecontent.md
- docs/components/toomanyrequestsresponseerrordata.md - docs/components/toomanyrequestsresponseerrordata.md
- docs/components/topproviderinfo.md - docs/components/topproviderinfo.md
- docs/components/trace.md
- docs/components/truncation.md - docs/components/truncation.md
- docs/components/ttl.md - docs/components/ttl.md
- docs/components/type.md - docs/components/type.md
@@ -498,15 +501,19 @@ 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/bulkassignkeystoguardrailrequest.md
- docs/operations/bulkassignkeystoguardrailrequestbody.md - docs/operations/bulkassignkeystoguardrailrequestbody.md
- docs/operations/bulkassignkeystoguardrailresponse.md - docs/operations/bulkassignkeystoguardrailresponse.md
- docs/operations/bulkassignmemberstoguardrailglobals.md
- docs/operations/bulkassignmemberstoguardrailrequest.md - docs/operations/bulkassignmemberstoguardrailrequest.md
- docs/operations/bulkassignmemberstoguardrailrequestbody.md - docs/operations/bulkassignmemberstoguardrailrequestbody.md
- docs/operations/bulkassignmemberstoguardrailresponse.md - docs/operations/bulkassignmemberstoguardrailresponse.md
- docs/operations/bulkunassignkeysfromguardrailglobals.md
- docs/operations/bulkunassignkeysfromguardrailrequest.md - docs/operations/bulkunassignkeysfromguardrailrequest.md
- docs/operations/bulkunassignkeysfromguardrailrequestbody.md - docs/operations/bulkunassignkeysfromguardrailrequestbody.md
- docs/operations/bulkunassignkeysfromguardrailresponse.md - docs/operations/bulkunassignkeysfromguardrailresponse.md
- docs/operations/bulkunassignmembersfromguardrailglobals.md
- docs/operations/bulkunassignmembersfromguardrailrequest.md - docs/operations/bulkunassignmembersfromguardrailrequest.md
- docs/operations/bulkunassignmembersfromguardrailrequestbody.md - docs/operations/bulkunassignmembersfromguardrailrequestbody.md
- docs/operations/bulkunassignmembersfromguardrailresponse.md - docs/operations/bulkunassignmembersfromguardrailresponse.md
@@ -517,77 +524,119 @@ generatedFiles:
- 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/createguardraildata.md
- docs/operations/createguardrailglobals.md
- docs/operations/createguardrailrequest.md - docs/operations/createguardrailrequest.md
- docs/operations/createguardrailrequestbody.md
- docs/operations/createguardrailresetintervalrequest.md - docs/operations/createguardrailresetintervalrequest.md
- docs/operations/createguardrailresetintervalresponse.md - docs/operations/createguardrailresetintervalresponse.md
- docs/operations/createguardrailresponse.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/deleteguardrailrequest.md
- docs/operations/deleteguardrailresponse.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/getguardraildata.md
- docs/operations/getguardrailglobals.md
- docs/operations/getguardrailrequest.md - docs/operations/getguardrailrequest.md
- docs/operations/getguardrailresetinterval.md - docs/operations/getguardrailresetinterval.md
- docs/operations/getguardrailresponse.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/getuseractivityglobals.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/listguardrailkeyassignmentsdata.md
- docs/operations/listguardrailkeyassignmentsglobals.md
- docs/operations/listguardrailkeyassignmentsrequest.md - docs/operations/listguardrailkeyassignmentsrequest.md
- docs/operations/listguardrailkeyassignmentsresponse.md - docs/operations/listguardrailkeyassignmentsresponse.md
- docs/operations/listguardrailmemberassignmentsdata.md - docs/operations/listguardrailmemberassignmentsdata.md
- docs/operations/listguardrailmemberassignmentsglobals.md
- docs/operations/listguardrailmemberassignmentsrequest.md - docs/operations/listguardrailmemberassignmentsrequest.md
- docs/operations/listguardrailmemberassignmentsresponse.md - docs/operations/listguardrailmemberassignmentsresponse.md
- docs/operations/listguardrailsdata.md - docs/operations/listguardrailsdata.md
- docs/operations/listguardrailsglobals.md
- docs/operations/listguardrailsrequest.md - docs/operations/listguardrailsrequest.md
- docs/operations/listguardrailsresetinterval.md - docs/operations/listguardrailsresetinterval.md
- docs/operations/listguardrailsresponse.md - docs/operations/listguardrailsresponse.md
- docs/operations/listkeyassignmentsdata.md - docs/operations/listkeyassignmentsdata.md
- docs/operations/listkeyassignmentsglobals.md
- docs/operations/listkeyassignmentsrequest.md - docs/operations/listkeyassignmentsrequest.md
- docs/operations/listkeyassignmentsresponse.md - docs/operations/listkeyassignmentsresponse.md
- docs/operations/listmemberassignmentsdata.md - docs/operations/listmemberassignmentsdata.md
- docs/operations/listmemberassignmentsglobals.md
- docs/operations/listmemberassignmentsrequest.md - docs/operations/listmemberassignmentsrequest.md
- docs/operations/listmemberassignmentsresponse.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
@@ -597,17 +646,21 @@ generatedFiles:
- docs/operations/providername.md - docs/operations/providername.md
- docs/operations/providerresponse.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/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/updateguardraildata.md
- docs/operations/updateguardrailglobals.md
- docs/operations/updateguardrailrequest.md - docs/operations/updateguardrailrequest.md
- docs/operations/updateguardrailrequestbody.md - docs/operations/updateguardrailrequestbody.md
- docs/operations/updateguardrailresetintervalrequest.md - docs/operations/updateguardrailresetintervalrequest.md
- docs/operations/updateguardrailresetintervalresponse.md - docs/operations/updateguardrailresetintervalresponse.md
- docs/operations/updateguardrailresponse.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
@@ -645,6 +698,7 @@ generatedFiles:
- src/openrouter/components/_schema14.py - src/openrouter/components/_schema14.py
- src/openrouter/components/_schema17.py - src/openrouter/components/_schema17.py
- src/openrouter/components/_schema19.py - src/openrouter/components/_schema19.py
- src/openrouter/components/_schema20.py
- src/openrouter/components/_schema5.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
@@ -852,6 +906,7 @@ generatedFiles:
- src/openrouter/operations/getmodels.py - src/openrouter/operations/getmodels.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/listguardrailkeyassignments.py
@@ -859,6 +914,7 @@ generatedFiles:
- src/openrouter/operations/listguardrails.py - src/openrouter/operations/listguardrails.py
- src/openrouter/operations/listkeyassignments.py - src/openrouter/operations/listkeyassignments.py
- src/openrouter/operations/listmemberassignments.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
@@ -935,7 +991,7 @@ examples:
"401": "401":
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}} application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
"403": "403":
application/json: {"error": {"code": 403, "message": "Only provisioning keys can perform this operation"}} application/json: {"error": {"code": 403, "message": "Only management keys can perform this operation"}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
getCredits: getCredits:
@@ -946,7 +1002,7 @@ examples:
"401": "401":
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}} application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
"403": "403":
application/json: {"error": {"code": 403, "message": "Only provisioning keys can perform this operation"}} application/json: {"error": {"code": 403, "message": "Only management keys can perform this operation"}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
createCoinbaseCharge: createCoinbaseCharge:
@@ -1180,7 +1236,7 @@ examples:
speakeasy-default-get-current-key: speakeasy-default-get-current-key:
responses: responses:
"200": "200":
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."}}} 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_management_key": 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":
@@ -1195,7 +1251,7 @@ examples:
"400": "400":
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}} application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
"403": "403":
application/json: {"error": {"code": 403, "message": "Only provisioning keys can perform this operation"}} application/json: {"error": {"code": 403, "message": "Only management keys can perform this operation"}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
createAuthKeysCode: createAuthKeysCode:
+1 -1
View File
@@ -31,7 +31,7 @@ generation:
skipResponseBodyAssertions: false skipResponseBodyAssertions: false
preApplyUnionDiscriminators: true preApplyUnionDiscriminators: true
python: python:
version: 0.4.1 version: 0.7.0
additionalDependencies: additionalDependencies:
dev: {} dev: {}
main: {} main: {}
+153 -54
View File
@@ -4094,6 +4094,25 @@ components:
A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for 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 observability. If provided in both the request body and the x-session-id header, the body value takes
precedence. Maximum of 128 characters. precedence. Maximum of 128 characters.
trace:
type: object
properties:
trace_id:
type: string
trace_name:
type: string
span_name:
type: string
generation_name:
type: string
parent_span_id:
type: string
additionalProperties:
nullable: true
description: >-
Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name,
parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured
broadcast destinations.
description: Request schema for Responses endpoint description: Request schema for Responses endpoint
example: example:
model: anthropic/claude-4.5-sonnet-20250929 model: anthropic/claude-4.5-sonnet-20250929
@@ -4403,7 +4422,6 @@ components:
- tool_use - tool_use
- pause_turn - pause_turn
- refusal - refusal
- model_context_window_exceeded
stop_sequence: stop_sequence:
type: string type: string
nullable: true nullable: true
@@ -4431,6 +4449,9 @@ components:
required: required:
- ephemeral_5m_input_tokens - ephemeral_5m_input_tokens
- ephemeral_1h_input_tokens - ephemeral_1h_input_tokens
inference_geo:
type: string
nullable: true
server_tool_use: server_tool_use:
type: object type: object
nullable: true nullable: true
@@ -4452,6 +4473,7 @@ components:
- cache_creation_input_tokens - cache_creation_input_tokens
- cache_read_input_tokens - cache_read_input_tokens
- cache_creation - cache_creation
- inference_geo
- server_tool_use - server_tool_use
- service_tier - service_tier
required: required:
@@ -4486,6 +4508,7 @@ components:
cache_creation_input_tokens: null cache_creation_input_tokens: null
cache_read_input_tokens: null cache_read_input_tokens: null
cache_creation: null cache_creation: null
inference_geo: null
server_tool_use: null server_tool_use: null
service_tier: standard service_tier: standard
AnthropicMessagesStreamEvent: AnthropicMessagesStreamEvent:
@@ -4805,6 +4828,9 @@ components:
required: required:
- ephemeral_5m_input_tokens - ephemeral_5m_input_tokens
- ephemeral_1h_input_tokens - ephemeral_1h_input_tokens
inference_geo:
type: string
nullable: true
server_tool_use: server_tool_use:
type: object type: object
nullable: true nullable: true
@@ -4826,6 +4852,7 @@ components:
- cache_creation_input_tokens - cache_creation_input_tokens
- cache_read_input_tokens - cache_read_input_tokens
- cache_creation - cache_creation
- inference_geo
- server_tool_use - server_tool_use
- service_tier - service_tier
required: required:
@@ -4859,7 +4886,6 @@ components:
- tool_use - tool_use
- pause_turn - pause_turn
- refusal - refusal
- model_context_window_exceeded
stop_sequence: stop_sequence:
type: string type: string
nullable: true nullable: true
@@ -6524,6 +6550,22 @@ components:
- role - role
- content - content
description: Anthropic message with OpenRouter extensions description: Anthropic message with OpenRouter extensions
AnthropicOutputConfig:
type: object
properties:
effort:
type: string
nullable: true
enum:
- low
- medium
- high
- max
description: >-
How much effort the model should put into its response. Higher effort levels may result in more thorough
analysis but take longer. Valid values are `low`, `medium`, `high`, or `max`.
example: medium
description: Configuration for controlling output behavior. Currently supports the effort parameter for Claude Opus 4.5.
AnthropicMessagesRequest: AnthropicMessagesRequest:
type: object type: object
properties: properties:
@@ -6937,6 +6979,14 @@ components:
- disabled - disabled
required: required:
- type - type
- type: object
properties:
type:
type: string
enum:
- adaptive
required:
- type
service_tier: service_tier:
type: string type: string
enum: enum:
@@ -7160,10 +7210,31 @@ components:
A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for 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 observability. If provided in both the request body and the x-session-id header, the body value takes
precedence. Maximum of 128 characters. precedence. Maximum of 128 characters.
trace:
type: object
properties:
trace_id:
type: string
trace_name:
type: string
span_name:
type: string
generation_name:
type: string
parent_span_id:
type: string
additionalProperties:
nullable: true
description: >-
Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name,
parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured
broadcast destinations.
models: models:
type: array type: array
items: items:
type: string type: string
output_config:
$ref: '#/components/schemas/AnthropicOutputConfig'
required: required:
- model - model
- max_tokens - max_tokens
@@ -7265,7 +7336,7 @@ components:
description: Error data for ForbiddenResponse description: Error data for ForbiddenResponse
example: example:
code: 403 code: 403
message: Only provisioning keys can perform this operation message: Only management keys can perform this operation
ForbiddenResponse: ForbiddenResponse:
type: object type: object
properties: properties:
@@ -7280,7 +7351,7 @@ components:
example: example:
error: error:
code: 403 code: 403
message: Only provisioning keys can perform this operation message: Only management keys can perform this operation
CreateChargeRequest: CreateChargeRequest:
type: object type: object
properties: properties:
@@ -8499,6 +8570,20 @@ components:
type: string type: string
maxLength: 128 maxLength: 128
__schema19: __schema19:
type: object
properties:
trace_id:
type: string
trace_name:
type: string
span_name:
type: string
generation_name:
type: string
parent_span_id:
type: string
additionalProperties: {}
__schema20:
oneOf: oneOf:
- type: object - type: object
properties: properties:
@@ -8508,9 +8593,9 @@ components:
summary: summary:
type: string type: string
id: id:
$ref: '#/components/schemas/__schema20'
format:
$ref: '#/components/schemas/__schema21' $ref: '#/components/schemas/__schema21'
format:
$ref: '#/components/schemas/__schema22'
index: index:
$ref: '#/components/schemas/__schema11' $ref: '#/components/schemas/__schema11'
required: required:
@@ -8524,9 +8609,9 @@ components:
data: data:
type: string type: string
id: id:
$ref: '#/components/schemas/__schema20'
format:
$ref: '#/components/schemas/__schema21' $ref: '#/components/schemas/__schema21'
format:
$ref: '#/components/schemas/__schema22'
index: index:
$ref: '#/components/schemas/__schema11' $ref: '#/components/schemas/__schema11'
required: required:
@@ -8546,19 +8631,19 @@ components:
- type: string - type: string
- type: 'null' - type: 'null'
id: id:
$ref: '#/components/schemas/__schema20'
format:
$ref: '#/components/schemas/__schema21' $ref: '#/components/schemas/__schema21'
format:
$ref: '#/components/schemas/__schema22'
index: index:
$ref: '#/components/schemas/__schema11' $ref: '#/components/schemas/__schema11'
required: required:
- type - type
type: object type: object
__schema20: __schema21:
anyOf: anyOf:
- type: string - type: string
- type: 'null' - type: 'null'
__schema21: __schema22:
anyOf: anyOf:
- type: string - type: string
enum: enum:
@@ -8569,7 +8654,7 @@ components:
- anthropic-claude-v1 - anthropic-claude-v1
- google-gemini-v1 - google-gemini-v1
- type: 'null' - type: 'null'
__schema25: __schema26:
anyOf: anyOf:
- $ref: '#/components/schemas/ChatCompletionFinishReason' - $ref: '#/components/schemas/ChatCompletionFinishReason'
- type: 'null' - type: 'null'
@@ -8945,7 +9030,7 @@ components:
reasoning_details: reasoning_details:
type: array type: array
items: items:
$ref: '#/components/schemas/__schema19' $ref: '#/components/schemas/__schema20'
images: images:
type: array type: array
items: items:
@@ -9078,6 +9163,12 @@ components:
observability. If provided in both the request body and the x-session-id header, the body value takes observability. If provided in both the request body and the x-session-id header, the body value takes
precedence. Maximum of 128 characters. precedence. Maximum of 128 characters.
$ref: '#/components/schemas/__schema18' $ref: '#/components/schemas/__schema18'
trace:
description: >-
Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name,
parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured
broadcast destinations.
$ref: '#/components/schemas/__schema19'
messages: messages:
minItems: 1 minItems: 1
type: array type: array
@@ -9253,7 +9344,7 @@ components:
type: object type: object
properties: properties:
finish_reason: finish_reason:
$ref: '#/components/schemas/__schema25' $ref: '#/components/schemas/__schema26'
index: index:
type: number type: number
message: message:
@@ -9311,14 +9402,14 @@ components:
reasoning_details: reasoning_details:
type: array type: array
items: items:
$ref: '#/components/schemas/__schema19' $ref: '#/components/schemas/__schema20'
ChatStreamingChoice: ChatStreamingChoice:
type: object type: object
properties: properties:
delta: delta:
$ref: '#/components/schemas/ChatStreamingMessageChunk' $ref: '#/components/schemas/ChatStreamingMessageChunk'
finish_reason: finish_reason:
$ref: '#/components/schemas/__schema25' $ref: '#/components/schemas/__schema26'
index: index:
type: number type: number
logprobs: logprobs:
@@ -9789,8 +9880,8 @@ paths:
operationId: getUserActivity operationId: getUserActivity
summary: Get user activity grouped by endpoint summary: Get user activity grouped by endpoint
description: >- description: >-
Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Provisioning Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -9841,7 +9932,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/UnauthorizedResponse' $ref: '#/components/schemas/UnauthorizedResponse'
'403': '403':
description: Forbidden - Only provisioning keys can fetch activity description: Forbidden - Only management keys can fetch activity
content: content:
application/json: application/json:
schema: schema:
@@ -9860,8 +9951,8 @@ paths:
summary: Get remaining credits summary: Get remaining credits
operationId: getCredits operationId: getCredits
description: >- description: >-
Get total credits purchased and used for the authenticated user. [Provisioning Get total credits purchased and used for the authenticated user. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
responses: responses:
'200': '200':
description: Returns the total credits purchased and used description: Returns the total credits purchased and used
@@ -9901,7 +9992,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/UnauthorizedResponse' $ref: '#/components/schemas/UnauthorizedResponse'
'403': '403':
description: Forbidden - Only provisioning keys can fetch credits description: Forbidden - Only management keys can fetch credits
content: content:
application/json: application/json:
schema: schema:
@@ -10924,8 +11015,8 @@ paths:
- API Keys - API Keys
summary: List API keys summary: List API keys
description: >- description: >-
List all API keys for the authenticated user. [Provisioning List all API keys for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys)
key](/docs/guides/overview/auth/provisioning-api-keys) required. required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -11125,8 +11216,8 @@ paths:
- API Keys - API Keys
summary: Create a new API key summary: Create a new API key
description: >- description: >-
Create a new API key for the authenticated user. [Provisioning Create a new API key for the authenticated user. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -11368,7 +11459,7 @@ paths:
tags: tags:
- API Keys - API Keys
summary: Update an API key summary: Update an API key
description: Update an existing API key. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Update an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -11611,7 +11702,7 @@ paths:
tags: tags:
- API Keys - API Keys
summary: Delete an API key summary: Delete an API key
description: Delete an existing API key. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Delete an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -11669,7 +11760,7 @@ paths:
tags: tags:
- API Keys - API Keys
summary: Get a single API key summary: Get a single API key
description: Get a single API key by hash. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Get a single API key by hash. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -11867,8 +11958,8 @@ paths:
- Guardrails - Guardrails
summary: List guardrails summary: List guardrails
description: >- description: >-
List all guardrails for the authenticated user. [Provisioning List all guardrails for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys)
key](/docs/guides/overview/auth/provisioning-api-keys) required. required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12024,8 +12115,8 @@ paths:
- Guardrails - Guardrails
summary: Create a guardrail summary: Create a guardrail
description: >- description: >-
Create a new guardrail for the authenticated user. [Provisioning Create a new guardrail for the authenticated user. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -12237,7 +12328,7 @@ paths:
tags: tags:
- Guardrails - Guardrails
summary: Get a guardrail summary: Get a guardrail
description: Get a single guardrail by ID. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Get a single guardrail by ID. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12383,7 +12474,7 @@ paths:
tags: tags:
- Guardrails - Guardrails
summary: Update a guardrail summary: Update a guardrail
description: Update an existing guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Update an existing guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12598,7 +12689,7 @@ paths:
tags: tags:
- Guardrails - Guardrails
summary: Delete a guardrail summary: Delete a guardrail
description: Delete an existing guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Delete an existing guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12652,8 +12743,8 @@ paths:
- Guardrails - Guardrails
summary: List all key assignments summary: List all key assignments
description: >- description: >-
List all API key guardrail assignments for the authenticated user. [Provisioning List all API key guardrail assignments for the authenticated user. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12751,8 +12842,8 @@ paths:
- Guardrails - Guardrails
summary: List all member assignments summary: List all member assignments
description: >- description: >-
List all organization member guardrail assignments for the authenticated user. [Provisioning List all organization member guardrail assignments for the authenticated user. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12845,8 +12936,8 @@ paths:
- Guardrails - Guardrails
summary: List key assignments for a guardrail summary: List key assignments for a guardrail
description: >- description: >-
List all API key assignments for a specific guardrail. [Provisioning List all API key assignments for a specific guardrail. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12958,8 +13049,8 @@ paths:
- Guardrails - Guardrails
summary: Bulk assign keys to a guardrail summary: Bulk assign keys to a guardrail
description: >- description: >-
Assign multiple API keys to a specific guardrail. [Provisioning Assign multiple API keys to a specific guardrail. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13034,8 +13125,8 @@ paths:
- Guardrails - Guardrails
summary: List member assignments for a guardrail summary: List member assignments for a guardrail
description: >- description: >-
List all organization member assignments for a specific guardrail. [Provisioning List all organization member assignments for a specific guardrail. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13142,8 +13233,8 @@ paths:
- Guardrails - Guardrails
summary: Bulk assign members to a guardrail summary: Bulk assign members to a guardrail
description: >- description: >-
Assign multiple organization members to a specific guardrail. [Provisioning Assign multiple organization members to a specific guardrail. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13219,8 +13310,8 @@ paths:
- Guardrails - Guardrails
summary: Bulk unassign keys from a guardrail summary: Bulk unassign keys from a guardrail
description: >- description: >-
Unassign multiple API keys from a specific guardrail. [Provisioning Unassign multiple API keys from a specific guardrail. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13295,8 +13386,8 @@ paths:
- Guardrails - Guardrails
summary: Bulk unassign members from a guardrail summary: Bulk unassign members from a guardrail
description: >- description: >-
Unassign multiple organization members from a specific guardrail. [Provisioning Unassign multiple organization members from a specific guardrail. [Management
key](/docs/guides/overview/auth/provisioning-api-keys) required. key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13428,9 +13519,14 @@ paths:
type: boolean type: boolean
description: Whether this is a free tier API key description: Whether this is a free tier API key
example: false example: false
is_management_key:
type: boolean
description: Whether this is a management key
example: false
is_provisioning_key: is_provisioning_key:
type: boolean type: boolean
description: Whether this is a provisioning key description: Whether this is a management key
deprecated: true
example: false example: false
limit_remaining: limit_remaining:
type: number type: number
@@ -13489,6 +13585,7 @@ paths:
- byok_usage_weekly - byok_usage_weekly
- byok_usage_monthly - byok_usage_monthly
- is_free_tier - is_free_tier
- is_management_key
- is_provisioning_key - is_provisioning_key
- limit_remaining - limit_remaining
- limit_reset - limit_reset
@@ -13507,6 +13604,7 @@ paths:
byok_usage_weekly: 17.38 byok_usage_weekly: 17.38
byok_usage_monthly: 17.38 byok_usage_monthly: 17.38
is_free_tier: false is_free_tier: false
is_management_key: false
is_provisioning_key: false is_provisioning_key: false
limit_remaining: 74.5 limit_remaining: 74.5
limit_reset: monthly limit_reset: monthly
@@ -13531,6 +13629,7 @@ paths:
byok_usage_weekly: 17.38 byok_usage_weekly: 17.38
byok_usage_monthly: 17.38 byok_usage_monthly: 17.38
is_free_tier: false is_free_tier: false
is_management_key: false
is_provisioning_key: false is_provisioning_key: false
limit_remaining: 74.5 limit_remaining: 74.5
limit_reset: monthly limit_reset: monthly
+217 -40
View File
@@ -4097,6 +4097,23 @@ components:
maxLength: 128 maxLength: 128
description: >- description: >-
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. 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.
trace:
type: object
properties:
trace_id:
type: string
trace_name:
type: string
span_name:
type: string
generation_name:
type: string
parent_span_id:
type: string
additionalProperties:
nullable: true
description: >-
Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.
description: Request schema for Responses endpoint description: Request schema for Responses endpoint
example: example:
model: anthropic/claude-4.5-sonnet-20250929 model: anthropic/claude-4.5-sonnet-20250929
@@ -4407,7 +4424,6 @@ components:
- tool_use - tool_use
- pause_turn - pause_turn
- refusal - refusal
- model_context_window_exceeded
x-speakeasy-unknown-values: allow x-speakeasy-unknown-values: allow
stop_sequence: stop_sequence:
type: string type: string
@@ -4436,6 +4452,9 @@ components:
required: required:
- ephemeral_5m_input_tokens - ephemeral_5m_input_tokens
- ephemeral_1h_input_tokens - ephemeral_1h_input_tokens
inference_geo:
type: string
nullable: true
server_tool_use: server_tool_use:
type: object type: object
nullable: true nullable: true
@@ -4458,6 +4477,7 @@ components:
- cache_creation_input_tokens - cache_creation_input_tokens
- cache_read_input_tokens - cache_read_input_tokens
- cache_creation - cache_creation
- inference_geo
- server_tool_use - server_tool_use
- service_tier - service_tier
required: required:
@@ -4492,6 +4512,7 @@ components:
cache_creation_input_tokens: null cache_creation_input_tokens: null
cache_read_input_tokens: null cache_read_input_tokens: null
cache_creation: null cache_creation: null
inference_geo: null
server_tool_use: null server_tool_use: null
service_tier: standard service_tier: standard
AnthropicMessagesStreamEvent: AnthropicMessagesStreamEvent:
@@ -4812,6 +4833,9 @@ components:
required: required:
- ephemeral_5m_input_tokens - ephemeral_5m_input_tokens
- ephemeral_1h_input_tokens - ephemeral_1h_input_tokens
inference_geo:
type: string
nullable: true
server_tool_use: server_tool_use:
type: object type: object
nullable: true nullable: true
@@ -4834,6 +4858,7 @@ components:
- cache_creation_input_tokens - cache_creation_input_tokens
- cache_read_input_tokens - cache_read_input_tokens
- cache_creation - cache_creation
- inference_geo
- server_tool_use - server_tool_use
- service_tier - service_tier
required: required:
@@ -4867,7 +4892,6 @@ components:
- tool_use - tool_use
- pause_turn - pause_turn
- refusal - refusal
- model_context_window_exceeded
x-speakeasy-unknown-values: allow x-speakeasy-unknown-values: allow
stop_sequence: stop_sequence:
type: string type: string
@@ -6552,6 +6576,22 @@ components:
- role - role
- content - content
description: Anthropic message with OpenRouter extensions description: Anthropic message with OpenRouter extensions
AnthropicOutputConfig:
type: object
properties:
effort:
type: string
nullable: true
enum:
- low
- medium
- high
- max
description: >-
How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, or `max`.
example: medium
x-speakeasy-unknown-values: allow
description: Configuration for controlling output behavior. Currently supports the effort parameter for Claude Opus 4.5.
AnthropicMessagesRequest: AnthropicMessagesRequest:
type: object type: object
properties: properties:
@@ -6970,6 +7010,14 @@ components:
- disabled - disabled
required: required:
- type - type
- type: object
properties:
type:
type: string
enum:
- adaptive
required:
- type
service_tier: service_tier:
type: string type: string
enum: enum:
@@ -7178,10 +7226,29 @@ components:
maxLength: 128 maxLength: 128
description: >- description: >-
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. 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.
trace:
type: object
properties:
trace_id:
type: string
trace_name:
type: string
span_name:
type: string
generation_name:
type: string
parent_span_id:
type: string
additionalProperties:
nullable: true
description: >-
Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.
models: models:
type: array type: array
items: items:
type: string type: string
output_config:
$ref: '#/components/schemas/AnthropicOutputConfig'
required: required:
- model - model
- max_tokens - max_tokens
@@ -7283,7 +7350,7 @@ components:
description: Error data for ForbiddenResponse description: Error data for ForbiddenResponse
example: example:
code: 403 code: 403
message: Only provisioning keys can perform this operation message: Only management keys can perform this operation
ForbiddenResponse: ForbiddenResponse:
type: object type: object
properties: properties:
@@ -7298,7 +7365,7 @@ components:
example: example:
error: error:
code: 403 code: 403
message: Only provisioning keys can perform this operation message: Only management keys can perform this operation
CreateChargeRequest: CreateChargeRequest:
type: object type: object
properties: properties:
@@ -8503,6 +8570,20 @@ components:
type: string type: string
maxLength: 128 maxLength: 128
__schema19: __schema19:
type: object
properties:
trace_id:
type: string
trace_name:
type: string
span_name:
type: string
generation_name:
type: string
parent_span_id:
type: string
additionalProperties: {}
__schema20:
oneOf: oneOf:
- type: object - type: object
properties: properties:
@@ -8512,9 +8593,9 @@ components:
summary: summary:
type: string type: string
id: id:
$ref: '#/components/schemas/__schema20'
format:
$ref: '#/components/schemas/__schema21' $ref: '#/components/schemas/__schema21'
format:
$ref: '#/components/schemas/__schema22'
index: index:
$ref: '#/components/schemas/__schema11' $ref: '#/components/schemas/__schema11'
required: required:
@@ -8528,9 +8609,9 @@ components:
data: data:
type: string type: string
id: id:
$ref: '#/components/schemas/__schema20'
format:
$ref: '#/components/schemas/__schema21' $ref: '#/components/schemas/__schema21'
format:
$ref: '#/components/schemas/__schema22'
index: index:
$ref: '#/components/schemas/__schema11' $ref: '#/components/schemas/__schema11'
required: required:
@@ -8550,19 +8631,19 @@ components:
- type: string - type: string
- type: 'null' - type: 'null'
id: id:
$ref: '#/components/schemas/__schema20'
format:
$ref: '#/components/schemas/__schema21' $ref: '#/components/schemas/__schema21'
format:
$ref: '#/components/schemas/__schema22'
index: index:
$ref: '#/components/schemas/__schema11' $ref: '#/components/schemas/__schema11'
required: required:
- type - type
type: object type: object
__schema20: __schema21:
anyOf: anyOf:
- type: string - type: string
- type: 'null' - type: 'null'
__schema21: __schema22:
anyOf: anyOf:
- type: string - type: string
enum: enum:
@@ -8574,7 +8655,7 @@ components:
- google-gemini-v1 - google-gemini-v1
x-speakeasy-unknown-values: allow x-speakeasy-unknown-values: allow
- type: 'null' - type: 'null'
__schema25: __schema26:
anyOf: anyOf:
- $ref: '#/components/schemas/ChatCompletionFinishReason' - $ref: '#/components/schemas/ChatCompletionFinishReason'
- type: 'null' - type: 'null'
@@ -8953,7 +9034,7 @@ components:
reasoning_details: reasoning_details:
type: array type: array
items: items:
$ref: '#/components/schemas/__schema19' $ref: '#/components/schemas/__schema20'
images: images:
type: array type: array
items: items:
@@ -9085,6 +9166,10 @@ components:
description: >- description: >-
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. 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.
$ref: '#/components/schemas/__schema18' $ref: '#/components/schemas/__schema18'
trace:
description: >-
Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.
$ref: '#/components/schemas/__schema19'
messages: messages:
minItems: 1 minItems: 1
type: array type: array
@@ -9262,7 +9347,7 @@ components:
type: object type: object
properties: properties:
finish_reason: finish_reason:
$ref: '#/components/schemas/__schema25' $ref: '#/components/schemas/__schema26'
index: index:
type: number type: number
message: message:
@@ -9320,14 +9405,14 @@ components:
reasoning_details: reasoning_details:
type: array type: array
items: items:
$ref: '#/components/schemas/__schema19' $ref: '#/components/schemas/__schema20'
ChatStreamingChoice: ChatStreamingChoice:
type: object type: object
properties: properties:
delta: delta:
$ref: '#/components/schemas/ChatStreamingMessageChunk' $ref: '#/components/schemas/ChatStreamingMessageChunk'
finish_reason: finish_reason:
$ref: '#/components/schemas/__schema25' $ref: '#/components/schemas/__schema26'
index: index:
type: number type: number
logprobs: logprobs:
@@ -9562,6 +9647,9 @@ paths:
schema: schema:
$ref: '#/components/schemas/ProviderOverloadedResponse' $ref: '#/components/schemas/ProviderOverloadedResponse'
operationId: createResponses operationId: createResponses
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/messages: /messages:
post: post:
x-speakeasy-ignore: true x-speakeasy-ignore: true
@@ -9790,6 +9878,9 @@ paths:
- type - type
- error - error
operationId: createMessages operationId: createMessages
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/activity: /activity:
get: get:
tags: tags:
@@ -9797,7 +9888,7 @@ paths:
operationId: getUserActivity operationId: getUserActivity
summary: Get user activity grouped by endpoint summary: Get user activity grouped by endpoint
description: >- description: >-
Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -9848,7 +9939,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/UnauthorizedResponse' $ref: '#/components/schemas/UnauthorizedResponse'
'403': '403':
description: Forbidden - Only provisioning keys can fetch activity description: Forbidden - Only management keys can fetch activity
content: content:
application/json: application/json:
schema: schema:
@@ -9859,6 +9950,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/credits: /credits:
get: get:
x-speakeasy-name-override: getCredits x-speakeasy-name-override: getCredits
@@ -9867,7 +9961,7 @@ paths:
summary: Get remaining credits summary: Get remaining credits
operationId: getCredits operationId: getCredits
description: >- description: >-
Get total credits purchased and used for the authenticated user. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Get total credits purchased and used for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
responses: responses:
'200': '200':
description: Returns the total credits purchased and used description: Returns the total credits purchased and used
@@ -9907,7 +10001,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/UnauthorizedResponse' $ref: '#/components/schemas/UnauthorizedResponse'
'403': '403':
description: Forbidden - Only provisioning keys can fetch credits description: Forbidden - Only management keys can fetch credits
content: content:
application/json: application/json:
schema: schema:
@@ -9918,6 +10012,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/credits/coinbase: /credits/coinbase:
post: post:
security: security:
@@ -10040,6 +10137,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/embeddings: /embeddings:
post: post:
x-speakeasy-name-override: generate x-speakeasy-name-override: generate
@@ -10244,6 +10344,9 @@ paths:
schema: schema:
$ref: '#/components/schemas/ProviderOverloadedResponse' $ref: '#/components/schemas/ProviderOverloadedResponse'
operationId: createEmbeddings operationId: createEmbeddings
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/embeddings/models: /embeddings/models:
get: get:
tags: tags:
@@ -10271,6 +10374,9 @@ paths:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
operationId: listEmbeddingsModels operationId: listEmbeddingsModels
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/generation: /generation:
get: get:
tags: tags:
@@ -10669,6 +10775,9 @@ paths:
schema: schema:
$ref: '#/components/schemas/ProviderOverloadedResponse' $ref: '#/components/schemas/ProviderOverloadedResponse'
operationId: getGeneration operationId: getGeneration
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/models/count: /models/count:
get: get:
tags: tags:
@@ -10689,6 +10798,9 @@ paths:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
operationId: listModelsCount operationId: listModelsCount
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/models: /models:
get: get:
tags: tags:
@@ -10743,6 +10855,9 @@ paths:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
operationId: getModels operationId: getModels
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/models/user: /models/user:
get: get:
tags: tags:
@@ -10779,6 +10894,9 @@ paths:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
operationId: listModelsUser operationId: listModelsUser
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/models/{author}/{slug}/endpoints: /models/{author}/{slug}/endpoints:
get: get:
tags: tags:
@@ -10821,6 +10939,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/endpoints/zdr: /endpoints/zdr:
get: get:
tags: tags:
@@ -10848,6 +10969,9 @@ paths:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
operationId: listEndpointsZdr operationId: listEndpointsZdr
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/providers: /providers:
get: get:
tags: tags:
@@ -10909,6 +11033,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/keys: /keys:
get: get:
operationId: list operationId: list
@@ -10917,7 +11044,7 @@ paths:
- API Keys - API Keys
summary: List API keys summary: List API keys
description: >- description: >-
List all API keys for the authenticated user. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. List all API keys for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -11117,7 +11244,7 @@ paths:
- API Keys - API Keys
summary: Create a new API key summary: Create a new API key
description: >- description: >-
Create a new API key for the authenticated user. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Create a new API key for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -11352,13 +11479,16 @@ paths:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
operationId: createKeys operationId: createKeys
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/keys/{hash}: /keys/{hash}:
patch: patch:
x-speakeasy-name-override: update x-speakeasy-name-override: update
tags: tags:
- API Keys - API Keys
summary: Update an API key summary: Update an API key
description: Update an existing API key. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Update an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -11601,7 +11731,7 @@ paths:
tags: tags:
- API Keys - API Keys
summary: Delete an API key summary: Delete an API key
description: Delete an existing API key. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Delete an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -11659,7 +11789,7 @@ paths:
tags: tags:
- API Keys - API Keys
summary: Get a single API key summary: Get a single API key
description: Get a single API key by hash. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Get a single API key by hash. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -11849,6 +11979,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/guardrails: /guardrails:
get: get:
operationId: listGuardrails operationId: listGuardrails
@@ -11857,7 +11990,7 @@ paths:
- Guardrails - Guardrails
summary: List guardrails summary: List guardrails
description: >- description: >-
List all guardrails for the authenticated user. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. List all guardrails for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12014,7 +12147,7 @@ paths:
- Guardrails - Guardrails
summary: Create a guardrail summary: Create a guardrail
description: >- description: >-
Create a new guardrail for the authenticated user. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Create a new guardrail for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -12221,6 +12354,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/guardrails/{id}: /guardrails/{id}:
get: get:
operationId: getGuardrail operationId: getGuardrail
@@ -12228,7 +12364,7 @@ paths:
tags: tags:
- Guardrails - Guardrails
summary: Get a guardrail summary: Get a guardrail
description: Get a single guardrail by ID. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Get a single guardrail by ID. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12375,7 +12511,7 @@ paths:
tags: tags:
- Guardrails - Guardrails
summary: Update a guardrail summary: Update a guardrail
description: Update an existing guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Update an existing guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12592,7 +12728,7 @@ paths:
tags: tags:
- Guardrails - Guardrails
summary: Delete a guardrail summary: Delete a guardrail
description: Delete an existing guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. description: Delete an existing guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12638,6 +12774,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/guardrails/assignments/keys: /guardrails/assignments/keys:
get: get:
operationId: listKeyAssignments operationId: listKeyAssignments
@@ -12646,7 +12785,7 @@ paths:
- Guardrails - Guardrails
summary: List all key assignments summary: List all key assignments
description: >- description: >-
List all API key guardrail assignments for the authenticated user. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. List all API key guardrail assignments for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12736,6 +12875,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/guardrails/assignments/members: /guardrails/assignments/members:
get: get:
operationId: listMemberAssignments operationId: listMemberAssignments
@@ -12744,7 +12886,7 @@ paths:
- Guardrails - Guardrails
summary: List all member assignments summary: List all member assignments
description: >- description: >-
List all organization member guardrail assignments for the authenticated user. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. List all organization member guardrail assignments for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12829,6 +12971,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/guardrails/{id}/assignments/keys: /guardrails/{id}/assignments/keys:
get: get:
operationId: listGuardrailKeyAssignments operationId: listGuardrailKeyAssignments
@@ -12837,7 +12982,7 @@ paths:
- Guardrails - Guardrails
summary: List key assignments for a guardrail summary: List key assignments for a guardrail
description: >- description: >-
List all API key assignments for a specific guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. List all API key assignments for a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -12949,7 +13094,7 @@ paths:
- Guardrails - Guardrails
summary: Bulk assign keys to a guardrail summary: Bulk assign keys to a guardrail
description: >- description: >-
Assign multiple API keys to a specific guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Assign multiple API keys to a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13016,6 +13161,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/guardrails/{id}/assignments/members: /guardrails/{id}/assignments/members:
get: get:
operationId: listGuardrailMemberAssignments operationId: listGuardrailMemberAssignments
@@ -13024,7 +13172,7 @@ paths:
- Guardrails - Guardrails
summary: List member assignments for a guardrail summary: List member assignments for a guardrail
description: >- description: >-
List all organization member assignments for a specific guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. List all organization member assignments for a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13131,7 +13279,7 @@ paths:
- Guardrails - Guardrails
summary: Bulk assign members to a guardrail summary: Bulk assign members to a guardrail
description: >- description: >-
Assign multiple organization members to a specific guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Assign multiple organization members to a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13199,6 +13347,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/guardrails/{id}/assignments/keys/remove: /guardrails/{id}/assignments/keys/remove:
post: post:
operationId: bulkUnassignKeysFromGuardrail operationId: bulkUnassignKeysFromGuardrail
@@ -13207,7 +13358,7 @@ paths:
- Guardrails - Guardrails
summary: Bulk unassign keys from a guardrail summary: Bulk unassign keys from a guardrail
description: >- description: >-
Unassign multiple API keys from a specific guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Unassign multiple API keys from a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13274,6 +13425,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/guardrails/{id}/assignments/members/remove: /guardrails/{id}/assignments/members/remove:
post: post:
operationId: bulkUnassignMembersFromGuardrail operationId: bulkUnassignMembersFromGuardrail
@@ -13282,7 +13436,7 @@ paths:
- Guardrails - Guardrails
summary: Bulk unassign members from a guardrail summary: Bulk unassign members from a guardrail
description: >- description: >-
Unassign multiple organization members from a specific guardrail. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Unassign multiple organization members from a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required.
parameters: parameters:
- schema: - schema:
type: string type: string
@@ -13350,6 +13504,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/key: /key:
get: get:
operationId: getCurrentKey operationId: getCurrentKey
@@ -13414,9 +13571,14 @@ paths:
type: boolean type: boolean
description: Whether this is a free tier API key description: Whether this is a free tier API key
example: false example: false
is_management_key:
type: boolean
description: Whether this is a management key
example: false
is_provisioning_key: is_provisioning_key:
type: boolean type: boolean
description: Whether this is a provisioning key description: Whether this is a management key
deprecated: true
example: false example: false
limit_remaining: limit_remaining:
type: number type: number
@@ -13475,6 +13637,7 @@ paths:
- byok_usage_weekly - byok_usage_weekly
- byok_usage_monthly - byok_usage_monthly
- is_free_tier - is_free_tier
- is_management_key
- is_provisioning_key - is_provisioning_key
- limit_remaining - limit_remaining
- limit_reset - limit_reset
@@ -13493,6 +13656,7 @@ paths:
byok_usage_weekly: 17.38 byok_usage_weekly: 17.38
byok_usage_monthly: 17.38 byok_usage_monthly: 17.38
is_free_tier: false is_free_tier: false
is_management_key: false
is_provisioning_key: false is_provisioning_key: false
limit_remaining: 74.5 limit_remaining: 74.5
limit_reset: monthly limit_reset: monthly
@@ -13517,6 +13681,7 @@ paths:
byok_usage_weekly: 17.38 byok_usage_weekly: 17.38
byok_usage_monthly: 17.38 byok_usage_monthly: 17.38
is_free_tier: false is_free_tier: false
is_management_key: false
is_provisioning_key: false is_provisioning_key: false
limit_remaining: 74.5 limit_remaining: 74.5
limit_reset: monthly limit_reset: monthly
@@ -13538,6 +13703,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/auth/keys: /auth/keys:
post: post:
operationId: exchangeAuthCodeForAPIKey operationId: exchangeAuthCodeForAPIKey
@@ -13616,6 +13784,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/auth/keys/code: /auth/keys/code:
post: post:
x-speakeasy-name-override: createAuthCode x-speakeasy-name-override: createAuthCode
@@ -13717,6 +13888,9 @@ paths:
schema: schema:
$ref: '#/components/schemas/InternalServerResponse' $ref: '#/components/schemas/InternalServerResponse'
operationId: createAuthKeysCode operationId: createAuthKeysCode
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
/chat/completions: /chat/completions:
post: post:
summary: Create a chat completion summary: Create a chat completion
@@ -13771,6 +13945,9 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ChatError' $ref: '#/components/schemas/ChatError'
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
servers: servers:
- url: https://openrouter.ai/api/v1 - url: https://openrouter.ai/api/v1
description: Production server description: Production server
@@ -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"
+5 -5
View File
@@ -8,8 +8,8 @@ sources:
- latest - latest
OpenRouter API: OpenRouter API:
sourceNamespace: open-router-chat-completions-api sourceNamespace: open-router-chat-completions-api
sourceRevisionDigest: sha256:081a51121f970e44311f1415c10c22b1838d1d1b6057280a3e6cba78acab1dca sourceRevisionDigest: sha256:79b8d064e91a2614d9853eb640f9e7255a8b1e9614882641ab5c75ac071814d6
sourceBlobDigest: sha256:fc6bdfffd4edd78b043363b817794d80faaa927b5b4b7e8f149fda68084dac13 sourceBlobDigest: sha256:b74fe6d34af037172e5b80f6d03b85df45eb5360577027682ea7d3fd308e8293
tags: tags:
- latest - latest
- main - main
@@ -18,10 +18,10 @@ targets:
open-router: open-router:
source: OpenRouter API source: OpenRouter API
sourceNamespace: open-router-chat-completions-api sourceNamespace: open-router-chat-completions-api
sourceRevisionDigest: sha256:081a51121f970e44311f1415c10c22b1838d1d1b6057280a3e6cba78acab1dca sourceRevisionDigest: sha256:79b8d064e91a2614d9853eb640f9e7255a8b1e9614882641ab5c75ac071814d6
sourceBlobDigest: sha256:fc6bdfffd4edd78b043363b817794d80faaa927b5b4b7e8f149fda68084dac13 sourceBlobDigest: sha256:b74fe6d34af037172e5b80f6d03b85df45eb5360577027682ea7d3fd308e8293
codeSamplesNamespace: open-router-python-code-samples codeSamplesNamespace: open-router-python-code-samples
codeSamplesRevisionDigest: sha256:c48795939148c825d881d736e1b7a8d884b6b7e3f66114a5e11d4ed532b75baa codeSamplesRevisionDigest: sha256:ff5b83e50996943aaf26b9089fd02488fc49b8c5f742dc432135c8eeb69c7042
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: 1.666.0 speakeasyVersion: 1.666.0
+4
View File
@@ -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...
+4
View File
@@ -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:
+1 -1
View File
@@ -11,5 +11,5 @@
| `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 | | `reasoning_details` | List[[components.Schema20](../components/schema20.md)] | :heavy_minus_sign: | N/A |
| `images` | List[[components.Image](../components/image.md)] | :heavy_minus_sign: | N/A | | `images` | List[[components.Image](../components/image.md)] | :heavy_minus_sign: | N/A |
+1
View File
@@ -10,6 +10,7 @@
| `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: | N/A | | `session_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `trace` | [Optional[components.Schema19]](../components/schema19.md) | :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 |
+1 -1
View File
@@ -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.Schema19](../components/schema19.md)] | :heavy_minus_sign: | N/A | | `reasoning_details` | List[[components.Schema20](../components/schema20.md)] | :heavy_minus_sign: | N/A |
+1
View File
@@ -41,3 +41,4 @@ Request schema for Responses endpoint
| `plugins` | List[[components.Plugin](../components/plugin.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. | |
| `trace` | [Optional[components.Trace]](../components/trace.md) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | |
+9 -19
View File
@@ -1,23 +1,13 @@
# Schema19 # Schema19
## Supported Types ## Fields
### `components.Schema19ReasoningSummary`
```python
value: components.Schema19ReasoningSummary = /* values here */
```
### `components.Schema19ReasoningEncrypted`
```python
value: components.Schema19ReasoningEncrypted = /* values here */
```
### `components.Schema19ReasoningText`
```python
value: components.Schema19ReasoningText = /* values here */
```
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `trace_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `trace_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `span_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `generation_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `parent_span_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A |
+23
View File
@@ -0,0 +1,23 @@
# Schema20
## Supported Types
### `components.Schema20ReasoningSummary`
```python
value: components.Schema20ReasoningSummary = /* values here */
```
### `components.Schema20ReasoningEncrypted`
```python
value: components.Schema20ReasoningEncrypted = /* values here */
```
### `components.Schema20ReasoningText`
```python
value: components.Schema20ReasoningText = /* values here */
```
@@ -1,4 +1,4 @@
# Schema19ReasoningEncrypted # Schema20ReasoningEncrypted
## Fields ## Fields
@@ -8,5 +8,5 @@
| `type` | *Literal["reasoning.encrypted"]* | :heavy_check_mark: | N/A | | `type` | *Literal["reasoning.encrypted"]* | :heavy_check_mark: | N/A |
| `data` | *str* | :heavy_check_mark: | N/A | | `data` | *str* | :heavy_check_mark: | N/A |
| `id` | *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 | | `format_` | [OptionalNullable[components.Schema22]](../components/schema22.md) | :heavy_minus_sign: | N/A |
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A | | `index` | *Optional[float]* | :heavy_minus_sign: | N/A |
@@ -1,4 +1,4 @@
# Schema19ReasoningSummary # Schema20ReasoningSummary
## Fields ## Fields
@@ -8,5 +8,5 @@
| `type` | *Literal["reasoning.summary"]* | :heavy_check_mark: | N/A | | `type` | *Literal["reasoning.summary"]* | :heavy_check_mark: | N/A |
| `summary` | *str* | :heavy_check_mark: | N/A | | `summary` | *str* | :heavy_check_mark: | N/A |
| `id` | *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 | | `format_` | [OptionalNullable[components.Schema22]](../components/schema22.md) | :heavy_minus_sign: | N/A |
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A | | `index` | *Optional[float]* | :heavy_minus_sign: | N/A |
@@ -1,4 +1,4 @@
# Schema19ReasoningText # Schema20ReasoningText
## Fields ## Fields
@@ -9,5 +9,5 @@
| `text` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `text` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `id` | *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 | | `format_` | [OptionalNullable[components.Schema22]](../components/schema22.md) | :heavy_minus_sign: | N/A |
| `index` | *Optional[float]* | :heavy_minus_sign: | N/A | | `index` | *Optional[float]* | :heavy_minus_sign: | N/A |
@@ -1,4 +1,4 @@
# Schema21 # Schema22
## Values ## Values
+15
View File
@@ -0,0 +1,15 @@
# Trace
Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.
## Fields
| Field | Type | Required | Description |
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
| `trace_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `trace_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `span_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `generation_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `parent_span_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A |
+1 -1
View File
@@ -7,5 +7,5 @@ Forbidden - Authentication successful but insufficient permissions
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `error` | [components.ForbiddenResponseErrorData](../components/forbiddenresponseerrordata.md) | :heavy_check_mark: | Error data for ForbiddenResponse | {<br/>"code": 403,<br/>"message": "Only provisioning keys can perform this operation"<br/>} | | `error` | [components.ForbiddenResponseErrorData](../components/forbiddenresponseerrordata.md) | :heavy_check_mark: | Error data for ForbiddenResponse | {<br/>"code": 403,<br/>"message": "Only management keys can perform this operation"<br/>} |
| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | | `user_id` | *OptionalNullable[str]* | :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/> |
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | | `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/> | |
| `request_body` | [operations.BulkAssignKeysToGuardrailRequestBody](../operations/bulkassignkeystoguardrailrequestbody.md) | :heavy_check_mark: | N/A | | | `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,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/> |
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | | `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/> | |
| `request_body` | [operations.BulkAssignMembersToGuardrailRequestBody](../operations/bulkassignmemberstoguardrailrequestbody.md) | :heavy_check_mark: | N/A | | | `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,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/> |
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | | `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/> | |
| `request_body` | [operations.BulkUnassignKeysFromGuardrailRequestBody](../operations/bulkunassignkeysfromguardrailrequestbody.md) | :heavy_check_mark: | N/A | | | `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,9 @@
# BulkUnassignMembersFromGuardrailGlobals
## 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/> |
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | | `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/> | |
| `request_body` | [operations.BulkUnassignMembersFromGuardrailRequestBody](../operations/bulkunassignmembersfromguardrailrequestbody.md) | :heavy_check_mark: | N/A | | | `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.BulkUnassignMembersFromGuardrailRequestBody](../operations/bulkunassignmembersfromguardrailrequestbody.md) | :heavy_check_mark: | N/A | |
@@ -0,0 +1,9 @@
# CreateAuthKeysCodeGlobals
## 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/> |
+5 -7
View File
@@ -3,10 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback_url` | *str* | :heavy_check_mark: | The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed. | https://myapp.com/auth/callback | | `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/> | |
| `code_challenge` | *Optional[str]* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../operations/createauthkeyscodecodechallengemethod.md) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | | `request_body` | [operations.CreateAuthKeysCodeRequestBody](../operations/createauthkeyscoderequestbody.md) | :heavy_check_mark: | N/A | {<br/>"callback_url": "https://myapp.com/auth/callback",<br/>"code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM",<br/>"code_challenge_method": "S256",<br/>"limit": 100<br/>} |
| `limit` | *Optional[float]* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 |
| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Optional expiration time for the API key to be created | |
@@ -0,0 +1,12 @@
# CreateAuthKeysCodeRequestBody
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `callback_url` | *str* | :heavy_check_mark: | The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed. | https://myapp.com/auth/callback |
| `code_challenge` | *Optional[str]* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM |
| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../operations/createauthkeyscodecodechallengemethod.md) | :heavy_minus_sign: | The method used to generate the code challenge | S256 |
| `limit` | *Optional[float]* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 |
| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Optional expiration time for the API key to be created | |
@@ -0,0 +1,9 @@
# CreateCoinbaseChargeGlobals
## 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,10 @@
# CreateCoinbaseChargeRequest
## 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/> | |
| `create_charge_request` | [components.CreateChargeRequest](../components/createchargerequest.md) | :heavy_check_mark: | N/A | {<br/>"amount": 100,<br/>"sender": "0x1234567890123456789012345678901234567890",<br/>"chain_id": 1<br/>} |
@@ -0,0 +1,9 @@
# CreateEmbeddingsGlobals
## 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/> |
+5 -9
View File
@@ -3,12 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `input` | [operations.InputUnion](../operations/inputunion.md) | :heavy_check_mark: | N/A | | `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/> |
| `model` | *str* | :heavy_check_mark: | N/A | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> |
| `encoding_format` | [Optional[operations.EncodingFormat]](../operations/encodingformat.md) | :heavy_minus_sign: | N/A | | `request_body` | [operations.CreateEmbeddingsRequestBody](../operations/createembeddingsrequestbody.md) | :heavy_check_mark: | N/A |
| `dimensions` | *Optional[int]* | :heavy_minus_sign: | N/A |
| `user` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `provider` | [Optional[components.ProviderPreferences]](../components/providerpreferences.md) | :heavy_minus_sign: | Provider routing preferences for the request. |
| `input_type` | *Optional[str]* | :heavy_minus_sign: | N/A |
@@ -0,0 +1,14 @@
# CreateEmbeddingsRequestBody
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `input` | [operations.InputUnion](../operations/inputunion.md) | :heavy_check_mark: | N/A |
| `model` | *str* | :heavy_check_mark: | N/A |
| `encoding_format` | [Optional[operations.EncodingFormat]](../operations/encodingformat.md) | :heavy_minus_sign: | N/A |
| `dimensions` | *Optional[int]* | :heavy_minus_sign: | N/A |
| `user` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `provider` | [Optional[components.ProviderPreferences]](../components/providerpreferences.md) | :heavy_minus_sign: | Provider routing preferences for the request. |
| `input_type` | *Optional[str]* | :heavy_minus_sign: | N/A |
@@ -0,0 +1,9 @@
# CreateGuardrailGlobals
## 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/> |
+5 -9
View File
@@ -3,12 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | *str* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | | `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/> | |
| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 50 | | `request_body` | [operations.CreateGuardrailRequestBody](../operations/createguardrailrequestbody.md) | :heavy_check_mark: | N/A | {<br/>"name": "My New Guardrail",<br/>"description": "A guardrail for limiting API usage",<br/>"limit_usd": 50,<br/>"reset_interval": "monthly",<br/>"allowed_providers": [<br/>"openai",<br/>"anthropic",<br/>"deepseek"<br/>],<br/>"allowed_models": null,<br/>"enforce_zdr": false<br/>} |
| `reset_interval` | [OptionalNullable[operations.CreateGuardrailResetIntervalRequest]](../operations/createguardrailresetintervalrequest.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly |
| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [<br/>"openai",<br/>"anthropic",<br/>"deepseek"<br/>] |
| `allowed_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [<br/>"openai/gpt-5.2",<br/>"anthropic/claude-4.5-opus-20251124",<br/>"deepseek/deepseek-r1-0528:free"<br/>] |
| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention | false |
@@ -0,0 +1,14 @@
# CreateGuardrailRequestBody
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `name` | *str* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail |
| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage |
| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 50 |
| `reset_interval` | [OptionalNullable[operations.CreateGuardrailResetIntervalRequest]](../operations/createguardrailresetintervalrequest.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly |
| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [<br/>"openai",<br/>"anthropic",<br/>"deepseek"<br/>] |
| `allowed_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [<br/>"openai/gpt-5.2",<br/>"anthropic/claude-4.5-opus-20251124",<br/>"deepseek/deepseek-r1-0528:free"<br/>] |
| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention | false |
+9
View File
@@ -0,0 +1,9 @@
# CreateKeysGlobals
## 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/> |
+5 -7
View File
@@ -3,10 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key | | `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/> | |
| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../operations/createkeyslimitreset.md) | :heavy_minus_sign: | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | | `request_body` | [operations.CreateKeysRequestBody](../operations/createkeysrequestbody.md) | :heavy_check_mark: | N/A | {<br/>"name": "My New API Key",<br/>"limit": 50,<br/>"limit_reset": "monthly",<br/>"include_byok_in_limit": true,<br/>"expires_at": "2027-12-31T23:59:59Z"<br/>} |
| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true |
| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected | 2027-12-31T23:59:59Z |
+12
View File
@@ -0,0 +1,12 @@
# CreateKeysRequestBody
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key |
| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 |
| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../operations/createkeyslimitreset.md) | :heavy_minus_sign: | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly |
| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true |
| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected | 2027-12-31T23:59:59Z |
@@ -0,0 +1,9 @@
# CreateResponsesGlobals
## 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/> |
+10
View File
@@ -0,0 +1,10 @@
# CreateResponsesRequest
## 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/> | |
| `open_responses_request` | [components.OpenResponsesRequest](../components/openresponsesrequest.md) | :heavy_check_mark: | N/A | {<br/>"model": "anthropic/claude-4.5-sonnet-20250929",<br/>"input": [<br/>{<br/>"type": "message",<br/>"content": "Hello, how are you?",<br/>"role": "user"<br/>}<br/>],<br/>"temperature": 0.7,<br/>"top_p": 0.9,<br/>"tools": [<br/>{<br/>"type": "function",<br/>"name": "get_current_weather",<br/>"description": "Get the current weather in a given location",<br/>"parameters": {<br/>"type": "object",<br/>"properties": {<br/>"location": {<br/>"type": "string"<br/>}<br/>}<br/>}<br/>}<br/>]<br/>} |
@@ -0,0 +1,9 @@
# DeleteGuardrailGlobals
## 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/> |
+5 -3
View File
@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | | `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 to delete | 550e8400-e29b-41d4-a716-446655440000 |
+9
View File
@@ -0,0 +1,9 @@
# DeleteKeysGlobals
## 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/> |
+5 -3
View File
@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | | `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/> | |
| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 |
@@ -0,0 +1,9 @@
# ExchangeAuthCodeForAPIKeyGlobals
## 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/> |
@@ -3,8 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code` | *str* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | | `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/> | |
| `code_verifier` | *Optional[str]* | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../operations/exchangeauthcodeforapikeycodechallengemethod.md) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | | `request_body` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](../operations/exchangeauthcodeforapikeyrequestbody.md) | :heavy_check_mark: | N/A | {<br/>"code": "auth_code_abc123def456",<br/>"code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",<br/>"code_challenge_method": "S256"<br/>} |
@@ -0,0 +1,10 @@
# ExchangeAuthCodeForAPIKeyRequestBody
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `code` | *str* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 |
| `code_verifier` | *Optional[str]* | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk |
| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../operations/exchangeauthcodeforapikeycodechallengemethod.md) | :heavy_minus_sign: | The method used to generate the code challenge | S256 |
+9
View File
@@ -0,0 +1,9 @@
# GetCreditsGlobals
## 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/> |
+9
View File
@@ -0,0 +1,9 @@
# GetCreditsRequest
## 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/> |
+2 -1
View File
@@ -18,7 +18,8 @@ Current API key information
| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | | `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 |
| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | | `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 |
| `is_free_tier` | *bool* | :heavy_check_mark: | Whether this is a free tier API key | false | | `is_free_tier` | *bool* | :heavy_check_mark: | Whether this is a free tier API key | false |
| `is_provisioning_key` | *bool* | :heavy_check_mark: | Whether this is a provisioning key | false | | `is_management_key` | *bool* | :heavy_check_mark: | Whether this is a management key | false |
| ~~`is_provisioning_key`~~ | *bool* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Whether this is a management key | false |
| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | | `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 |
| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | | `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly |
| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | | `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false |
+9
View File
@@ -0,0 +1,9 @@
# GetCurrentKeyGlobals
## 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/> |
+9
View File
@@ -0,0 +1,9 @@
# GetCurrentKeyRequest
## 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/> |
+3 -3
View File
@@ -5,6 +5,6 @@ API key details
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data` | [operations.GetCurrentKeyData](../operations/getcurrentkeydata.md) | :heavy_check_mark: | Current API key information | {<br/>"label": "sk-or-v1-au7...890",<br/>"limit": 100,<br/>"usage": 25.5,<br/>"usage_daily": 25.5,<br/>"usage_weekly": 25.5,<br/>"usage_monthly": 25.5,<br/>"byok_usage": 17.38,<br/>"byok_usage_daily": 17.38,<br/>"byok_usage_weekly": 17.38,<br/>"byok_usage_monthly": 17.38,<br/>"is_free_tier": false,<br/>"is_provisioning_key": false,<br/>"limit_remaining": 74.5,<br/>"limit_reset": "monthly",<br/>"include_byok_in_limit": false,<br/>"expires_at": "2027-12-31T23:59:59Z",<br/>"rate_limit": {<br/>"requests": 1000,<br/>"interval": "1h",<br/>"note": "This field is deprecated and safe to ignore."<br/>}<br/>} | | `data` | [operations.GetCurrentKeyData](../operations/getcurrentkeydata.md) | :heavy_check_mark: | Current API key information | {<br/>"label": "sk-or-v1-au7...890",<br/>"limit": 100,<br/>"usage": 25.5,<br/>"usage_daily": 25.5,<br/>"usage_weekly": 25.5,<br/>"usage_monthly": 25.5,<br/>"byok_usage": 17.38,<br/>"byok_usage_daily": 17.38,<br/>"byok_usage_weekly": 17.38,<br/>"byok_usage_monthly": 17.38,<br/>"is_free_tier": false,<br/>"is_management_key": false,<br/>"is_provisioning_key": false,<br/>"limit_remaining": 74.5,<br/>"limit_reset": "monthly",<br/>"include_byok_in_limit": false,<br/>"expires_at": "2027-12-31T23:59:59Z",<br/>"rate_limit": {<br/>"requests": 1000,<br/>"interval": "1h",<br/>"note": "This field is deprecated and safe to ignore."<br/>}<br/>} |
+9
View File
@@ -0,0 +1,9 @@
# GetGenerationGlobals
## 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/> |
+5 -3
View File
@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | N/A | | `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: | N/A |
+9
View File
@@ -0,0 +1,9 @@
# GetGuardrailGlobals
## 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/> |
+5 -3
View File
@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | | `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 to retrieve | 550e8400-e29b-41d4-a716-446655440000 |
+9
View File
@@ -0,0 +1,9 @@
# GetKeyGlobals
## 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/> |
+5 -3
View File
@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | | `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/> | |
| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 |
+9
View File
@@ -0,0 +1,9 @@
# GetModelsGlobals
## 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/> |
+6 -4
View File
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `category` | [Optional[operations.Category]](../operations/category.md) | :heavy_minus_sign: | Filter models by use case category | programming | | `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/> | |
| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `category` | [Optional[operations.Category]](../operations/category.md) | :heavy_minus_sign: | Filter models by use case category | programming |
| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | N/A | |
@@ -0,0 +1,9 @@
# GetUserActivityGlobals
## 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/> |
+5 -3
View File
@@ -3,6 +3,8 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `date_` | *Optional[str]* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | | `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/> | |
| `date_` | *Optional[str]* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 |
@@ -0,0 +1,9 @@
# ListEmbeddingsModelsGlobals
## 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,9 @@
# ListEmbeddingsModelsRequest
## 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/> |
+9
View File
@@ -0,0 +1,9 @@
# ListEndpointsGlobals
## 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/> |
+6 -4
View File
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `author` | *str* | :heavy_check_mark: | N/A | | `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/> |
| `slug` | *str* | :heavy_check_mark: | N/A | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> |
| `author` | *str* | :heavy_check_mark: | N/A |
| `slug` | *str* | :heavy_check_mark: | N/A |
@@ -0,0 +1,9 @@
# ListEndpointsZdrGlobals
## 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,9 @@
# ListEndpointsZdrRequest
## 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/> |
+9
View File
@@ -0,0 +1,9 @@
# ListGlobals
## 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,9 @@
# ListGuardrailKeyAssignmentsGlobals
## 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/> |
@@ -3,8 +3,10 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | | `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/> | |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | | `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 |
@@ -0,0 +1,9 @@
# ListGuardrailMemberAssignmentsGlobals
## 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/> |
@@ -3,8 +3,10 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | | `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/> | |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | | `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 |
+9
View File
@@ -0,0 +1,9 @@
# ListGuardrailsGlobals
## 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/> |
+6 -4
View File
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `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/> | |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 |
@@ -0,0 +1,9 @@
# ListKeyAssignmentsGlobals
## 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/> |
+6 -4
View File
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `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/> | |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 |
@@ -0,0 +1,9 @@
# ListMemberAssignmentsGlobals
## 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/> |
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `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/> | |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 |
| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 |
@@ -0,0 +1,9 @@
# ListModelsCountGlobals
## 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,9 @@
# ListModelsCountRequest
## 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/> |
+9
View File
@@ -0,0 +1,9 @@
# ListModelsUserGlobals
## 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/> |
+9
View File
@@ -0,0 +1,9 @@
# ListModelsUserRequest
## 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/> |
+9
View File
@@ -0,0 +1,9 @@
# ListProvidersGlobals
## 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/> |
+9
View File
@@ -0,0 +1,9 @@
# ListProvidersRequest
## 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/> |
+6 -4
View File
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `include_disabled` | *Optional[str]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | | `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/> | |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `include_disabled` | *Optional[str]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 |
@@ -0,0 +1,9 @@
# SendChatCompletionRequestGlobals
## 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,10 @@
# SendChatCompletionRequestRequest
## 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/> |
| `chat_generation_params` | [components.ChatGenerationParams](../components/chatgenerationparams.md) | :heavy_check_mark: | Chat completion request parameters |
@@ -0,0 +1,9 @@
# UpdateGuardrailGlobals
## 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/> |
+6 -4
View File
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | | `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/> | |
| `request_body` | [operations.UpdateGuardrailRequestBody](../operations/updateguardrailrequestbody.md) | :heavy_check_mark: | N/A | {<br/>"name": "Updated Guardrail Name",<br/>"description": "Updated description",<br/>"limit_usd": 75,<br/>"reset_interval": "weekly"<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 to update | 550e8400-e29b-41d4-a716-446655440000 |
| `request_body` | [operations.UpdateGuardrailRequestBody](../operations/updateguardrailrequestbody.md) | :heavy_check_mark: | N/A | {<br/>"name": "Updated Guardrail Name",<br/>"description": "Updated description",<br/>"limit_usd": 75,<br/>"reset_interval": "weekly"<br/>} |
+9
View File
@@ -0,0 +1,9 @@
# UpdateKeysGlobals
## 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/> |
+6 -4
View File
@@ -3,7 +3,9 @@
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | | `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/> | |
| `request_body` | [operations.UpdateKeysRequestBody](../operations/updatekeysrequestbody.md) | :heavy_check_mark: | N/A | {<br/>"name": "Updated API Key Name",<br/>"disabled": false,<br/>"limit": 75,<br/>"limit_reset": "daily",<br/>"include_byok_in_limit": true<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/> | |
| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 |
| `request_body` | [operations.UpdateKeysRequestBody](../operations/updatekeysrequestbody.md) | :heavy_check_mark: | N/A | {<br/>"name": "Updated API Key Name",<br/>"disabled": false,<br/>"limit": 75,<br/>"limit_reset": "daily",<br/>"include_byok_in_limit": true<br/>} |
+9 -5
View File
@@ -11,7 +11,7 @@ Analytics and usage endpoints
## get_user_activity ## get_user_activity
Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Management key](/docs/guides/overview/auth/management-api-keys) required.
### Example Usage ### Example Usage
@@ -22,6 +22,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:
@@ -34,10 +36,12 @@ with OpenRouter(
### Parameters ### Parameters
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `date_` | *Optional[str]* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | | `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/> | |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `date_` | *Optional[str]* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response ### Response
+45 -21
View File
@@ -16,7 +16,7 @@ API key management endpoints
## list ## list
List all API keys for the authenticated user. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. List all API keys for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
### Example Usage ### Example Usage
@@ -27,6 +27,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:
@@ -39,11 +41,13 @@ with OpenRouter(
### Parameters ### Parameters
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `include_disabled` | *Optional[str]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | | `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/> | |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> | |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | | `include_disabled` | *Optional[str]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false |
| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response ### Response
@@ -60,7 +64,7 @@ with OpenRouter(
## create ## create
Create a new API key for the authenticated user. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Create a new API key for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
### Example Usage ### Example Usage
@@ -71,6 +75,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:
@@ -86,6 +92,8 @@ with OpenRouter(
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key | | `name` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key |
| `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/> | |
| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | | `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 |
| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../../operations/createkeyslimitreset.md) | :heavy_minus_sign: | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | | `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../../operations/createkeyslimitreset.md) | :heavy_minus_sign: | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly |
| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | | `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true |
@@ -108,7 +116,7 @@ with OpenRouter(
## update ## update
Update an existing API key. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Update an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
### Example Usage ### Example Usage
@@ -119,6 +127,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:
@@ -134,6 +144,8 @@ with OpenRouter(
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | | `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 |
| `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/> | |
| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | | `name` | *Optional[str]* | :heavy_minus_sign: | New name for the API key | Updated API Key Name |
| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to disable the API key | false | | `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to disable the API key | false |
| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | | `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 |
@@ -158,7 +170,7 @@ with OpenRouter(
## delete ## delete
Delete an existing API key. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Delete an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
### Example Usage ### Example Usage
@@ -169,6 +181,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:
@@ -181,10 +195,12 @@ with OpenRouter(
### Parameters ### Parameters
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | | `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | | `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/> | |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response ### Response
@@ -202,7 +218,7 @@ with OpenRouter(
## get ## get
Get a single API key by hash. [Provisioning key](/docs/guides/overview/auth/provisioning-api-keys) required. Get a single API key by hash. [Management key](/docs/guides/overview/auth/management-api-keys) required.
### Example Usage ### Example Usage
@@ -213,6 +229,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:
@@ -225,10 +243,12 @@ with OpenRouter(
### Parameters ### Parameters
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | | `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | | `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/> | |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response ### Response
@@ -257,6 +277,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:
@@ -269,9 +291,11 @@ with OpenRouter(
### Parameters ### Parameters
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | `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/> |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
### Response ### Response
+37 -32
View File
@@ -20,6 +20,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:
@@ -34,38 +36,41 @@ with OpenRouter(
### Parameters ### Parameters
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `messages` | List[[components.Message](../../components/message.md)] | :heavy_check_mark: | N/A | | `messages` | List[[components.Message](../../components/message.md)] | :heavy_check_mark: | N/A |
| `provider` | [OptionalNullable[components.Schema0]](../../components/schema0.md) | :heavy_minus_sign: | N/A | | `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/> |
| `plugins` | List[[components.Schema17](../../components/schema17.md)] | :heavy_minus_sign: | N/A | | `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.<br/> |
| `route` | [OptionalNullable[components.Route]](../../components/route.md) | :heavy_minus_sign: | N/A | | `provider` | [OptionalNullable[components.Schema0]](../../components/schema0.md) | :heavy_minus_sign: | N/A |
| `user` | *Optional[str]* | :heavy_minus_sign: | N/A | | `plugins` | List[[components.Schema17](../../components/schema17.md)] | :heavy_minus_sign: | N/A |
| `session_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | `route` | [OptionalNullable[components.Route]](../../components/route.md) | :heavy_minus_sign: | N/A |
| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | `user` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `models` | List[*str*] | :heavy_minus_sign: | N/A | | `session_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `trace` | [Optional[components.Schema19]](../../components/schema19.md) | :heavy_minus_sign: | N/A |
| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | N/A | | `model` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | `models` | List[*str*] | :heavy_minus_sign: | N/A |
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | N/A |
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `reasoning` | [Optional[components.Reasoning]](../../components/reasoning.md) | :heavy_minus_sign: | N/A | | `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.md) | :heavy_minus_sign: | N/A | | `metadata` | Dict[str, *str*] | :heavy_minus_sign: | N/A |
| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `stop` | [OptionalNullable[components.Stop]](../../components/stop.md) | :heavy_minus_sign: | N/A | | `reasoning` | [Optional[components.Reasoning]](../../components/reasoning.md) | :heavy_minus_sign: | N/A |
| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.md) | :heavy_minus_sign: | N/A |
| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.md) | :heavy_minus_sign: | N/A | | `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `stop` | [OptionalNullable[components.Stop]](../../components/stop.md) | :heavy_minus_sign: | N/A |
| `tool_choice` | *Optional[Any]* | :heavy_minus_sign: | N/A | | `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A |
| `tools` | List[[components.ToolDefinitionJSON](../../components/tooldefinitionjson.md)] | :heavy_minus_sign: | N/A | | `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.md) | :heavy_minus_sign: | N/A |
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `debug` | [Optional[components.Debug]](../../components/debug.md) | :heavy_minus_sign: | N/A | | `tool_choice` | *Optional[Any]* | :heavy_minus_sign: | N/A |
| `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](../../components/chatgenerationparamsimageconfig.md)] | :heavy_minus_sign: | N/A | | `tools` | List[[components.ToolDefinitionJSON](../../components/tooldefinitionjson.md)] | :heavy_minus_sign: | N/A |
| `modalities` | List[[components.Modality](../../components/modality.md)] | :heavy_minus_sign: | N/A | | `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | `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 |
| `modalities` | List[[components.Modality](../../components/modality.md)] | :heavy_minus_sign: | N/A |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
### Response ### Response

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