indoxrouter 0.1.26__py3-none-any.whl → 0.1.27__py3-none-any.whl

indoxrouter/__init__.py

@@ -47,7 +47,7 @@ from .exceptions import (
     APIError,
 )
 
-__version__ = "0.1.26"
+__version__ = "0.1.27"
 __all__ = [
     "Client",
     "IndoxRouter",

indoxrouter/client.py

@@ -14,6 +14,7 @@ The Client class offers methods for:
 - Accessing AI capabilities: chat completions, text completions, embeddings, image generation, and text-to-speech
 - Retrieving information about available providers and models
 - Monitoring usage statistics and credit consumption
+- BYOK (Bring Your Own Key) support for using your own provider API keys
 
 Usage example:
     ```python
@@ -37,6 +38,11 @@ Usage example:
     # Generate text-to-speech audio
     audio = client.text_to_speech("Hello, welcome to IndoxRouter!", model="openai/tts-1", voice="alloy")
 
+    # Using BYOK (Bring Your Own Key)
+    response = client.chat([
+        {"role": "user", "content": "Hello!"}
+    ], model="openai/gpt-4", byok_api_key="sk-your-openai-key-here")
+
     # Clean up resources when done
     client.close()
     ```
@@ -46,6 +52,21 @@ The client can also be used as a context manager:
     with Client(api_key="your_api_key") as client:
         response = client.chat([{"role": "user", "content": "Hello!"}], model="openai/gpt-4o-mini")
     ```
+
+BYOK (Bring Your Own Key) Support:
+    The client supports BYOK, allowing you to use your own API keys for AI providers:
+
+    - No credit deduction from your IndoxRouter account
+    - No rate limiting from the platform
+    - Direct provider access with your own API keys
+    - Cost control - you pay providers directly at their rates
+
+    Example:
+        response = client.chat(
+            messages=[{"role": "user", "content": "Hello!"}],
+            model="openai/gpt-4",
+            byok_api_key="sk-your-openai-key-here"
+        )
 """
 
 import os
@@ -459,6 +480,7 @@ class Client:
         temperature: float = 0.7,
         max_tokens: Optional[int] = None,
         stream: bool = False,
+        byok_api_key: Optional[str] = None,
         **kwargs,
     ) -> Dict[str, Any]:
         """
@@ -470,6 +492,7 @@ class Client:
             temperature: Sampling temperature
             max_tokens: Maximum number of tokens to generate
             stream: Whether to stream the response
+            byok_api_key: Your own API key for the provider (BYOK - Bring Your Own Key)
             **kwargs: Additional parameters to pass to the API
 
         Returns:
@@ -490,6 +513,7 @@ class Client:
             "temperature": temperature,
             "max_tokens": max_tokens,
             "stream": stream,
+            "byok_api_key": byok_api_key,
             "additional_params": filtered_kwargs,
         }
 
@@ -506,6 +530,7 @@ class Client:
         temperature: float = 0.7,
         max_tokens: Optional[int] = None,
         stream: bool = False,
+        byok_api_key: Optional[str] = None,
         **kwargs,
     ) -> Dict[str, Any]:
         """
@@ -517,6 +542,7 @@ class Client:
             temperature: Sampling temperature
             max_tokens: Maximum number of tokens to generate
             stream: Whether to stream the response
+            byok_api_key: Your own API key for the provider (BYOK - Bring Your Own Key)
             **kwargs: Additional parameters to pass to the API
 
         Returns:
@@ -537,6 +563,7 @@ class Client:
             "temperature": temperature,
             "max_tokens": max_tokens,
             "stream": stream,
+            "byok_api_key": byok_api_key,
             "additional_params": filtered_kwargs,
         }
 
@@ -550,6 +577,7 @@ class Client:
         self,
         text: Union[str, List[str]],
         model: str = DEFAULT_EMBEDDING_MODEL,
+        byok_api_key: Optional[str] = None,
         **kwargs,
     ) -> Dict[str, Any]:
         """
@@ -558,6 +586,7 @@ class Client:
         Args:
             text: Text to embed (string or list of strings)
             model: Model to use in the format "provider/model" (e.g., "openai/text-embedding-ada-002")
+            byok_api_key: Your own API key for the provider (BYOK - Bring Your Own Key)
             **kwargs: Additional parameters to pass to the API
 
         Returns:
@@ -575,6 +604,7 @@ class Client:
         data = {
             "text": text if isinstance(text, list) else [text],
             "model": formatted_model,
+            "byok_api_key": byok_api_key,
             "additional_params": filtered_kwargs,
         }
 
@@ -610,6 +640,7 @@ class Client:
         enhance_prompt: Optional[bool] = None,
         # Google-specific direct parameters
         aspect_ratio: Optional[str] = None,
+        byok_api_key: Optional[str] = None,
         **kwargs,
     ) -> Dict[str, Any]:
         """
@@ -650,6 +681,8 @@ class Client:
             enhance_prompt: Whether to use prompt rewriting logic
             aspect_ratio: Aspect ratio for Google models (e.g., "1:1", "16:9") - preferred over size
 
+            byok_api_key: Your own API key for the provider (BYOK - Bring Your Own Key)
+
             **kwargs: Additional parameters to pass to the API
 
         Returns:
@@ -674,6 +707,7 @@ class Client:
         data = {
             "prompt": prompt,
             "model": formatted_model,
+            "byok_api_key": byok_api_key,
         }
 
         # Add optional parameters only if they are explicitly provided
@@ -793,6 +827,7 @@ class Client:
         response_format: Optional[str] = None,
         speed: Optional[float] = None,
         instructions: Optional[str] = None,
+        byok_api_key: Optional[str] = None,
         **kwargs,
     ) -> Dict[str, Any]:
         """
@@ -805,6 +840,7 @@ class Client:
             response_format: Format of the audio response (e.g., "mp3", "opus", "aac", "flac")
             speed: Speed of the generated audio (0.25 to 4.0)
             instructions: Optional instructions for the TTS generation
+            byok_api_key: Your own API key for the provider (BYOK - Bring Your Own Key)
             **kwargs: Additional parameters to pass to the API
 
         Returns:
@@ -829,6 +865,13 @@ class Client:
                     model="provider/model-name",
                     voice="provider-specific-voice"
                 )
+
+            Using BYOK (Bring Your Own Key):
+                response = client.text_to_speech(
+                    "Hello, world!",
+                    model="openai/tts-1",
+                    byok_api_key="sk-your-openai-key-here"
+                )
         """
         # Format the model string
         formatted_model = self._format_model_string(model)
@@ -859,6 +902,10 @@ class Client:
         if filtered_kwargs:
             data["additional_params"] = filtered_kwargs
 
+        # Add BYOK API key if provided
+        if byok_api_key:
+            data["byok_api_key"] = byok_api_key
+
         return self._request("POST", TTS_ENDPOINT, data)
 
     def _get_supported_parameters_for_model(
@@ -875,7 +922,6 @@ class Client:
         Returns:
             List of parameter names supported by the model
         """
-        # Define supported parameters for specific models
         if provider.lower() == "openai" and "gpt-image" in model_name.lower():
             return [
                 "prompt",

{indoxrouter-0.1.26.dist-info → indoxrouter-0.1.27.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: indoxrouter
-Version: 0.1.26
+Version: 0.1.27
 Summary: A unified client for various AI providers
 Author-email: indoxRouter Team <ashkan.eskandari.dev@gmail.com>
 License: MIT
@@ -33,6 +33,7 @@ A unified client for various AI providers, including OpenAI, anthropic, Google,
 - **Simple Interface**: Easy-to-use methods for chat, completion, embeddings, image generation, and text-to-speech
 - **Error Handling**: Standardized error handling across providers
 - **Authentication**: Secure cookie-based authentication
+- **BYOK Support**: Bring Your Own Key support for using your own provider API keys
 
 ## Installation
 
@@ -131,6 +132,34 @@ if "b64_json" in response["data"][0]:
     # Use the base64 data (e.g., to display in HTML or save to file)
 ```
 
+### BYOK (Bring Your Own Key) Support
+
+IndoxRouter supports BYOK, allowing you to use your own API keys for AI providers:
+
+```python
+# Use your own OpenAI API key
+response = client.chat(
+    messages=[{"role": "user", "content": "Hello!"}],
+    model="openai/gpt-4",
+    byok_api_key="sk-your-openai-key-here"
+)
+
+# Use your own Google API key for image generation
+response = client.images(
+    prompt="A beautiful sunset",
+    model="google/imagen-3.0-generate-002",
+    aspect_ratio="16:9",
+    byok_api_key="your-google-api-key-here"
+)
+```
+
+**BYOK Benefits:**
+
+- No credit deduction from your IndoxRouter account
+- No platform rate limiting
+- Direct provider access with your own API keys
+- Cost control - pay providers directly at their rates
+
 ### Text-to-Speech
 
 ```python

indoxrouter-0.1.27.dist-info/RECORD

@@ -0,0 +1,9 @@
+indoxrouter/__init__.py,sha256=P_2eiiAi-DrkkeeJndQdEMqnVheWzOZIjWkDayrwxuk,1561
+indoxrouter/client.py,sha256=AirPauY2kFqpR46LWOtDBKs--_9ilFTc2RQHb7vsLnM,45694
+indoxrouter/constants.py,sha256=HqTXfNpL_UvWsR5mod8YZgWOs1W6x6itr1BSbmyYEHY,1451
+indoxrouter/exceptions.py,sha256=cGlXNF8dd4X8UBWgxTA099nRhEkIjcqE_4iGOlIVVp8,1632
+indoxrouter-0.1.27.dist-info/licenses/LICENSE,sha256=5n28CfoynFakg-QJIHnecEXcveN8gq-ZwhC0h7ATse0,24232
+indoxrouter-0.1.27.dist-info/METADATA,sha256=5bZ0cAhmLFMuRP8h_5uNOEPwu39xjIqUaT_6CEjyi_k,5740
+indoxrouter-0.1.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+indoxrouter-0.1.27.dist-info/top_level.txt,sha256=v6FGWkw0QAnXhyYtnXLI1cxzna0iveNvZUotVzCWabM,12
+indoxrouter-0.1.27.dist-info/RECORD,,

indoxrouter-0.1.26.dist-info/RECORD

@@ -1,9 +0,0 @@
-indoxrouter/__init__.py,sha256=NhFlmJxbxcM3XCF21YZv9QsOk-k50rsqzw5Bk3mmr6E,1561
-indoxrouter/client.py,sha256=KQpOFaTntNYmPgYjBJHq0z921vgKlyeUcaTYgZX7axM,43764
-indoxrouter/constants.py,sha256=HqTXfNpL_UvWsR5mod8YZgWOs1W6x6itr1BSbmyYEHY,1451
-indoxrouter/exceptions.py,sha256=cGlXNF8dd4X8UBWgxTA099nRhEkIjcqE_4iGOlIVVp8,1632
-indoxrouter-0.1.26.dist-info/licenses/LICENSE,sha256=5n28CfoynFakg-QJIHnecEXcveN8gq-ZwhC0h7ATse0,24232
-indoxrouter-0.1.26.dist-info/METADATA,sha256=nzfcnbrzEJznKEPA1gAG34-C5KjemPqUavXO2e8-3fs,4909
-indoxrouter-0.1.26.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-indoxrouter-0.1.26.dist-info/top_level.txt,sha256=v6FGWkw0QAnXhyYtnXLI1cxzna0iveNvZUotVzCWabM,12
-indoxrouter-0.1.26.dist-info/RECORD,,