mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-29 11:23:49 +08:00
1663 lines
73 KiB
Python
1663 lines
73 KiB
Python
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
|
|
from .basesdk import BaseSDK
|
|
from datetime import datetime
|
|
from openrouter import components, errors, operations, utils
|
|
from openrouter._hooks import HookContext
|
|
from openrouter.types import OptionalNullable, UNSET
|
|
from openrouter.utils import get_security_from_env
|
|
from openrouter.utils.unmarshal_json_response import unmarshal_json_response
|
|
from typing import Any, Mapping, Optional
|
|
|
|
|
|
class APIKeys(BaseSDK):
|
|
r"""API key management endpoints"""
|
|
|
|
def get_current_key_metadata(
|
|
self,
|
|
*,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetCurrentKeyResponse:
|
|
r"""Get current API key
|
|
|
|
Get information on the API key associated with the current authentication session
|
|
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.GetCurrentKeyRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/key",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.GetCurrentKeyGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="getCurrentKey",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["401", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.GetCurrentKeyResponse, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
async def get_current_key_metadata_async(
|
|
self,
|
|
*,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetCurrentKeyResponse:
|
|
r"""Get current API key
|
|
|
|
Get information on the API key associated with the current authentication session
|
|
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.GetCurrentKeyRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/key",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.GetCurrentKeyGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="getCurrentKey",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["401", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.GetCurrentKeyResponse, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
def list(
|
|
self,
|
|
*,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
include_disabled: Optional[bool] = None,
|
|
offset: Optional[int] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.ListResponse:
|
|
r"""List API keys
|
|
|
|
List all API keys for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param include_disabled: Whether to include disabled API keys in the response
|
|
:param offset: Number of API keys to skip for pagination
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.ListRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
include_disabled=include_disabled,
|
|
offset=offset,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/keys",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.ListGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="list",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["401", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.ListResponse, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
async def list_async(
|
|
self,
|
|
*,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
include_disabled: Optional[bool] = None,
|
|
offset: Optional[int] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.ListResponse:
|
|
r"""List API keys
|
|
|
|
List all API keys for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param include_disabled: Whether to include disabled API keys in the response
|
|
:param offset: Number of API keys to skip for pagination
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.ListRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
include_disabled=include_disabled,
|
|
offset=offset,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/keys",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.ListGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="list",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["401", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.ListResponse, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
def create(
|
|
self,
|
|
*,
|
|
name: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
creator_user_id: OptionalNullable[str] = UNSET,
|
|
expires_at: OptionalNullable[datetime] = UNSET,
|
|
include_byok_in_limit: Optional[bool] = None,
|
|
limit: OptionalNullable[float] = UNSET,
|
|
limit_reset: OptionalNullable[operations.CreateKeysLimitReset] = UNSET,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.CreateKeysResponse:
|
|
r"""Create a new API key
|
|
|
|
Create a new API key for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param name: Name for the new API key
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param creator_user_id: Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key.
|
|
:param expires_at: Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected
|
|
:param include_byok_in_limit: Whether to include BYOK usage in the limit
|
|
:param limit: Optional spending limit for the API key in USD
|
|
:param limit_reset: 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.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.CreateKeysRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
request_body=operations.CreateKeysRequestBody(
|
|
creator_user_id=creator_user_id,
|
|
expires_at=expires_at,
|
|
include_byok_in_limit=include_byok_in_limit,
|
|
limit=limit,
|
|
limit_reset=limit_reset,
|
|
name=name,
|
|
),
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="POST",
|
|
path="/keys",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.CreateKeysGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request.request_body,
|
|
False,
|
|
False,
|
|
"json",
|
|
operations.CreateKeysRequestBody,
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="createKeys",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "201", "application/json"):
|
|
return unmarshal_json_response(operations.CreateKeysResponse, http_res)
|
|
if utils.match_response(http_res, "400", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.BadRequestResponseErrorData, http_res
|
|
)
|
|
raise errors.BadRequestResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
async def create_async(
|
|
self,
|
|
*,
|
|
name: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
creator_user_id: OptionalNullable[str] = UNSET,
|
|
expires_at: OptionalNullable[datetime] = UNSET,
|
|
include_byok_in_limit: Optional[bool] = None,
|
|
limit: OptionalNullable[float] = UNSET,
|
|
limit_reset: OptionalNullable[operations.CreateKeysLimitReset] = UNSET,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.CreateKeysResponse:
|
|
r"""Create a new API key
|
|
|
|
Create a new API key for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param name: Name for the new API key
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param creator_user_id: Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key.
|
|
:param expires_at: Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected
|
|
:param include_byok_in_limit: Whether to include BYOK usage in the limit
|
|
:param limit: Optional spending limit for the API key in USD
|
|
:param limit_reset: 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.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.CreateKeysRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
request_body=operations.CreateKeysRequestBody(
|
|
creator_user_id=creator_user_id,
|
|
expires_at=expires_at,
|
|
include_byok_in_limit=include_byok_in_limit,
|
|
limit=limit,
|
|
limit_reset=limit_reset,
|
|
name=name,
|
|
),
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="POST",
|
|
path="/keys",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.CreateKeysGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request.request_body,
|
|
False,
|
|
False,
|
|
"json",
|
|
operations.CreateKeysRequestBody,
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="createKeys",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "201", "application/json"):
|
|
return unmarshal_json_response(operations.CreateKeysResponse, http_res)
|
|
if utils.match_response(http_res, "400", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.BadRequestResponseErrorData, http_res
|
|
)
|
|
raise errors.BadRequestResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
def delete(
|
|
self,
|
|
*,
|
|
hash: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.DeleteKeysResponse:
|
|
r"""Delete an API key
|
|
|
|
Delete an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param hash: The hash identifier of the API key to delete
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.DeleteKeysRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
hash=hash,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="DELETE",
|
|
path="/keys/{hash}",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.DeleteKeysGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="deleteKeys",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["401", "404", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.DeleteKeysResponse, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "404", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.NotFoundResponseErrorData, http_res
|
|
)
|
|
raise errors.NotFoundResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
async def delete_async(
|
|
self,
|
|
*,
|
|
hash: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.DeleteKeysResponse:
|
|
r"""Delete an API key
|
|
|
|
Delete an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param hash: The hash identifier of the API key to delete
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.DeleteKeysRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
hash=hash,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="DELETE",
|
|
path="/keys/{hash}",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.DeleteKeysGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="deleteKeys",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["401", "404", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.DeleteKeysResponse, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "404", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.NotFoundResponseErrorData, http_res
|
|
)
|
|
raise errors.NotFoundResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
def get(
|
|
self,
|
|
*,
|
|
hash: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetKeyResponse:
|
|
r"""Get a single API key
|
|
|
|
Get a single API key by hash. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param hash: The hash identifier of the API key to retrieve
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.GetKeyRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
hash=hash,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/keys/{hash}",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.GetKeyGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="getKey",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["401", "404", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.GetKeyResponse, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "404", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.NotFoundResponseErrorData, http_res
|
|
)
|
|
raise errors.NotFoundResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
async def get_async(
|
|
self,
|
|
*,
|
|
hash: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.GetKeyResponse:
|
|
r"""Get a single API key
|
|
|
|
Get a single API key by hash. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param hash: The hash identifier of the API key to retrieve
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.GetKeyRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
hash=hash,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/keys/{hash}",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=False,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.GetKeyGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="getKey",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["401", "404", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.GetKeyResponse, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "404", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.NotFoundResponseErrorData, http_res
|
|
)
|
|
raise errors.NotFoundResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
def update(
|
|
self,
|
|
*,
|
|
hash: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
disabled: Optional[bool] = None,
|
|
include_byok_in_limit: Optional[bool] = None,
|
|
limit: OptionalNullable[float] = UNSET,
|
|
limit_reset: OptionalNullable[operations.UpdateKeysLimitReset] = UNSET,
|
|
name: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.UpdateKeysResponse:
|
|
r"""Update an API key
|
|
|
|
Update an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param hash: The hash identifier of the API key to update
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param disabled: Whether to disable the API key
|
|
:param include_byok_in_limit: Whether to include BYOK usage in the limit
|
|
:param limit: New spending limit for the API key in USD
|
|
:param limit_reset: New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.
|
|
:param name: New name for the API key
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.UpdateKeysRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
hash=hash,
|
|
request_body=operations.UpdateKeysRequestBody(
|
|
disabled=disabled,
|
|
include_byok_in_limit=include_byok_in_limit,
|
|
limit=limit,
|
|
limit_reset=limit_reset,
|
|
name=name,
|
|
),
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="PATCH",
|
|
path="/keys/{hash}",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.UpdateKeysGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request.request_body,
|
|
False,
|
|
False,
|
|
"json",
|
|
operations.UpdateKeysRequestBody,
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="updateKeys",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["400", "401", "404", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.UpdateKeysResponse, http_res)
|
|
if utils.match_response(http_res, "400", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.BadRequestResponseErrorData, http_res
|
|
)
|
|
raise errors.BadRequestResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "404", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.NotFoundResponseErrorData, http_res
|
|
)
|
|
raise errors.NotFoundResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
|
|
|
async def update_async(
|
|
self,
|
|
*,
|
|
hash: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
disabled: Optional[bool] = None,
|
|
include_byok_in_limit: Optional[bool] = None,
|
|
limit: OptionalNullable[float] = UNSET,
|
|
limit_reset: OptionalNullable[operations.UpdateKeysLimitReset] = UNSET,
|
|
name: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> operations.UpdateKeysResponse:
|
|
r"""Update an API key
|
|
|
|
Update an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param hash: The hash identifier of the API key to update
|
|
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
|
This is used to track API usage per application.
|
|
|
|
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
|
|
|
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
|
|
|
:param disabled: Whether to disable the API key
|
|
:param include_byok_in_limit: Whether to include BYOK usage in the limit
|
|
:param limit: New spending limit for the API key in USD
|
|
:param limit_reset: New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.
|
|
:param name: New name for the API key
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = operations.UpdateKeysRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
hash=hash,
|
|
request_body=operations.UpdateKeysRequestBody(
|
|
disabled=disabled,
|
|
include_byok_in_limit=include_byok_in_limit,
|
|
limit=limit,
|
|
limit_reset=limit_reset,
|
|
name=name,
|
|
),
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="PATCH",
|
|
path="/keys/{hash}",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=True,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=operations.UpdateKeysGlobals(
|
|
http_referer=self.sdk_configuration.globals.http_referer,
|
|
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
|
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request.request_body,
|
|
False,
|
|
False,
|
|
"json",
|
|
operations.UpdateKeysRequestBody,
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
else:
|
|
retries = utils.RetryConfig(
|
|
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
|
)
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["5XX"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="updateKeys",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
),
|
|
request=req,
|
|
error_status_codes=["400", "401", "404", "429", "4XX", "500", "5XX"],
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(operations.UpdateKeysResponse, http_res)
|
|
if utils.match_response(http_res, "400", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.BadRequestResponseErrorData, http_res
|
|
)
|
|
raise errors.BadRequestResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "401", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.UnauthorizedResponseErrorData, http_res
|
|
)
|
|
raise errors.UnauthorizedResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "404", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.NotFoundResponseErrorData, http_res
|
|
)
|
|
raise errors.NotFoundResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "429", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.TooManyRequestsResponseErrorData, http_res
|
|
)
|
|
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "500", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.InternalServerResponseErrorData, http_res
|
|
)
|
|
raise errors.InternalServerResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.OpenRouterDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|