Developer-friendly & type-safe Python SDK for Unkey's API.
- SDK Installation
- IDE Support
- SDK Example Usage
- Available Resources and Operations
- Pagination
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
The SDK can be installed with either pip or poetry package managers.
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install unkey.pyPoetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add unkey.pyGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
# Synchronous Example
import os
from unkey_py import Unkey
s = Unkey(
bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
)
res = s.liveness.check()
if res.object is not None:
# handle response
passThe same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
import os
from unkey_py import Unkey
async def main():
s = Unkey(
bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
)
res = await s.liveness.check_async()
if res.object is not None:
# handle response
pass
asyncio.run(main())Available methods
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a Next method that can be called to pull down the next group of results. If the
return value of Next is None, then there are no more pages to be fetched.
Here's an example of one such pagination call:
import os
from unkey_py import Unkey
s = Unkey(
bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
)
res = s.identities.list(limit=100)
if res.object is not None:
while True:
# handle items
res = res.next()
if res is None:
breakSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:
import os
from unkey.utils import BackoffStrategy, RetryConfig
from unkey_py import Unkey
s = Unkey(
bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
)
res = s.liveness.check(,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
if res.object is not None:
# handle response
passIf you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:
import os
from unkey.utils import BackoffStrategy, RetryConfig
from unkey_py import Unkey
s = Unkey(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
)
res = s.liveness.check()
if res.object is not None:
# handle response
passHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will raise a models.SDKError exception, which has the following properties:
| Property | Type | Description |
|---|---|---|
.status_code |
int | The HTTP status code |
.message |
str | The error message |
.raw_response |
httpx.Response | The raw HTTP response |
.body |
str | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the check_async method may raise the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| models.ErrBadRequest | 400 | application/json |
| models.ErrUnauthorized | 401 | application/json |
| models.ErrForbidden | 403 | application/json |
| models.ErrNotFound | 404 | application/json |
| models.ErrConflict | 409 | application/json |
| models.ErrTooManyRequests | 429 | application/json |
| models.ErrInternalServerError | 500 | application/json |
| models.SDKError | 4XX, 5XX | */* |
import os
from unkey_py import Unkey, models
s = Unkey(
bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
)
res = None
try:
res = s.liveness.check()
if res.object is not None:
# handle response
pass
except models.ErrBadRequest as e:
# handle e.data: models.ErrBadRequestData
raise(e)
except models.ErrUnauthorized as e:
# handle e.data: models.ErrUnauthorizedData
raise(e)
except models.ErrForbidden as e:
# handle e.data: models.ErrForbiddenData
raise(e)
except models.ErrNotFound as e:
# handle e.data: models.ErrNotFoundData
raise(e)
except models.ErrConflict as e:
# handle e.data: models.ErrConflictData
raise(e)
except models.ErrTooManyRequests as e:
# handle e.data: models.ErrTooManyRequestsData
raise(e)
except models.ErrInternalServerError as e:
# handle e.data: models.ErrInternalServerErrorData
raise(e)
except models.SDKError as e:
# handle exception
raise(e)You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | https://api.unkey.dev |
None |
import os
from unkey_py import Unkey
s = Unkey(
server_idx=0,
bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
)
res = s.liveness.check()
if res.object is not None:
# handle response
passThe default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
import os
from unkey_py import Unkey
s = Unkey(
server_url="https://api.unkey.dev",
bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
)
res = s.liveness.check()
if res.object is not None:
# handle response
passThe Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from unkey_py import Unkey
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Unkey(client=http_client)or you could wrap the client with your own custom logic:
from unkey_py import Unkey
from unkey_py.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = Unkey(async_client=CustomClient(httpx.AsyncClient()))This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
bearer_auth |
http | HTTP Bearer | UNKEY_BEARER_AUTH |
To authenticate with the API the bearer_auth parameter must be set when initializing the SDK client instance. For example:
import os
from unkey_py import Unkey
s = Unkey(
bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
)
res = s.liveness.check()
if res.object is not None:
# handle response
passYou can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from unkey_py import Unkey
import logging
logging.basicConfig(level=logging.DEBUG)
s = Unkey(debug_logger=logging.getLogger("unkey_py"))You can also enable a default debug logger by setting an environment variable UNKEY_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.