mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-31 12:30:30 +08:00
docs: Mintlify MDX docs + docs.json; bump Speakeasy to 1.787.0 (#382)
This commit is contained in:
+193
-69
@@ -1,18 +1,12 @@
|
||||
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
||||
|
||||
from .basesdk import BaseSDK
|
||||
from enum import Enum
|
||||
from openrouter import components, errors, operations, utils
|
||||
from openrouter._hooks import HookContext
|
||||
from openrouter.types import OptionalNullable, UNSET
|
||||
from openrouter.utils import eventstreaming, get_security_from_env
|
||||
from openrouter.utils.unmarshal_json_response import unmarshal_json_response
|
||||
from typing import Any, List, Literal, Mapping, Optional, Union, overload
|
||||
|
||||
|
||||
class GenerateAcceptEnum(str, Enum):
|
||||
APPLICATION_JSON = "application/json"
|
||||
TEXT_EVENT_STREAM = "text/event-stream"
|
||||
from typing import Any, Iterable, List, Literal, Mapping, Optional, Union, overload
|
||||
|
||||
|
||||
class Images(BaseSDK):
|
||||
@@ -31,8 +25,8 @@ class Images(BaseSDK):
|
||||
background: Optional[components.ImageGenerationRequestBackground] = None,
|
||||
input_references: Optional[
|
||||
Union[
|
||||
List[components.ContentPartImage],
|
||||
List[components.ContentPartImageTypedDict],
|
||||
Iterable[components.ContentPartImage],
|
||||
Iterable[components.ContentPartImageTypedDict],
|
||||
]
|
||||
] = None,
|
||||
n: Optional[int] = None,
|
||||
@@ -82,7 +76,6 @@ class Images(BaseSDK):
|
||||
: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 accept_header_override: Override the default accept header for this method
|
||||
:param http_headers: Additional headers to set or replace on requests.
|
||||
"""
|
||||
|
||||
@@ -99,8 +92,8 @@ class Images(BaseSDK):
|
||||
background: Optional[components.ImageGenerationRequestBackground] = None,
|
||||
input_references: Optional[
|
||||
Union[
|
||||
List[components.ContentPartImage],
|
||||
List[components.ContentPartImageTypedDict],
|
||||
Iterable[components.ContentPartImage],
|
||||
Iterable[components.ContentPartImageTypedDict],
|
||||
]
|
||||
] = None,
|
||||
n: Optional[int] = None,
|
||||
@@ -150,10 +143,10 @@ class Images(BaseSDK):
|
||||
: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 accept_header_override: Override the default accept header for this method
|
||||
:param http_headers: Additional headers to set or replace on requests.
|
||||
"""
|
||||
|
||||
@overload
|
||||
def generate(
|
||||
self,
|
||||
*,
|
||||
@@ -166,8 +159,8 @@ class Images(BaseSDK):
|
||||
background: Optional[components.ImageGenerationRequestBackground] = None,
|
||||
input_references: Optional[
|
||||
Union[
|
||||
List[components.ContentPartImage],
|
||||
List[components.ContentPartImageTypedDict],
|
||||
Iterable[components.ContentPartImage],
|
||||
Iterable[components.ContentPartImageTypedDict],
|
||||
]
|
||||
] = None,
|
||||
n: Optional[int] = None,
|
||||
@@ -183,12 +176,84 @@ class Images(BaseSDK):
|
||||
resolution: Optional[components.ImageGenerationRequestResolution] = None,
|
||||
seed: Optional[int] = None,
|
||||
size: Optional[str] = None,
|
||||
stream: Optional[bool] = None,
|
||||
stream: bool,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
http_headers: Optional[Mapping[str, str]] = None,
|
||||
) -> operations.CreateImagesResponse:
|
||||
) -> Union[
|
||||
components.ImageGenerationResponse,
|
||||
eventstreaming.EventStream[components.ImageStreamingResponseData],
|
||||
]:
|
||||
r"""Generate an image
|
||||
|
||||
Generates an image from a text prompt via the image generation router
|
||||
|
||||
:param model: The image generation model to use
|
||||
:param prompt: Text description of the desired image
|
||||
: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 aspect_ratio: Normalized aspect ratio of the generated image. Providers clamp to their supported subset.
|
||||
:param background: Background treatment. `transparent` requires an output_format that supports alpha (png or webp).
|
||||
:param input_references: Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs.
|
||||
:param n: Number of images to generate (1-10). Providers that only support single-image generation reject n > 1.
|
||||
:param output_compression: Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob.
|
||||
:param output_format: Encoding of the returned image bytes. Most models produce raster formats (png, jpeg, webp). SVG is supported by vectorization models (e.g. Quiver) — the SVG markup is UTF-8 base64-encoded in `b64_json`.
|
||||
:param provider: Provider-specific passthrough configuration
|
||||
:param quality: Rendering quality. Providers without a quality knob ignore this.
|
||||
:param resolution: Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider.
|
||||
:param seed: If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers.
|
||||
:param size: Optional. A convenience shorthand for output dimensions — pass a tier (\"2K\", \"4K\") or explicit pixels (\"2048x2048\") and we normalize it to the right dimensions for the chosen provider. Interchangeable with resolution + aspect_ratio; use those directly for enumerated, per-model discoverable values. Conflicting size + resolution/aspect_ratio is rejected.
|
||||
:param stream: If true, partial images are streamed as SSE events as they become available. Only supported by providers with native streaming (currently OpenAI). Non-streaming providers ignore this flag and return a buffered response.
|
||||
: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.
|
||||
"""
|
||||
|
||||
def generate(
|
||||
self,
|
||||
*,
|
||||
model: str,
|
||||
prompt: str,
|
||||
http_referer: Optional[str] = None,
|
||||
x_open_router_title: Optional[str] = None,
|
||||
x_open_router_categories: Optional[str] = None,
|
||||
aspect_ratio: Optional[components.ImageGenerationRequestAspectRatio] = None,
|
||||
background: Optional[components.ImageGenerationRequestBackground] = None,
|
||||
input_references: Optional[
|
||||
Union[
|
||||
Iterable[components.ContentPartImage],
|
||||
Iterable[components.ContentPartImageTypedDict],
|
||||
]
|
||||
] = None,
|
||||
n: Optional[int] = None,
|
||||
output_compression: Optional[int] = None,
|
||||
output_format: Optional[components.ImageGenerationRequestOutputFormat] = None,
|
||||
provider: Optional[
|
||||
Union[
|
||||
components.ImageGenerationRequestProvider,
|
||||
components.ImageGenerationRequestProviderTypedDict,
|
||||
]
|
||||
] = None,
|
||||
quality: Optional[components.ImageGenerationRequestQuality] = None,
|
||||
resolution: Optional[components.ImageGenerationRequestResolution] = None,
|
||||
seed: Optional[int] = None,
|
||||
size: Optional[str] = None,
|
||||
stream: Optional[bool] = None,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
http_headers: Optional[Mapping[str, str]] = None,
|
||||
) -> Union[
|
||||
components.ImageGenerationResponse,
|
||||
eventstreaming.EventStream[components.ImageStreamingResponseData],
|
||||
]:
|
||||
r"""Generate an image
|
||||
|
||||
Generates an image from a text prompt via the image generation router
|
||||
@@ -217,7 +282,6 @@ class Images(BaseSDK):
|
||||
: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 accept_header_override: Override the default accept header for this method
|
||||
:param http_headers: Additional headers to set or replace on requests.
|
||||
"""
|
||||
base_url = None
|
||||
@@ -266,7 +330,9 @@ class Images(BaseSDK):
|
||||
request_has_path_params=False,
|
||||
request_has_query_params=True,
|
||||
user_agent_header="user-agent",
|
||||
accept_header_value="text/event-stream" if stream else "application/json",
|
||||
accept_header_value="text/event-stream"
|
||||
if stream is True
|
||||
else "application/json",
|
||||
http_headers=http_headers,
|
||||
_globals=operations.CreateImagesGlobals(
|
||||
http_referer=self.sdk_configuration.globals.http_referer,
|
||||
@@ -306,23 +372,12 @@ class Images(BaseSDK):
|
||||
security_source=get_security_from_env(
|
||||
self.sdk_configuration.security, components.Security
|
||||
),
|
||||
tags=["Images"],
|
||||
extensions=None,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=[
|
||||
"400",
|
||||
"401",
|
||||
"402",
|
||||
"403",
|
||||
"404",
|
||||
"429",
|
||||
"4XX",
|
||||
"500",
|
||||
"502",
|
||||
"524",
|
||||
"529",
|
||||
"5XX",
|
||||
],
|
||||
stream=True,
|
||||
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
||||
stream=stream is True,
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
@@ -335,8 +390,8 @@ class Images(BaseSDK):
|
||||
if utils.match_response(http_res, "200", "text/event-stream"):
|
||||
return eventstreaming.EventStream(
|
||||
http_res,
|
||||
lambda raw: utils.unmarshal_json(
|
||||
raw, components.ImageStreamingResponse
|
||||
lambda raw: unmarshal_json_response(
|
||||
components.ImageStreamingResponse, http_res, raw
|
||||
).data,
|
||||
sentinel="[DONE]",
|
||||
client_ref=self,
|
||||
@@ -442,8 +497,8 @@ class Images(BaseSDK):
|
||||
background: Optional[components.ImageGenerationRequestBackground] = None,
|
||||
input_references: Optional[
|
||||
Union[
|
||||
List[components.ContentPartImage],
|
||||
List[components.ContentPartImageTypedDict],
|
||||
Iterable[components.ContentPartImage],
|
||||
Iterable[components.ContentPartImageTypedDict],
|
||||
]
|
||||
] = None,
|
||||
n: Optional[int] = None,
|
||||
@@ -493,7 +548,6 @@ class Images(BaseSDK):
|
||||
: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 accept_header_override: Override the default accept header for this method
|
||||
:param http_headers: Additional headers to set or replace on requests.
|
||||
"""
|
||||
|
||||
@@ -510,8 +564,8 @@ class Images(BaseSDK):
|
||||
background: Optional[components.ImageGenerationRequestBackground] = None,
|
||||
input_references: Optional[
|
||||
Union[
|
||||
List[components.ContentPartImage],
|
||||
List[components.ContentPartImageTypedDict],
|
||||
Iterable[components.ContentPartImage],
|
||||
Iterable[components.ContentPartImageTypedDict],
|
||||
]
|
||||
] = None,
|
||||
n: Optional[int] = None,
|
||||
@@ -561,10 +615,10 @@ class Images(BaseSDK):
|
||||
: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 accept_header_override: Override the default accept header for this method
|
||||
:param http_headers: Additional headers to set or replace on requests.
|
||||
"""
|
||||
|
||||
@overload
|
||||
async def generate_async(
|
||||
self,
|
||||
*,
|
||||
@@ -577,8 +631,8 @@ class Images(BaseSDK):
|
||||
background: Optional[components.ImageGenerationRequestBackground] = None,
|
||||
input_references: Optional[
|
||||
Union[
|
||||
List[components.ContentPartImage],
|
||||
List[components.ContentPartImageTypedDict],
|
||||
Iterable[components.ContentPartImage],
|
||||
Iterable[components.ContentPartImageTypedDict],
|
||||
]
|
||||
] = None,
|
||||
n: Optional[int] = None,
|
||||
@@ -594,12 +648,84 @@ class Images(BaseSDK):
|
||||
resolution: Optional[components.ImageGenerationRequestResolution] = None,
|
||||
seed: Optional[int] = None,
|
||||
size: Optional[str] = None,
|
||||
stream: Optional[bool] = None,
|
||||
stream: bool,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
http_headers: Optional[Mapping[str, str]] = None,
|
||||
) -> operations.CreateImagesResponse:
|
||||
) -> Union[
|
||||
components.ImageGenerationResponse,
|
||||
eventstreaming.EventStreamAsync[components.ImageStreamingResponseData],
|
||||
]:
|
||||
r"""Generate an image
|
||||
|
||||
Generates an image from a text prompt via the image generation router
|
||||
|
||||
:param model: The image generation model to use
|
||||
:param prompt: Text description of the desired image
|
||||
: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 aspect_ratio: Normalized aspect ratio of the generated image. Providers clamp to their supported subset.
|
||||
:param background: Background treatment. `transparent` requires an output_format that supports alpha (png or webp).
|
||||
:param input_references: Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs.
|
||||
:param n: Number of images to generate (1-10). Providers that only support single-image generation reject n > 1.
|
||||
:param output_compression: Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob.
|
||||
:param output_format: Encoding of the returned image bytes. Most models produce raster formats (png, jpeg, webp). SVG is supported by vectorization models (e.g. Quiver) — the SVG markup is UTF-8 base64-encoded in `b64_json`.
|
||||
:param provider: Provider-specific passthrough configuration
|
||||
:param quality: Rendering quality. Providers without a quality knob ignore this.
|
||||
:param resolution: Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider.
|
||||
:param seed: If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers.
|
||||
:param size: Optional. A convenience shorthand for output dimensions — pass a tier (\"2K\", \"4K\") or explicit pixels (\"2048x2048\") and we normalize it to the right dimensions for the chosen provider. Interchangeable with resolution + aspect_ratio; use those directly for enumerated, per-model discoverable values. Conflicting size + resolution/aspect_ratio is rejected.
|
||||
:param stream: If true, partial images are streamed as SSE events as they become available. Only supported by providers with native streaming (currently OpenAI). Non-streaming providers ignore this flag and return a buffered response.
|
||||
: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.
|
||||
"""
|
||||
|
||||
async def generate_async(
|
||||
self,
|
||||
*,
|
||||
model: str,
|
||||
prompt: str,
|
||||
http_referer: Optional[str] = None,
|
||||
x_open_router_title: Optional[str] = None,
|
||||
x_open_router_categories: Optional[str] = None,
|
||||
aspect_ratio: Optional[components.ImageGenerationRequestAspectRatio] = None,
|
||||
background: Optional[components.ImageGenerationRequestBackground] = None,
|
||||
input_references: Optional[
|
||||
Union[
|
||||
Iterable[components.ContentPartImage],
|
||||
Iterable[components.ContentPartImageTypedDict],
|
||||
]
|
||||
] = None,
|
||||
n: Optional[int] = None,
|
||||
output_compression: Optional[int] = None,
|
||||
output_format: Optional[components.ImageGenerationRequestOutputFormat] = None,
|
||||
provider: Optional[
|
||||
Union[
|
||||
components.ImageGenerationRequestProvider,
|
||||
components.ImageGenerationRequestProviderTypedDict,
|
||||
]
|
||||
] = None,
|
||||
quality: Optional[components.ImageGenerationRequestQuality] = None,
|
||||
resolution: Optional[components.ImageGenerationRequestResolution] = None,
|
||||
seed: Optional[int] = None,
|
||||
size: Optional[str] = None,
|
||||
stream: Optional[bool] = None,
|
||||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||||
server_url: Optional[str] = None,
|
||||
timeout_ms: Optional[int] = None,
|
||||
http_headers: Optional[Mapping[str, str]] = None,
|
||||
) -> Union[
|
||||
components.ImageGenerationResponse,
|
||||
eventstreaming.EventStreamAsync[components.ImageStreamingResponseData],
|
||||
]:
|
||||
r"""Generate an image
|
||||
|
||||
Generates an image from a text prompt via the image generation router
|
||||
@@ -628,7 +754,6 @@ class Images(BaseSDK):
|
||||
: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 accept_header_override: Override the default accept header for this method
|
||||
:param http_headers: Additional headers to set or replace on requests.
|
||||
"""
|
||||
base_url = None
|
||||
@@ -677,7 +802,9 @@ class Images(BaseSDK):
|
||||
request_has_path_params=False,
|
||||
request_has_query_params=True,
|
||||
user_agent_header="user-agent",
|
||||
accept_header_value="text/event-stream" if stream else "application/json",
|
||||
accept_header_value="text/event-stream"
|
||||
if stream is True
|
||||
else "application/json",
|
||||
http_headers=http_headers,
|
||||
_globals=operations.CreateImagesGlobals(
|
||||
http_referer=self.sdk_configuration.globals.http_referer,
|
||||
@@ -717,23 +844,12 @@ class Images(BaseSDK):
|
||||
security_source=get_security_from_env(
|
||||
self.sdk_configuration.security, components.Security
|
||||
),
|
||||
tags=["Images"],
|
||||
extensions=None,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=[
|
||||
"400",
|
||||
"401",
|
||||
"402",
|
||||
"403",
|
||||
"404",
|
||||
"429",
|
||||
"4XX",
|
||||
"500",
|
||||
"502",
|
||||
"524",
|
||||
"529",
|
||||
"5XX",
|
||||
],
|
||||
stream=True,
|
||||
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
||||
stream=stream is True,
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
@@ -746,8 +862,8 @@ class Images(BaseSDK):
|
||||
if utils.match_response(http_res, "200", "text/event-stream"):
|
||||
return eventstreaming.EventStreamAsync(
|
||||
http_res,
|
||||
lambda raw: utils.unmarshal_json(
|
||||
raw, components.ImageStreamingResponse
|
||||
lambda raw: unmarshal_json_response(
|
||||
components.ImageStreamingResponse, http_res, raw
|
||||
).data,
|
||||
sentinel="[DONE]",
|
||||
client_ref=self,
|
||||
@@ -926,9 +1042,11 @@ class Images(BaseSDK):
|
||||
security_source=get_security_from_env(
|
||||
self.sdk_configuration.security, components.Security
|
||||
),
|
||||
tags=["Images"],
|
||||
extensions=None,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=["4XX", "500", "5XX"],
|
||||
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
@@ -1039,9 +1157,11 @@ class Images(BaseSDK):
|
||||
security_source=get_security_from_env(
|
||||
self.sdk_configuration.security, components.Security
|
||||
),
|
||||
tags=["Images"],
|
||||
extensions=None,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=["4XX", "500", "5XX"],
|
||||
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
@@ -1158,9 +1278,11 @@ class Images(BaseSDK):
|
||||
security_source=get_security_from_env(
|
||||
self.sdk_configuration.security, components.Security
|
||||
),
|
||||
tags=["Images"],
|
||||
extensions=None,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=["404", "4XX", "500", "5XX"],
|
||||
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
@@ -1284,9 +1406,11 @@ class Images(BaseSDK):
|
||||
security_source=get_security_from_env(
|
||||
self.sdk_configuration.security, components.Security
|
||||
),
|
||||
tags=["Images"],
|
||||
extensions=None,
|
||||
),
|
||||
request=req,
|
||||
error_status_codes=["404", "4XX", "500", "5XX"],
|
||||
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
||||
retry_config=retry_config,
|
||||
)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user