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

runapi/gpt_image/__init__.py

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

runapi/gpt_image/client.py

@@ -0,0 +1,30 @@
+"""GPT Image 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 GptImageClient:
+    """GPT Image text-to-image and edit-image client.
+
+    Example::
+
+        client = GptImageClient(api_key="sk-...")
+        result = client.text_to_image.run(
+            model="gpt-image-1.5", prompt="A futuristic cityscape",
+            aspect_ratio="1:1", quality="high",
+        )
+    """
+
+    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/resources/__init__.py

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

runapi/gpt_image/resources/edit_image.py

@@ -0,0 +1,81 @@
+"""GPT Image 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,
+    QUALITY_VALUES,
+    CompletedEditImageResponse,
+    EditImageResponse,
+)
+
+
+class EditImage(Resource):
+    """Edit images from a prompt and source images with GPT Image models."""
+
+    ENDPOINT = "/api/v1/gpt_image/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 image editing")
+
+        if not params.get("aspect_ratio"):
+            raise ValidationError("aspect_ratio is required")
+        self._validate_optional(params, "aspect_ratio", ASPECT_RATIOS)
+        if not params.get("quality"):
+            raise ValidationError("quality is required")
+        self._validate_optional(params, "quality", QUALITY_VALUES)

runapi/gpt_image/resources/text_to_image.py

@@ -0,0 +1,77 @@
+"""GPT Image 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,
+    QUALITY_VALUES,
+    CompletedTextToImageResponse,
+    TextToImageResponse,
+)
+
+
+class TextToImage(Resource):
+    """Generate images from text prompts with GPT Image models."""
+
+    ENDPOINT = "/api/v1/gpt_image/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)}")
+
+        if not params.get("aspect_ratio"):
+            raise ValidationError("aspect_ratio is required")
+        self._validate_optional(params, "aspect_ratio", ASPECT_RATIOS)
+        if not params.get("quality"):
+            raise ValidationError("quality is required")
+        self._validate_optional(params, "quality", QUALITY_VALUES)

runapi/gpt_image/types.py

@@ -0,0 +1,36 @@
+"""GPT Image model lists, enums, and response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+MODELS = ["gpt-image-1.5"]
+GENERATION_MODELS = MODELS
+EDIT_MODELS = MODELS
+
+ASPECT_RATIOS = ["1:1", "2:3", "3:2"]
+QUALITY_VALUES = ["medium", "high"]
+
+
+class Image(BaseModel):
+    url = optional(str)
+
+
+class TextToImageResponse(TaskResponse):
+    """Task status/result for GPT Image 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-0.1.0.dist-info/METADATA

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: runapi-gpt-image
+Version: 0.1.0
+Summary: GPT Image text-to-image and edit-image client for RunAPI
+Project-URL: Homepage, https://runapi.ai/models/gpt-image
+Project-URL: Documentation, https://runapi.ai/docs#sdk-gpt-image
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: ai,edit-image,gpt-image,runapi,sdk,text-to-image
+Requires-Python: >=3.9
+Requires-Dist: runapi-core
+Description-Content-Type: text/markdown
+
+# GPT Image Python SDK for RunAPI
+
+The GPT Image Python SDK is the language-specific package for GPT Image 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; for API reference, use
+https://runapi.ai/docs#gpt-image; for SDK docs, use https://runapi.ai/docs#sdk-gpt-image.
+
+## Install
+
+```bash
+pip install runapi-gpt-image
+```
+
+## Quick start
+
+```python
+from runapi.gpt_image import GptImageClient
+
+client = GptImageClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.text_to_image.create(
+    model="gpt-image-1.5",
+    prompt="A futuristic cityscape at dusk, cinematic",
+    aspect_ratio="1:1",
+    quality="high",
+)
+status = client.text_to_image.get(task.id)
+
+edit = client.edit_image.create(
+    model="gpt-image-1.5",
+    prompt="Transform into an oil painting",
+    source_image_urls=["https://example.com/source.jpg"],
+    aspect_ratio="1:1",
+    quality="high",
+)
+```
+
+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-1.5",
+    prompt="A serene mountain lake at dawn",
+    aspect_ratio="3:2",
+    quality="high",
+)
+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` 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
+- SDK docs: https://runapi.ai/docs#sdk-gpt-image
+- Product docs: https://runapi.ai/docs#gpt-image
+- Pricing and rate limits: https://runapi.ai/models/gpt-image
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_gpt_image-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+runapi/gpt_image/__init__.py,sha256=wTzjjdwD4O_XtsOQ--K_cUEejxNrP5-J2ZFsC3x-VrE,467
+runapi/gpt_image/client.py,sha256=EBENbQa5yoTterpZTS0T0DhyxMMR08jRkbv7GuXJr7A,946
+runapi/gpt_image/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runapi/gpt_image/types.py,sha256=qarlZACOYKDbLc7v1BLvQ_428ba41Ya2bmXa4meOcoc,895
+runapi/gpt_image/resources/__init__.py,sha256=cWTZRb2Hewznm9agkhjkcKjEPbJO2YaQOW1fuixLjtw,113
+runapi/gpt_image/resources/edit_image.py,sha256=EHhHplI805A0Ma7NtEzpAFuoCZQiUdpVCyMAU4OQRN8,2581
+runapi/gpt_image/resources/text_to_image.py,sha256=PAPkVKOcCvsiDIJwkErlB9eGiLDoOuTCyaX7a4LjnkU,2416
+runapi_gpt_image-0.1.0.dist-info/METADATA,sha256=jmmlwhDVWT-g7rxsjzJA2nQHsGiheG5fXHyrqzs7YMo,2785
+runapi_gpt_image-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+runapi_gpt_image-0.1.0.dist-info/RECORD,,

runapi_gpt_image-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