mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-30 12:20:57 +08:00
1590 lines
72 KiB
Python
1590 lines
72 KiB
Python
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
|
|
from .basesdk import BaseSDK
|
|
from jsonpath import JSONPath
|
|
from openrouter import components, errors, operations, utils
|
|
from openrouter._hooks import HookContext
|
|
from openrouter.types import Nullable, OptionalNullable, UNSET
|
|
from openrouter.utils import get_security_from_env
|
|
from openrouter.utils.unmarshal_json_response import unmarshal_json_response
|
|
from typing import Any, Awaitable, Dict, Iterable, List, Mapping, Optional, Union
|
|
|
|
|
|
class Observability(BaseSDK):
|
|
r"""Observability endpoints"""
|
|
|
|
def list(
|
|
self,
|
|
*,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
offset: Optional[int] = None,
|
|
limit: Optional[int] = None,
|
|
workspace_id: 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,
|
|
) -> Optional[operations.ListObservabilityDestinationsResponse]:
|
|
r"""List observability destinations
|
|
|
|
List the observability destinations configured for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace. Only destinations with stable release status are surfaced — destinations of other types are excluded. [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 offset: Number of records to skip for pagination
|
|
:param limit: Maximum number of records to return (max 100)
|
|
:param workspace_id: Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace.
|
|
: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.ListObservabilityDestinationsRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
offset=offset,
|
|
limit=limit,
|
|
workspace_id=workspace_id,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/observability/destinations",
|
|
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.ListObservabilityDestinationsGlobals(
|
|
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="listObservabilityDestinations",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
def next_func() -> Optional[operations.ListObservabilityDestinationsResponse]:
|
|
body = utils.unmarshal_json(http_res.text, Union[Dict[Any, Any], List[Any]])
|
|
|
|
offset = request.offset if isinstance(request.offset, int) else 0
|
|
|
|
if not http_res.text:
|
|
return None
|
|
results = JSONPath("$.data").parse(body)
|
|
if len(results) == 0 or len(results[0]) == 0:
|
|
return None
|
|
limit_ = request.limit if isinstance(request.limit, int) else 0
|
|
if len(results[0]) < limit_:
|
|
return None
|
|
next_offset = offset + len(results[0])
|
|
|
|
return self.list(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
offset=next_offset,
|
|
limit=limit,
|
|
workspace_id=workspace_id,
|
|
retries=retries,
|
|
server_url=server_url,
|
|
timeout_ms=timeout_ms,
|
|
http_headers=http_headers,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.ListObservabilityDestinationsResponse(
|
|
result=unmarshal_json_response(
|
|
components.ListObservabilityDestinationsResponse, http_res
|
|
),
|
|
next=next_func,
|
|
)
|
|
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 list_async(
|
|
self,
|
|
*,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
offset: Optional[int] = None,
|
|
limit: Optional[int] = None,
|
|
workspace_id: 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,
|
|
) -> Optional[operations.ListObservabilityDestinationsResponse]:
|
|
r"""List observability destinations
|
|
|
|
List the observability destinations configured for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace. Only destinations with stable release status are surfaced — destinations of other types are excluded. [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 offset: Number of records to skip for pagination
|
|
:param limit: Maximum number of records to return (max 100)
|
|
:param workspace_id: Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace.
|
|
: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.ListObservabilityDestinationsRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
offset=offset,
|
|
limit=limit,
|
|
workspace_id=workspace_id,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/observability/destinations",
|
|
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.ListObservabilityDestinationsGlobals(
|
|
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="listObservabilityDestinations",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
def next_func() -> (
|
|
Awaitable[Optional[operations.ListObservabilityDestinationsResponse]]
|
|
):
|
|
body = utils.unmarshal_json(http_res.text, Union[Dict[Any, Any], List[Any]])
|
|
|
|
async def empty_result():
|
|
return None
|
|
|
|
offset = request.offset if isinstance(request.offset, int) else 0
|
|
|
|
if not http_res.text:
|
|
return empty_result()
|
|
results = JSONPath("$.data").parse(body)
|
|
if len(results) == 0 or len(results[0]) == 0:
|
|
return empty_result()
|
|
limit_ = request.limit if isinstance(request.limit, int) else 0
|
|
if len(results[0]) < limit_:
|
|
return empty_result()
|
|
next_offset = offset + len(results[0])
|
|
|
|
return self.list_async(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
offset=next_offset,
|
|
limit=limit,
|
|
workspace_id=workspace_id,
|
|
retries=retries,
|
|
server_url=server_url,
|
|
timeout_ms=timeout_ms,
|
|
http_headers=http_headers,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return operations.ListObservabilityDestinationsResponse(
|
|
result=unmarshal_json_response(
|
|
components.ListObservabilityDestinationsResponse, http_res
|
|
),
|
|
next=next_func,
|
|
)
|
|
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 create(
|
|
self,
|
|
*,
|
|
config: Mapping[str, Nullable[Any]],
|
|
name: str,
|
|
type_: components.CreateObservabilityDestinationRequestType,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
api_key_hashes: OptionalNullable[Iterable[str]] = UNSET,
|
|
enabled: Optional[bool] = True,
|
|
filter_rules: OptionalNullable[
|
|
Union[
|
|
components.ObservabilityFilterRulesConfig,
|
|
components.ObservabilityFilterRulesConfigTypedDict,
|
|
]
|
|
] = UNSET,
|
|
privacy_mode: Optional[bool] = False,
|
|
sampling_rate: Optional[float] = None,
|
|
workspace_id: 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,
|
|
) -> components.CreateObservabilityDestinationResponse:
|
|
r"""Create an observability destination
|
|
|
|
Create a new observability destination. A maximum of 5 destinations per type is allowed. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param config: Provider-specific configuration. The shape depends on `type` and is validated server-side.
|
|
:param name: Human-readable name for the destination.
|
|
:param type: The destination type. Only stable destination types are accepted.
|
|
: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 api_key_hashes: Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided.
|
|
:param enabled: Whether this destination should be enabled immediately.
|
|
:param filter_rules: Optional structured filter rules controlling which events are forwarded.
|
|
:param privacy_mode: When true, request/response bodies are not forwarded — only metadata.
|
|
:param sampling_rate: Sampling rate between 0.0001 and 1 (1 = 100%).
|
|
:param workspace_id: Optional workspace ID. Defaults to the authenticated entity's default workspace.
|
|
: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.CreateObservabilityDestinationRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
create_observability_destination_request=components.CreateObservabilityDestinationRequest(
|
|
api_key_hashes=utils.unmarshal(
|
|
api_key_hashes, OptionalNullable[List[str]]
|
|
),
|
|
config=utils.unmarshal(config, Dict[str, Nullable[Any]]),
|
|
enabled=enabled,
|
|
filter_rules=utils.get_pydantic_model(
|
|
filter_rules,
|
|
OptionalNullable[components.ObservabilityFilterRulesConfig],
|
|
),
|
|
name=name,
|
|
privacy_mode=privacy_mode,
|
|
sampling_rate=sampling_rate,
|
|
type=type_,
|
|
workspace_id=workspace_id,
|
|
),
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="POST",
|
|
path="/observability/destinations",
|
|
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.CreateObservabilityDestinationGlobals(
|
|
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.create_observability_destination_request,
|
|
False,
|
|
False,
|
|
"json",
|
|
components.CreateObservabilityDestinationRequest,
|
|
),
|
|
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="createObservabilityDestination",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "201", "application/json"):
|
|
return unmarshal_json_response(
|
|
components.CreateObservabilityDestinationResponse, 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, "403", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.ForbiddenResponseErrorData, http_res
|
|
)
|
|
raise errors.ForbiddenResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "409", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.ConflictResponseErrorData, http_res
|
|
)
|
|
raise errors.ConflictResponseError(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,
|
|
*,
|
|
config: Mapping[str, Nullable[Any]],
|
|
name: str,
|
|
type_: components.CreateObservabilityDestinationRequestType,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
api_key_hashes: OptionalNullable[Iterable[str]] = UNSET,
|
|
enabled: Optional[bool] = True,
|
|
filter_rules: OptionalNullable[
|
|
Union[
|
|
components.ObservabilityFilterRulesConfig,
|
|
components.ObservabilityFilterRulesConfigTypedDict,
|
|
]
|
|
] = UNSET,
|
|
privacy_mode: Optional[bool] = False,
|
|
sampling_rate: Optional[float] = None,
|
|
workspace_id: 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,
|
|
) -> components.CreateObservabilityDestinationResponse:
|
|
r"""Create an observability destination
|
|
|
|
Create a new observability destination. A maximum of 5 destinations per type is allowed. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param config: Provider-specific configuration. The shape depends on `type` and is validated server-side.
|
|
:param name: Human-readable name for the destination.
|
|
:param type: The destination type. Only stable destination types are accepted.
|
|
: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 api_key_hashes: Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided.
|
|
:param enabled: Whether this destination should be enabled immediately.
|
|
:param filter_rules: Optional structured filter rules controlling which events are forwarded.
|
|
:param privacy_mode: When true, request/response bodies are not forwarded — only metadata.
|
|
:param sampling_rate: Sampling rate between 0.0001 and 1 (1 = 100%).
|
|
:param workspace_id: Optional workspace ID. Defaults to the authenticated entity's default workspace.
|
|
: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.CreateObservabilityDestinationRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
create_observability_destination_request=components.CreateObservabilityDestinationRequest(
|
|
api_key_hashes=utils.unmarshal(
|
|
api_key_hashes, OptionalNullable[List[str]]
|
|
),
|
|
config=utils.unmarshal(config, Dict[str, Nullable[Any]]),
|
|
enabled=enabled,
|
|
filter_rules=utils.get_pydantic_model(
|
|
filter_rules,
|
|
OptionalNullable[components.ObservabilityFilterRulesConfig],
|
|
),
|
|
name=name,
|
|
privacy_mode=privacy_mode,
|
|
sampling_rate=sampling_rate,
|
|
type=type_,
|
|
workspace_id=workspace_id,
|
|
),
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="POST",
|
|
path="/observability/destinations",
|
|
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.CreateObservabilityDestinationGlobals(
|
|
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.create_observability_destination_request,
|
|
False,
|
|
False,
|
|
"json",
|
|
components.CreateObservabilityDestinationRequest,
|
|
),
|
|
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="createObservabilityDestination",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "201", "application/json"):
|
|
return unmarshal_json_response(
|
|
components.CreateObservabilityDestinationResponse, 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, "403", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.ForbiddenResponseErrorData, http_res
|
|
)
|
|
raise errors.ForbiddenResponseError(response_data, http_res)
|
|
if utils.match_response(http_res, "409", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.ConflictResponseErrorData, http_res
|
|
)
|
|
raise errors.ConflictResponseError(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,
|
|
*,
|
|
id: 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,
|
|
) -> components.DeleteObservabilityDestinationResponse:
|
|
r"""Delete an observability destination
|
|
|
|
Delete an existing observability destination. This performs a soft delete. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param id: The destination ID (UUID).
|
|
: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.DeleteObservabilityDestinationRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
id=id,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="DELETE",
|
|
path="/observability/destinations/{id}",
|
|
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.DeleteObservabilityDestinationGlobals(
|
|
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="deleteObservabilityDestination",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(
|
|
components.DeleteObservabilityDestinationResponse, 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, "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,
|
|
*,
|
|
id: 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,
|
|
) -> components.DeleteObservabilityDestinationResponse:
|
|
r"""Delete an observability destination
|
|
|
|
Delete an existing observability destination. This performs a soft delete. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param id: The destination ID (UUID).
|
|
: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.DeleteObservabilityDestinationRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
id=id,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="DELETE",
|
|
path="/observability/destinations/{id}",
|
|
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.DeleteObservabilityDestinationGlobals(
|
|
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="deleteObservabilityDestination",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(
|
|
components.DeleteObservabilityDestinationResponse, 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, "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,
|
|
*,
|
|
id: 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,
|
|
) -> components.GetObservabilityDestinationResponse:
|
|
r"""Get an observability destination
|
|
|
|
Fetch a single observability destination by its UUID. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param id: The destination ID (UUID).
|
|
: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.GetObservabilityDestinationRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
id=id,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="GET",
|
|
path="/observability/destinations/{id}",
|
|
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.GetObservabilityDestinationGlobals(
|
|
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="getObservabilityDestination",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(
|
|
components.GetObservabilityDestinationResponse, 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, "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,
|
|
*,
|
|
id: 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,
|
|
) -> components.GetObservabilityDestinationResponse:
|
|
r"""Get an observability destination
|
|
|
|
Fetch a single observability destination by its UUID. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param id: The destination ID (UUID).
|
|
: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.GetObservabilityDestinationRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
id=id,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="GET",
|
|
path="/observability/destinations/{id}",
|
|
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.GetObservabilityDestinationGlobals(
|
|
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="getObservabilityDestination",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(
|
|
components.GetObservabilityDestinationResponse, 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, "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,
|
|
*,
|
|
id: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
api_key_hashes: OptionalNullable[Iterable[str]] = UNSET,
|
|
config: Optional[Mapping[str, Nullable[Any]]] = None,
|
|
enabled: Optional[bool] = None,
|
|
filter_rules: OptionalNullable[
|
|
Union[
|
|
components.ObservabilityFilterRulesConfig,
|
|
components.ObservabilityFilterRulesConfigTypedDict,
|
|
]
|
|
] = UNSET,
|
|
name: Optional[str] = None,
|
|
privacy_mode: Optional[bool] = None,
|
|
sampling_rate: Optional[float] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> components.UpdateObservabilityDestinationResponse:
|
|
r"""Update an observability destination
|
|
|
|
Update an existing observability destination. Only the fields provided in the request body are updated. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param id: The destination ID (UUID).
|
|
: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 api_key_hashes: Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided.
|
|
:param config: Provider-specific configuration fields to update. Masked values are ignored; unset fields keep their current value.
|
|
:param enabled: Whether the destination is enabled.
|
|
:param filter_rules:
|
|
:param name: Human-readable name for the destination.
|
|
:param privacy_mode: When true, request/response bodies are not forwarded — only metadata.
|
|
:param sampling_rate: Sampling rate between 0.0001 and 1 (1 = 100%).
|
|
: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.UpdateObservabilityDestinationRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
id=id,
|
|
update_observability_destination_request=components.UpdateObservabilityDestinationRequest(
|
|
api_key_hashes=utils.unmarshal(
|
|
api_key_hashes, OptionalNullable[List[str]]
|
|
),
|
|
config=utils.unmarshal(config, Optional[Dict[str, Nullable[Any]]]),
|
|
enabled=enabled,
|
|
filter_rules=utils.get_pydantic_model(
|
|
filter_rules,
|
|
OptionalNullable[components.ObservabilityFilterRulesConfig],
|
|
),
|
|
name=name,
|
|
privacy_mode=privacy_mode,
|
|
sampling_rate=sampling_rate,
|
|
),
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="PATCH",
|
|
path="/observability/destinations/{id}",
|
|
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.UpdateObservabilityDestinationGlobals(
|
|
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.update_observability_destination_request,
|
|
False,
|
|
False,
|
|
"json",
|
|
components.UpdateObservabilityDestinationRequest,
|
|
),
|
|
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="updateObservabilityDestination",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(
|
|
components.UpdateObservabilityDestinationResponse, 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, "409", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.ConflictResponseErrorData, http_res
|
|
)
|
|
raise errors.ConflictResponseError(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,
|
|
*,
|
|
id: str,
|
|
http_referer: Optional[str] = None,
|
|
x_open_router_title: Optional[str] = None,
|
|
x_open_router_categories: Optional[str] = None,
|
|
api_key_hashes: OptionalNullable[Iterable[str]] = UNSET,
|
|
config: Optional[Mapping[str, Nullable[Any]]] = None,
|
|
enabled: Optional[bool] = None,
|
|
filter_rules: OptionalNullable[
|
|
Union[
|
|
components.ObservabilityFilterRulesConfig,
|
|
components.ObservabilityFilterRulesConfigTypedDict,
|
|
]
|
|
] = UNSET,
|
|
name: Optional[str] = None,
|
|
privacy_mode: Optional[bool] = None,
|
|
sampling_rate: Optional[float] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> components.UpdateObservabilityDestinationResponse:
|
|
r"""Update an observability destination
|
|
|
|
Update an existing observability destination. Only the fields provided in the request body are updated. [Management key](/docs/guides/overview/auth/management-api-keys) required.
|
|
|
|
:param id: The destination ID (UUID).
|
|
: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 api_key_hashes: Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided.
|
|
:param config: Provider-specific configuration fields to update. Masked values are ignored; unset fields keep their current value.
|
|
:param enabled: Whether the destination is enabled.
|
|
:param filter_rules:
|
|
:param name: Human-readable name for the destination.
|
|
:param privacy_mode: When true, request/response bodies are not forwarded — only metadata.
|
|
:param sampling_rate: Sampling rate between 0.0001 and 1 (1 = 100%).
|
|
: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.UpdateObservabilityDestinationRequest(
|
|
http_referer=http_referer,
|
|
x_open_router_title=x_open_router_title,
|
|
x_open_router_categories=x_open_router_categories,
|
|
id=id,
|
|
update_observability_destination_request=components.UpdateObservabilityDestinationRequest(
|
|
api_key_hashes=utils.unmarshal(
|
|
api_key_hashes, OptionalNullable[List[str]]
|
|
),
|
|
config=utils.unmarshal(config, Optional[Dict[str, Nullable[Any]]]),
|
|
enabled=enabled,
|
|
filter_rules=utils.get_pydantic_model(
|
|
filter_rules,
|
|
OptionalNullable[components.ObservabilityFilterRulesConfig],
|
|
),
|
|
name=name,
|
|
privacy_mode=privacy_mode,
|
|
sampling_rate=sampling_rate,
|
|
),
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="PATCH",
|
|
path="/observability/destinations/{id}",
|
|
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.UpdateObservabilityDestinationGlobals(
|
|
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.update_observability_destination_request,
|
|
False,
|
|
False,
|
|
"json",
|
|
components.UpdateObservabilityDestinationRequest,
|
|
),
|
|
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="updateObservabilityDestination",
|
|
oauth2_scopes=None,
|
|
security_source=get_security_from_env(
|
|
self.sdk_configuration.security, components.Security
|
|
),
|
|
tags=["Observability"],
|
|
extensions=None,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
response_data: Any = None
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(
|
|
components.UpdateObservabilityDestinationResponse, 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, "409", "application/json"):
|
|
response_data = unmarshal_json_response(
|
|
errors.ConflictResponseErrorData, http_res
|
|
)
|
|
raise errors.ConflictResponseError(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)
|