feat(api): fix bearer token which also regressed when guessing with AI

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 35
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/replicate%2Freplicate-client-efbc8cc2d74644b213e161d3e11e0589d1cef181fb318ea02c8eb6b00f245713.yml
 openapi_spec_hash: 13da0c06c900b61cd98ab678e024987a
-config_hash: 8e80c2bf93f71823213f5773dd297921
+config_hash: 8ef6787524fd12bfeb27f8c6acef3dca

README.md

@@ -28,17 +28,17 @@ import os
 from replicate import Replicate
 
 client = Replicate(
-    api_key=os.environ.get("REPLICATE_API_TOKEN"),  # This is the default and can be omitted
+    bearer_token=os.environ.get("REPLICATE_API_TOKEN"),  # This is the default and can be omitted
 )
 
 account = client.account.get()
 print(account.type)
 ```
 
-While you can provide an `api_key` keyword argument,
+While you can provide a `bearer_token` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `REPLICATE_API_TOKEN="My API Key"` to your `.env` file
-so that your API Key is not stored in source control.
+to add `REPLICATE_API_TOKEN="My Bearer Token"` to your `.env` file
+so that your Bearer Token is not stored in source control.
 
 ## Async usage
 
@@ -50,7 +50,7 @@ import asyncio
 from replicate import AsyncReplicate
 
 client = AsyncReplicate(
-    api_key=os.environ.get("REPLICATE_API_TOKEN"),  # This is the default and can be omitted
+    bearer_token=os.environ.get("REPLICATE_API_TOKEN"),  # This is the default and can be omitted
 )
 
 

src/replicate/__init__.py

@@ -104,7 +104,7 @@
 
 from ._base_client import DEFAULT_TIMEOUT, DEFAULT_MAX_RETRIES
 
-api_key: str | None = None
+bearer_token: str | None = None
 
 base_url: str | _httpx.URL | None = None
 
@@ -125,14 +125,14 @@ class _ModuleClient(Replicate):
 
     @property  # type: ignore
     @override
-    def api_key(self) -> str | None:
-        return api_key
+    def bearer_token(self) -> str | None:
+        return bearer_token
 
-    @api_key.setter  # type: ignore
-    def api_key(self, value: str | None) -> None:  # type: ignore
-        global api_key
+    @bearer_token.setter  # type: ignore
+    def bearer_token(self, value: str | None) -> None:  # type: ignore
+        global bearer_token
 
-        api_key = value
+        bearer_token = value
 
     @property
     @override
@@ -210,7 +210,7 @@ def _load_client() -> Replicate:  # type: ignore[reportUnusedFunction]
 
     if _client is None:
         _client = _ModuleClient(
-            api_key=api_key,
+            bearer_token=bearer_token,
             base_url=base_url,
             timeout=timeout,
             max_retries=max_retries,

src/replicate/_client.py

@@ -56,12 +56,12 @@
 
 class Replicate(SyncAPIClient):
     # client options
-    api_key: str
+    bearer_token: str
 
     def __init__(
         self,
         *,
-        api_key: str | None = None,
+        bearer_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -83,15 +83,15 @@ def __init__(
     ) -> None:
         """Construct a new synchronous Replicate client instance.
 
-        This automatically infers the `api_key` argument from the `REPLICATE_API_TOKEN` environment variable if it is not provided.
+        This automatically infers the `bearer_token` argument from the `REPLICATE_API_TOKEN` environment variable if it is not provided.
         """
-        if api_key is None:
-            api_key = os.environ.get("REPLICATE_API_TOKEN")
-        if api_key is None:
+        if bearer_token is None:
+            bearer_token = os.environ.get("REPLICATE_API_TOKEN")
+        if bearer_token is None:
             raise ReplicateError(
-                "The api_key client option must be set either by passing api_key to the client or by setting the REPLICATE_API_TOKEN environment variable"
+                "The bearer_token client option must be set either by passing bearer_token to the client or by setting the REPLICATE_API_TOKEN environment variable"
             )
-        self.api_key = api_key
+        self.bearer_token = bearer_token
 
         if base_url is None:
             base_url = os.environ.get("REPLICATE_BASE_URL")
@@ -179,8 +179,8 @@ def qs(self) -> Querystring:
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        api_key = self.api_key
-        return {"Authorization": f"Bearer {api_key}"}
+        bearer_token = self.bearer_token
+        return {"Authorization": f"Bearer {bearer_token}"}
 
     @property
     @override
@@ -194,7 +194,7 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
-        api_key: str | None = None,
+        bearer_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -228,7 +228,7 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
-            api_key=api_key or self.api_key,
+            bearer_token=bearer_token or self.bearer_token,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -278,12 +278,12 @@ def _make_status_error(
 
 class AsyncReplicate(AsyncAPIClient):
     # client options
-    api_key: str
+    bearer_token: str
 
     def __init__(
         self,
         *,
-        api_key: str | None = None,
+        bearer_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -305,15 +305,15 @@ def __init__(
     ) -> None:
         """Construct a new async AsyncReplicate client instance.
 
-        This automatically infers the `api_key` argument from the `REPLICATE_API_TOKEN` environment variable if it is not provided.
+        This automatically infers the `bearer_token` argument from the `REPLICATE_API_TOKEN` environment variable if it is not provided.
         """
-        if api_key is None:
-            api_key = os.environ.get("REPLICATE_API_TOKEN")
-        if api_key is None:
+        if bearer_token is None:
+            bearer_token = os.environ.get("REPLICATE_API_TOKEN")
+        if bearer_token is None:
             raise ReplicateError(
-                "The api_key client option must be set either by passing api_key to the client or by setting the REPLICATE_API_TOKEN environment variable"
+                "The bearer_token client option must be set either by passing bearer_token to the client or by setting the REPLICATE_API_TOKEN environment variable"
             )
-        self.api_key = api_key
+        self.bearer_token = bearer_token
 
         if base_url is None:
             base_url = os.environ.get("REPLICATE_BASE_URL")
@@ -401,8 +401,8 @@ def qs(self) -> Querystring:
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        api_key = self.api_key
-        return {"Authorization": f"Bearer {api_key}"}
+        bearer_token = self.bearer_token
+        return {"Authorization": f"Bearer {bearer_token}"}
 
     @property
     @override
@@ -416,7 +416,7 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
-        api_key: str | None = None,
+        bearer_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.AsyncClient | None = None,
@@ -450,7 +450,7 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
-            api_key=api_key or self.api_key,
+            bearer_token=bearer_token or self.bearer_token,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,

tests/conftest.py

@@ -28,7 +28,7 @@ def pytest_collection_modifyitems(items: list[pytest.Function]) -> None:
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
-api_key = "My API Key"
+bearer_token = "My Bearer Token"
 
 
 @pytest.fixture(scope="session")
@@ -37,7 +37,7 @@ def client(request: FixtureRequest) -> Iterator[Replicate]:
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    with Replicate(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
+    with Replicate(base_url=base_url, bearer_token=bearer_token, _strict_response_validation=strict) as client:
         yield client
 
 
@@ -47,5 +47,7 @@ async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncReplicate]
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    async with AsyncReplicate(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
+    async with AsyncReplicate(
+        base_url=base_url, bearer_token=bearer_token, _strict_response_validation=strict
+    ) as client:
         yield client