Skip to content

client

Client

An asynchronous client used for interacting with the API.

Parameters:

Name Type Description Default
api_key str

The root api key to use for requests.

 required

Other Parameters:

Name Type Description
api_version t.Optional[int]

The api version to access. Defaults to 1.
api_base_url t.Optional[str]

The base url to use for the api (no trailing /). Defaults to https://api.unkey.dev.
Source code in unkey/client.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
class Client:
    """An asynchronous client used for interacting with the API.

    Args:
        api_key: The root api key to use for requests.

    Keyword Args:
        api_version: The api version to access. Defaults to 1.

        api_base_url: The base url to use for the api (no trailing /).
            Defaults to `https://api.unkey.dev`.
    """

    __slots__ = (
        "_apis",
        "_http",
        "_keys",
        "_serializer",
    )

    def __init__(
        self,
        api_key: str,
        *,
        api_version: t.Optional[int] = None,
        api_base_url: t.Optional[str] = None,
    ) -> None:
        self._serializer = serializer.Serializer()
        self._http = services.HttpService(api_key, api_version, api_base_url)
        self.__init_core_services()

    def __init_core_services(self) -> None:
        self._apis = self.__init_service(services.ApiService)
        self._keys = self.__init_service(services.KeyService)

    def __init_service(self, service: t.Type[ServiceT]) -> ServiceT:
        if not issubclass(service, services.BaseService):
            raise TypeError(f"{service.__name__!r} can not be initialized as a service.")

        return service(self._http, self._serializer)  # type: ignore[return-value]

    @property
    def keys(self) -> services.KeyService:
        """The key service used to make key related requests."""
        return self._keys

    @property
    def apis(self) -> services.ApiService:
        """The api service used to make api related requests."""
        return self._apis

    def set_api_key(self, api_key: str) -> None:
        """Sets the api key used by the http service.

        Args:
            api_key: The new root api key to use for requests.
        """
        self._http.set_api_key(api_key)

    def set_api_base_url(self, base_url: str) -> None:
        """Sets the api base url used by the http service.

        Args:
            base_url: The new api base url to use for requests.
        """
        self._http.set_base_url(base_url)

    async def start(self) -> None:
        """Starts the client session to be used for http requests."""
        await self._http.start()

    async def close(self) -> None:
        """Closes the existing client session, if it's still open."""
        await self._http.close()

apis property 

apis: services.ApiService

The api service used to make api related requests.

keys property 

keys: services.KeyService

The key service used to make key related requests.

close async 

close() -> None

Closes the existing client session, if it's still open.

Source code in unkey/client.py 
84
85
86
async def close(self) -> None:
    """Closes the existing client session, if it's still open."""
    await self._http.close()

set_api_base_url 

set_api_base_url(base_url: str) -> None

Sets the api base url used by the http service.

Parameters:

Name Type Description Default
base_url str

The new api base url to use for requests.

 required
Source code in unkey/client.py 
72
73
74
75
76
77
78
def set_api_base_url(self, base_url: str) -> None:
    """Sets the api base url used by the http service.

    Args:
        base_url: The new api base url to use for requests.
    """
    self._http.set_base_url(base_url)

set_api_key 

set_api_key(api_key: str) -> None

Sets the api key used by the http service.

Parameters:

Name Type Description Default
api_key str

The new root api key to use for requests.

 required
Source code in unkey/client.py 
64
65
66
67
68
69
70
def set_api_key(self, api_key: str) -> None:
    """Sets the api key used by the http service.

    Args:
        api_key: The new root api key to use for requests.
    """
    self._http.set_api_key(api_key)

start async 

start() -> None

Starts the client session to be used for http requests.

Source code in unkey/client.py 
80
81
82
async def start(self) -> None:
    """Starts the client session to be used for http requests."""
    await self._http.start()