runapi-gpt-image-2 0.1.0__py3-none-any.whl

runapi/gpt_image_2/__init__.py

@@ -0,0 +1,24 @@
+"""GPT Image 2 client for RunAPI."""
+
+from runapi.core import (
+    AuthenticationError,
+    InsufficientCreditsError,
+    NotFoundError,
+    RateLimitError,
+    TaskFailedError,
+    TaskTimeoutError,
+    ValidationError,
+)
+
+from .client import GptImage2Client
+
+__all__ = [
+    "GptImage2Client",
+    "AuthenticationError",
+    "RateLimitError",
+    "InsufficientCreditsError",
+    "NotFoundError",
+    "ValidationError",
+    "TaskFailedError",
+    "TaskTimeoutError",
+]

runapi/gpt_image_2/client.py

@@ -0,0 +1,29 @@
+"""GPT Image 2 client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ClientOptions, HttpClient, resolve_api_key
+
+from .resources.edit_image import EditImage
+from .resources.text_to_image import TextToImage
+
+
+class GptImage2Client:
+    """GPT Image 2 text-to-image and edit-image client.
+
+    Example::
+
+        client = GptImage2Client(api_key="sk-...")
+        result = client.text_to_image.run(
+            model="gpt-image-2", prompt="A futuristic cityscape at night"
+        )
+    """
+
+    def __init__(self, api_key: Optional[str] = None, **options: Any) -> None:
+        resolved_api_key = resolve_api_key(api_key)
+        client_options = ClientOptions(api_key=resolved_api_key, **options)
+        http = client_options.http_client or HttpClient(client_options)
+        self.text_to_image = TextToImage(http)
+        self.edit_image = EditImage(http)

runapi/gpt_image_2/resources/__init__.py

@@ -0,0 +1,4 @@
+from .edit_image import EditImage
+from .text_to_image import TextToImage
+
+__all__ = ["TextToImage", "EditImage"]

runapi/gpt_image_2/resources/edit_image.py

@@ -0,0 +1,77 @@
+"""GPT Image 2 edit-image resource."""
+
+from __future__ import annotations
+
+from typing import Any, Dict
+
+from runapi.core import Resource, ValidationError
+
+from ..types import (
+    ASPECT_RATIOS,
+    EDIT_MODELS,
+    RESOLUTIONS,
+    CompletedEditImageResponse,
+    EditImageResponse,
+)
+
+
+class EditImage(Resource):
+    """Edit images from a prompt and source images with GPT Image 2."""
+
+    ENDPOINT = "/api/v1/gpt_image_2/edit_image"
+
+    RESPONSE_CLASS = EditImageResponse
+    COMPLETED_RESPONSE_CLASS = CompletedEditImageResponse
+
+    def run(self, **params: Any) -> Any:
+        """Create an edit-image task and poll until it completes.
+
+        Args:
+            **params: Edit-image parameters (model, prompt, ...).
+
+        Returns:
+            The completed edit-image response.
+        """
+        task = self.create(**params)
+        return self._poll_until_complete(lambda: self.get(task.id))
+
+    def create(self, **params: Any) -> Any:
+        """Create an edit-image task and return immediately with an id.
+
+        Args:
+            **params: Edit-image parameters (model, prompt, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        self._validate_params(compacted)
+        return self._request("post", self.ENDPOINT, body=compacted)
+
+    def get(self, id: str) -> Any:
+        """Fetch the current status of an edit-image task.
+
+        Args:
+            id: Task id.
+
+        Returns:
+            The current edit-image status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}")
+
+    def _validate_params(self, params: Dict[str, Any]) -> None:
+        if not params.get("model"):
+            raise ValidationError("model is required")
+        if not params.get("prompt"):
+            raise ValidationError("prompt is required")
+
+        model = params.get("model")
+        if model not in EDIT_MODELS:
+            raise ValidationError(f"Invalid model: {model}. Must be: {', '.join(EDIT_MODELS)}")
+
+        urls = params.get("source_image_urls")
+        if urls is None or (hasattr(urls, "__len__") and len(urls) == 0):
+            raise ValidationError("source_image_urls is required for edit image requests")
+
+        self._validate_optional(params, "aspect_ratio", ASPECT_RATIOS)
+        self._validate_optional(params, "output_resolution", RESOLUTIONS)

runapi/gpt_image_2/resources/text_to_image.py

@@ -0,0 +1,73 @@
+"""GPT Image 2 text-to-image resource."""
+
+from __future__ import annotations
+
+from typing import Any, Dict
+
+from runapi.core import Resource, ValidationError
+
+from ..types import (
+    ASPECT_RATIOS,
+    GENERATION_MODELS,
+    RESOLUTIONS,
+    CompletedTextToImageResponse,
+    TextToImageResponse,
+)
+
+
+class TextToImage(Resource):
+    """Generate images from text prompts with GPT Image 2."""
+
+    ENDPOINT = "/api/v1/gpt_image_2/text_to_image"
+
+    RESPONSE_CLASS = TextToImageResponse
+    COMPLETED_RESPONSE_CLASS = CompletedTextToImageResponse
+
+    def run(self, **params: Any) -> Any:
+        """Create a text-to-image task and poll until it completes.
+
+        Args:
+            **params: Text-to-image parameters (model, prompt, ...).
+
+        Returns:
+            The completed text-to-image response.
+        """
+        task = self.create(**params)
+        return self._poll_until_complete(lambda: self.get(task.id))
+
+    def create(self, **params: Any) -> Any:
+        """Create a text-to-image task and return immediately with an id.
+
+        Args:
+            **params: Text-to-image parameters (model, prompt, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        self._validate_params(compacted)
+        return self._request("post", self.ENDPOINT, body=compacted)
+
+    def get(self, id: str) -> Any:
+        """Fetch the current status of a text-to-image task.
+
+        Args:
+            id: Task id.
+
+        Returns:
+            The current text-to-image status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}")
+
+    def _validate_params(self, params: Dict[str, Any]) -> None:
+        if not params.get("model"):
+            raise ValidationError("model is required")
+        if not params.get("prompt"):
+            raise ValidationError("prompt is required")
+
+        model = params.get("model")
+        if model not in GENERATION_MODELS:
+            raise ValidationError(f"Invalid model: {model}. Must be: {', '.join(GENERATION_MODELS)}")
+
+        self._validate_optional(params, "aspect_ratio", ASPECT_RATIOS)
+        self._validate_optional(params, "output_resolution", RESOLUTIONS)

runapi/gpt_image_2/types.py

@@ -0,0 +1,36 @@
+"""GPT Image 2 model lists, enums, and response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+MODELS = ["gpt-image-2"]
+GENERATION_MODELS = MODELS
+EDIT_MODELS = MODELS
+
+ASPECT_RATIOS = ["auto", "1:1", "9:16", "16:9", "4:3", "3:4"]
+RESOLUTIONS = ["1k", "2k", "4k"]
+
+
+class Image(BaseModel):
+    url = optional(str)
+
+
+class TextToImageResponse(TaskResponse):
+    """Task status/result for GPT Image 2 text-to-image."""
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    images = optional([lambda: Image])
+    error = optional(str)
+
+
+EditImageResponse = TextToImageResponse
+
+
+class CompletedTextToImageResponse(TextToImageResponse):
+    """Narrowed response from ``run()`` once polling observes completion."""
+
+    images = required([lambda: Image])
+
+
+CompletedEditImageResponse = CompletedTextToImageResponse

runapi_gpt_image_2-0.1.0.dist-info/METADATA

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: runapi-gpt-image-2
+Version: 0.1.0
+Summary: GPT Image 2 text-to-image and edit-image client for RunAPI
+Project-URL: Homepage, https://runapi.ai/models/gpt-image-2
+Project-URL: Documentation, https://runapi.ai/docs#sdk-gpt-image-2
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: ai,edit-image,gpt-image-2,runapi,sdk,text-to-image
+Requires-Python: >=3.9
+Requires-Dist: runapi-core
+Description-Content-Type: text/markdown
+
+# GPT Image 2 Python SDK for RunAPI
+
+The GPT Image 2 Python SDK is the language-specific package for GPT Image 2 on
+RunAPI. Use it for text-to-image and edit-image flows when your application needs
+JSON request bodies, task status lookup, and consistent RunAPI errors in Python.
+
+For model details, use https://runapi.ai/models/gpt-image-2; for API reference,
+use https://runapi.ai/docs#gpt-image-2; for SDK docs, use
+https://runapi.ai/docs#sdk-gpt-image-2.
+
+## Install
+
+```bash
+pip install runapi-gpt-image-2
+```
+
+## Quick start
+
+```python
+from runapi.gpt_image_2 import GptImage2Client
+
+client = GptImage2Client()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.text_to_image.create(
+    model="gpt-image-2",
+    prompt="A futuristic cityscape at night, cinematic",
+    aspect_ratio="16:9",
+    output_resolution="2k",
+)
+status = client.text_to_image.get(task.id)
+
+edit = client.edit_image.create(
+    model="gpt-image-2",
+    prompt="Transform into oil painting style",
+    source_image_urls=["https://example.com/source.jpg"],
+)
+```
+
+Use `create` to submit a task and return quickly, `get` to fetch the latest task
+state, and `run` to create and poll until completion:
+
+```python
+result = client.text_to_image.run(
+    model="gpt-image-2",
+    prompt="A serene mountain lake at dawn",
+)
+print(result.images[0].url)
+```
+
+In web request handlers, prefer `create` plus webhook or later `get` polling so a
+worker is not held open.
+
+RunAPI-generated file URLs are temporary. Download and store generated images in
+your own durable storage within 7 days; do not treat returned URLs as long-term
+assets.
+
+## Language notes
+
+Pass parameters as keyword arguments and catch the `runapi.gpt_image_2` error
+classes when building image jobs or scripts. The available resources are
+`text_to_image` and `edit_image`. Keep `RUNAPI_API_KEY` in the environment or
+your secret manager; never commit API keys or callback secrets.
+
+## Links
+
+- Model page: https://runapi.ai/models/gpt-image-2
+- SDK docs: https://runapi.ai/docs#sdk-gpt-image-2
+- Product docs: https://runapi.ai/docs#gpt-image-2
+- Pricing and rate limits: https://runapi.ai/models/gpt-image-2
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_gpt_image_2-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+runapi/gpt_image_2/__init__.py,sha256=xU6VDYR1FBLH0EvUpTiR5o_63oWxFTHE9bfM20OMaho,471
+runapi/gpt_image_2/client.py,sha256=E4K4o_PTacNeC6X0jF4vP-p_7ye-WY-HRT4r6SwPubg,910
+runapi/gpt_image_2/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runapi/gpt_image_2/types.py,sha256=5_nUjQdKlzdP8sxGg8NbgNngaLCjOo_6ZYC7S5DzM_U,918
+runapi/gpt_image_2/resources/__init__.py,sha256=cWTZRb2Hewznm9agkhjkcKjEPbJO2YaQOW1fuixLjtw,113
+runapi/gpt_image_2/resources/edit_image.py,sha256=Fg4mTc8JSFe2wBHkhWSvTrj8ipEyHaRpjhYpWdFhp_E,2390
+runapi/gpt_image_2/resources/text_to_image.py,sha256=F4Q4HtbZT3RZ1cSIZLPAphJZooMUzPLOHlMUMTB5lq0,2219
+runapi_gpt_image_2-0.1.0.dist-info/METADATA,sha256=_YfFWGpd6VQsNA26nZ0rG4e2sNHmw88GABVzsABW9BY,2742
+runapi_gpt_image_2-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+runapi_gpt_image_2-0.1.0.dist-info/RECORD,,

runapi_gpt_image_2-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any