"""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 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, List, Mapping, Optional, Union class Models(BaseSDK): r"""Model information endpoints""" def get( self, *, author: str, slug: 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.ModelResponse: r"""Get a model by its slug Returns full details for a single model identified by its author and slug (e.g. openai/gpt-4). Supports variant suffixes (e.g. openai/gpt-4:free) and resolves known slug aliases. :param author: The author/organization of the model :param slug: The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) :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.GetModelRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, author=author, slug=slug, ) req = self._build_request( method="GET", path="/model/{author}/{slug}", 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.GetModelGlobals( 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="getModel", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, components.Security ), tags=["Models"], 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.ModelResponse, 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, *, author: str, slug: 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.ModelResponse: r"""Get a model by its slug Returns full details for a single model identified by its author and slug (e.g. openai/gpt-4). Supports variant suffixes (e.g. openai/gpt-4:free) and resolves known slug aliases. :param author: The author/organization of the model :param slug: The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) :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.GetModelRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, author=author, slug=slug, ) req = self._build_request_async( method="GET", path="/model/{author}/{slug}", 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.GetModelGlobals( 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="getModel", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, components.Security ), tags=["Models"], 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.ModelResponse, 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 list( self, *, http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, offset: Optional[int] = 0, limit: Optional[int] = 500, category: Optional[operations.GetModelsCategory] = None, supported_parameters: Optional[str] = None, output_modalities: Optional[str] = None, sort: Optional[operations.GetModelsSort] = None, q: Optional[str] = None, input_modalities: Optional[str] = None, context: Optional[int] = None, min_price: OptionalNullable[float] = UNSET, max_price: OptionalNullable[float] = UNSET, arch: Optional[str] = None, model_authors: Optional[str] = None, providers: Optional[str] = None, distillable: Optional[operations.Distillable] = None, zdr: Optional[operations.Zdr] = None, region: Optional[operations.Region] = None, min_output_price: OptionalNullable[float] = UNSET, max_output_price: OptionalNullable[float] = UNSET, min_age_days: OptionalNullable[int] = UNSET, max_age_days: OptionalNullable[int] = UNSET, min_intelligence_index: OptionalNullable[float] = UNSET, max_intelligence_index: OptionalNullable[float] = UNSET, min_coding_index: OptionalNullable[float] = UNSET, max_coding_index: OptionalNullable[float] = UNSET, min_agentic_index: OptionalNullable[float] = UNSET, max_agentic_index: OptionalNullable[float] = UNSET, min_tool_success_rate: OptionalNullable[float] = UNSET, max_tool_success_rate: OptionalNullable[float] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, ) -> Optional[operations.GetModelsResponse]: r"""List all models and their properties :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. When both offset and limit are omitted, the full list is returned :param limit: Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned :param category: Filter models by use case category :param supported_parameters: Filter models by supported parameter (comma-separated) :param output_modalities: Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or \"all\" to include all models. Defaults to \"text\". :param sort: Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. :param q: Free-text search by model name or slug. :param input_modalities: Filter models by input modality. Comma-separated list of: text, image, audio, file. :param context: Minimum context length (tokens). Models with smaller context are excluded. :param min_price: Minimum prompt price in $/M tokens. :param max_price: Maximum prompt price in $/M tokens. :param arch: Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). :param model_authors: Filter models by the organization that created the model. Comma-separated list of author slugs. :param providers: Filter models by hosting provider. Comma-separated list of provider names. :param distillable: Filter by distillation capability. \"true\" returns only distillable models, \"false\" excludes them. :param zdr: When set to \"true\", return only models with zero data retention endpoints. :param region: Filter to models with endpoints in the given data region. Currently only \"eu\" is supported. :param min_output_price: Minimum completion (output) price in $/M tokens. :param max_output_price: Maximum completion (output) price in $/M tokens. :param min_age_days: Minimum model age in days since its creation date. :param max_age_days: Maximum model age in days since its creation date. :param min_intelligence_index: Minimum Artificial Analysis intelligence index. :param max_intelligence_index: Maximum Artificial Analysis intelligence index. :param min_coding_index: Minimum Artificial Analysis coding index. :param max_coding_index: Maximum Artificial Analysis coding index. :param min_agentic_index: Minimum Artificial Analysis agentic index. :param max_agentic_index: Maximum Artificial Analysis agentic index. :param min_tool_success_rate: Minimum tool-calling success rate, as a fraction in [0, 1] (e.g. 0.9 = 90% of requests finishing with a tool_calls finish reason). :param max_tool_success_rate: Maximum tool-calling success rate, as a fraction in [0, 1]. :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.GetModelsRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, offset=offset, limit=limit, category=category, supported_parameters=supported_parameters, output_modalities=output_modalities, sort=sort, q=q, input_modalities=input_modalities, context=context, min_price=min_price, max_price=max_price, arch=arch, model_authors=model_authors, providers=providers, distillable=distillable, zdr=zdr, region=region, min_output_price=min_output_price, max_output_price=max_output_price, min_age_days=min_age_days, max_age_days=max_age_days, min_intelligence_index=min_intelligence_index, max_intelligence_index=max_intelligence_index, min_coding_index=min_coding_index, max_coding_index=max_coding_index, min_agentic_index=min_agentic_index, max_agentic_index=max_agentic_index, min_tool_success_rate=min_tool_success_rate, max_tool_success_rate=max_tool_success_rate, ) req = self._build_request( method="GET", path="/models", 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.GetModelsGlobals( 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="getModels", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, components.Security ), tags=["Models"], 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.GetModelsResponse]: 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 500 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, category=category, supported_parameters=supported_parameters, output_modalities=output_modalities, sort=sort, q=q, input_modalities=input_modalities, context=context, min_price=min_price, max_price=max_price, arch=arch, model_authors=model_authors, providers=providers, distillable=distillable, zdr=zdr, region=region, min_output_price=min_output_price, max_output_price=max_output_price, min_age_days=min_age_days, max_age_days=max_age_days, min_intelligence_index=min_intelligence_index, max_intelligence_index=max_intelligence_index, min_coding_index=min_coding_index, max_coding_index=max_coding_index, min_agentic_index=min_agentic_index, max_agentic_index=max_agentic_index, min_tool_success_rate=min_tool_success_rate, max_tool_success_rate=max_tool_success_rate, 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.GetModelsResponse( result=unmarshal_json_response(components.ModelsListResponse, http_res), next=next_func, ) 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, "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] = 0, limit: Optional[int] = 500, category: Optional[operations.GetModelsCategory] = None, supported_parameters: Optional[str] = None, output_modalities: Optional[str] = None, sort: Optional[operations.GetModelsSort] = None, q: Optional[str] = None, input_modalities: Optional[str] = None, context: Optional[int] = None, min_price: OptionalNullable[float] = UNSET, max_price: OptionalNullable[float] = UNSET, arch: Optional[str] = None, model_authors: Optional[str] = None, providers: Optional[str] = None, distillable: Optional[operations.Distillable] = None, zdr: Optional[operations.Zdr] = None, region: Optional[operations.Region] = None, min_output_price: OptionalNullable[float] = UNSET, max_output_price: OptionalNullable[float] = UNSET, min_age_days: OptionalNullable[int] = UNSET, max_age_days: OptionalNullable[int] = UNSET, min_intelligence_index: OptionalNullable[float] = UNSET, max_intelligence_index: OptionalNullable[float] = UNSET, min_coding_index: OptionalNullable[float] = UNSET, max_coding_index: OptionalNullable[float] = UNSET, min_agentic_index: OptionalNullable[float] = UNSET, max_agentic_index: OptionalNullable[float] = UNSET, min_tool_success_rate: OptionalNullable[float] = UNSET, max_tool_success_rate: OptionalNullable[float] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, ) -> Optional[operations.GetModelsResponse]: r"""List all models and their properties :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. When both offset and limit are omitted, the full list is returned :param limit: Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned :param category: Filter models by use case category :param supported_parameters: Filter models by supported parameter (comma-separated) :param output_modalities: Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or \"all\" to include all models. Defaults to \"text\". :param sort: Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. :param q: Free-text search by model name or slug. :param input_modalities: Filter models by input modality. Comma-separated list of: text, image, audio, file. :param context: Minimum context length (tokens). Models with smaller context are excluded. :param min_price: Minimum prompt price in $/M tokens. :param max_price: Maximum prompt price in $/M tokens. :param arch: Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). :param model_authors: Filter models by the organization that created the model. Comma-separated list of author slugs. :param providers: Filter models by hosting provider. Comma-separated list of provider names. :param distillable: Filter by distillation capability. \"true\" returns only distillable models, \"false\" excludes them. :param zdr: When set to \"true\", return only models with zero data retention endpoints. :param region: Filter to models with endpoints in the given data region. Currently only \"eu\" is supported. :param min_output_price: Minimum completion (output) price in $/M tokens. :param max_output_price: Maximum completion (output) price in $/M tokens. :param min_age_days: Minimum model age in days since its creation date. :param max_age_days: Maximum model age in days since its creation date. :param min_intelligence_index: Minimum Artificial Analysis intelligence index. :param max_intelligence_index: Maximum Artificial Analysis intelligence index. :param min_coding_index: Minimum Artificial Analysis coding index. :param max_coding_index: Maximum Artificial Analysis coding index. :param min_agentic_index: Minimum Artificial Analysis agentic index. :param max_agentic_index: Maximum Artificial Analysis agentic index. :param min_tool_success_rate: Minimum tool-calling success rate, as a fraction in [0, 1] (e.g. 0.9 = 90% of requests finishing with a tool_calls finish reason). :param max_tool_success_rate: Maximum tool-calling success rate, as a fraction in [0, 1]. :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.GetModelsRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, offset=offset, limit=limit, category=category, supported_parameters=supported_parameters, output_modalities=output_modalities, sort=sort, q=q, input_modalities=input_modalities, context=context, min_price=min_price, max_price=max_price, arch=arch, model_authors=model_authors, providers=providers, distillable=distillable, zdr=zdr, region=region, min_output_price=min_output_price, max_output_price=max_output_price, min_age_days=min_age_days, max_age_days=max_age_days, min_intelligence_index=min_intelligence_index, max_intelligence_index=max_intelligence_index, min_coding_index=min_coding_index, max_coding_index=max_coding_index, min_agentic_index=min_agentic_index, max_agentic_index=max_agentic_index, min_tool_success_rate=min_tool_success_rate, max_tool_success_rate=max_tool_success_rate, ) req = self._build_request_async( method="GET", path="/models", 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.GetModelsGlobals( 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="getModels", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, components.Security ), tags=["Models"], 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.GetModelsResponse]]: 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 500 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, category=category, supported_parameters=supported_parameters, output_modalities=output_modalities, sort=sort, q=q, input_modalities=input_modalities, context=context, min_price=min_price, max_price=max_price, arch=arch, model_authors=model_authors, providers=providers, distillable=distillable, zdr=zdr, region=region, min_output_price=min_output_price, max_output_price=max_output_price, min_age_days=min_age_days, max_age_days=max_age_days, min_intelligence_index=min_intelligence_index, max_intelligence_index=max_intelligence_index, min_coding_index=min_coding_index, max_coding_index=max_coding_index, min_agentic_index=min_agentic_index, max_agentic_index=max_agentic_index, min_tool_success_rate=min_tool_success_rate, max_tool_success_rate=max_tool_success_rate, 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.GetModelsResponse( result=unmarshal_json_response(components.ModelsListResponse, http_res), next=next_func, ) 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, "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 count( self, *, http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, output_modalities: 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.ModelsCountResponse: r"""Get total count of available models :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 output_modalities: Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or \"all\" to include all models. Defaults to \"text\". :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.ListModelsCountRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, output_modalities=output_modalities, ) req = self._build_request( method="GET", path="/models/count", 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.ListModelsCountGlobals( 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="listModelsCount", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, components.Security ), tags=["Models"], 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.ModelsCountResponse, 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, "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 count_async( self, *, http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, output_modalities: 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.ModelsCountResponse: r"""Get total count of available models :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 output_modalities: Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or \"all\" to include all models. Defaults to \"text\". :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.ListModelsCountRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, output_modalities=output_modalities, ) req = self._build_request_async( method="GET", path="/models/count", 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.ListModelsCountGlobals( 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="listModelsCount", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, components.Security ), tags=["Models"], 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.ModelsCountResponse, 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, "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_for_user( self, *, security: Union[ operations.ListModelsUserSecurity, operations.ListModelsUserSecurityTypedDict, ], http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, offset: Optional[int] = 0, limit: Optional[int] = 500, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, ) -> Optional[operations.ListModelsUserResponse]: r"""List models filtered by user provider preferences, privacy settings, and guardrails List models filtered by user provider preferences, [privacy settings](https://openrouter.ai/docs/guides/privacy/provider-logging), and [guardrails](https://openrouter.ai/docs/guides/features/guardrails). If requesting through `eu.openrouter.ai/api/v1/...` the results will be filtered to models that satisfy [EU in-region routing](https://openrouter.ai/docs/guides/privacy/provider-logging#enterprise-eu-in-region-routing). :param security: :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. When both offset and limit are omitted, the full list is returned :param limit: Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned :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.ListModelsUserRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, offset=offset, limit=limit, ) req = self._build_request( method="GET", path="/models/user", 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.ListModelsUserGlobals( 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=utils.get_pydantic_model( security, operations.ListModelsUserSecurity ), 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="listModelsUser", oauth2_scopes=None, security_source=get_security_from_env(security, components.Security), tags=["Models"], 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.ListModelsUserResponse]: 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 500 if len(results[0]) < limit_: return None next_offset = offset + len(results[0]) return self.list_for_user( security=security, 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, 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.ListModelsUserResponse( result=unmarshal_json_response(components.ModelsListResponse, 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, "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 list_for_user_async( self, *, security: Union[ operations.ListModelsUserSecurity, operations.ListModelsUserSecurityTypedDict, ], http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, offset: Optional[int] = 0, limit: Optional[int] = 500, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, ) -> Optional[operations.ListModelsUserResponse]: r"""List models filtered by user provider preferences, privacy settings, and guardrails List models filtered by user provider preferences, [privacy settings](https://openrouter.ai/docs/guides/privacy/provider-logging), and [guardrails](https://openrouter.ai/docs/guides/features/guardrails). If requesting through `eu.openrouter.ai/api/v1/...` the results will be filtered to models that satisfy [EU in-region routing](https://openrouter.ai/docs/guides/privacy/provider-logging#enterprise-eu-in-region-routing). :param security: :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. When both offset and limit are omitted, the full list is returned :param limit: Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned :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.ListModelsUserRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, offset=offset, limit=limit, ) req = self._build_request_async( method="GET", path="/models/user", 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.ListModelsUserGlobals( 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=utils.get_pydantic_model( security, operations.ListModelsUserSecurity ), 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="listModelsUser", oauth2_scopes=None, security_source=get_security_from_env(security, components.Security), tags=["Models"], 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.ListModelsUserResponse]]: 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 500 if len(results[0]) < limit_: return empty_result() next_offset = offset + len(results[0]) return self.list_for_user_async( security=security, 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, 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.ListModelsUserResponse( result=unmarshal_json_response(components.ModelsListResponse, 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, "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)