Gumnut Python API library
The Gumnut Python library provides convenient access to the Gumnut REST API from any Python 3.11+ application. The library includes type definitions for all request params and response fields, and offers both synchronous and asynchronous clients powered by httpx.
Documentation
The REST API documentation can be found on docs.gumnut.ai. The full API of this library can be found in api.md.
Installation
# install from PyPI
pip install gumnut-sdk
Usage
The full API of this library can be found in api.md.
import os
from gumnut import Gumnut
client = Gumnut(
api_key=os.environ.get("GUMNUT_API_KEY"), # This is the default and can be omitted
)
user_response = client.users.me()
print(user_response.email)
While you can provide an api_key keyword argument,
we recommend using python-dotenv
to add GUMNUT_API_KEY="My API Key" to your .env file
so that your API Key is not stored in source control.
Async usage
Simply import AsyncGumnut instead of Gumnut and use await with each API call:
import os
import asyncio
from gumnut import AsyncGumnut
client = AsyncGumnut(
api_key=os.environ.get("GUMNUT_API_KEY"), # This is the default and can be omitted
)
async def main() -> None:
user_response = await client.users.me()
print(user_response.email)
asyncio.run(main())
Functionality between the synchronous and asynchronous clients is otherwise identical.
With aiohttp
By default, the async client uses httpx for HTTP requests. However, for improved concurrency performance you may also use aiohttp as the HTTP backend.
You can enable this by installing aiohttp:
# install from PyPI
pip install gumnut-sdk[aiohttp]
Then you can enable it by instantiating the client with http_client=DefaultAioHttpClient():
import os
import asyncio
from gumnut import DefaultAioHttpClient
from gumnut import AsyncGumnut
async def main() -> None:
async with AsyncGumnut(
api_key=os.environ.get("GUMNUT_API_KEY"), # This is the default and can be omitted
http_client=DefaultAioHttpClient(),
) as client:
user_response = await client.users.me()
print(user_response.email)
asyncio.run(main())
Using types
Nested request parameters are TypedDicts. Responses are Pydantic models which also provide helper methods for things like:
- Serializing back into JSON,
model.to_json() - Converting to a dictionary,
model.to_dict()
Typed requests and responses provide autocomplete and documentation within your editor. Install the ty extension for VS Code to see type errors while editing.
Pagination
List methods in the Gumnut API are paginated.
This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
from gumnut import Gumnut
client = Gumnut()
all_assets = []
# Automatically fetches more pages as needed.
for asset in client.assets.list():
# Do something with asset here
all_assets.append(asset)
print(all_assets)
Or, asynchronously:
import asyncio
from gumnut import AsyncGumnut
client = AsyncGumnut()
async def main() -> None:
all_assets = []
# Iterate through items across all pages, issuing requests as needed.
async for asset in client.assets.list():
all_assets.append(asset)
print(all_assets)
asyncio.run(main())
Alternatively, you can use the .has_next_page(), .next_page_info(), or .get_next_page() methods for more granular control working with pages:
first_page = client.assets.list()
if first_page.has_next_page():
print(f"will fetch next page using these details: {first_page.next_page_info()}")
next_page = first_page.get_next_page()
print(f"number of items we just fetched: {len(next_page.data)}")
# With `AsyncGumnut`, `await` the list call and `get_next_page()`.
Or just work directly with the returned data:
first_page = client.assets.list()
for asset in first_page.data:
print(asset.id)
# With `AsyncGumnut`, `await` the list call.
Nested params
Nested parameters are dictionaries, typed using TypedDict, for example:
from gumnut import Gumnut
client = Gumnut()
face_response = client.faces.create(
asset_id="asset_id",
bounding_box={
"h": 1,
"w": 1,
"x": 0,
"y": 0,
},
)
print(face_response.bounding_box)
File uploads
Request parameters that correspond to file uploads can be passed as bytes, or a PathLike instance or a tuple of (filename, contents, media type).
from datetime import datetime
from pathlib import Path
from gumnut import Gumnut
client = Gumnut()
client.assets.create(
asset_data=Path("/path/to/file"),
device_asset_id="IMG_0421",
device_id="teds-iphone",
file_created_at=datetime.fromisoformat("2026-05-04T10:30:00+10:00"),
file_modified_at=datetime.fromisoformat("2026-05-04T10:30:00+10:00"),
)
The async client uses the exact same interface. If you pass a PathLike instance, the file contents will be read asynchronously automatically.
Handling errors
When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of gumnut.APIConnectionError is raised.
When the API returns a non-success status code (that is, 4xx or 5xx
response), a subclass of gumnut.APIStatusError is raised, containing status_code and response properties.
All errors inherit from gumnut.APIError.
import gumnut
from gumnut import Gumnut
client = Gumnut()
try:
client.users.me()
except gumnut.APIConnectionError as e:
print("The server could not be reached")
print(e.__cause__) # an underlying Exception, likely raised within httpx.
except gumnut.RateLimitError as e:
print("A 429 status code was received; we should back off a bit.")
except gumnut.APIStatusError as e:
print("Another non-200-range status code was received")
print(e.status_code)
print(e.response)
Error codes are as follows:
| Status Code | Error Type |
|---|---|
| 400 | BadRequestError |
| 401 | AuthenticationError |
| 403 | PermissionDeniedError |
| 404 | NotFoundError |
| 422 | UnprocessableEntityError |
| 429 | RateLimitError |
| >=500 | InternalServerError |
| N/A | APIConnectionError |
Retries
Certain errors are automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors are all retried by default.
You can use the max_retries option to configure or disable retry settings:
from gumnut import Gumnut
# Configure the default for all requests:
client = Gumnut(
# default is 2
max_retries=0,
)
# Or, configure per-request:
client.with_options(max_retries=5).users.me()
Timeouts
By default requests time out after 1 minute. You can configure this with a timeout option,
which accepts a float or an httpx.Timeout object:
import httpx
from gumnut import Gumnut
# Configure the default for all requests:
client = Gumnut(
# 20 seconds (default is 1 minute)
timeout=20.0,
)
# More granular control:
client = Gumnut(
timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)
# Override per-request:
client.with_options(timeout=5.0).users.me()
On timeout, an APITimeoutError is thrown.
Note that requests that time out are retried twice by default.
Method defaults
These methods use their own retry and timeout defaults:
client.assets.create()doesn't retry, and times out after 10 minutes or its files' upload time at 125,000 bytes per second, whichever is longer.client.assets.versions.append()doesn't retry, and times out after 10 minutes or its files' upload time at 125,000 bytes per second, whichever is longer.client.assets.versions.replace()doesn't retry, and times out after 10 minutes or its files' upload time at 125,000 bytes per second, whichever is longer.
To override them, set max_retries or timeout on the client, or pass timeout to the method. A client max_retries of 2, the SDK default, keeps the method's default.
Like any httpx timeout, an upload timeout limits each phase of the request, such as waiting for the response, rather than the whole request.
Advanced
Logging
We use the standard library logging module.
You can enable logging by setting the environment variable GUMNUT_LOG to info.
$ export GUMNUT_LOG=info
Or to debug for more verbose logging.
How to tell whether None means null or missing
In an API response, a field may be explicitly null, or missing entirely; in either case, its value is None in this library. You can differentiate the two cases with .model_fields_set:
if response.my_field is None:
if "my_field" not in response.model_fields_set:
print('Got json like {}, without a "my_field" key present at all.')
else:
print('Got json like {"my_field": null}.')
Accessing raw response data (e.g. headers)
The "raw" Response object can be accessed by prefixing .with_raw_response. to any HTTP method call, e.g.,
from gumnut import Gumnut
client = Gumnut()
response = client.users.with_raw_response.me()
print(response.headers.get("X-My-Header"))
user = response.parse() # get the object that `users.me()` would have returned
print(user.id)
These methods return an APIResponse object.
The async client returns an AsyncAPIResponse with the same structure, the only difference being awaitable methods for reading the response content.
.with_streaming_response
The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
To stream the response body, use .with_streaming_response instead, which requires a context manager and only reads the response body once you call .read(), .text(), .json(), .iter_bytes(), .iter_text(), .iter_lines() or .parse(). In the async client, these are async methods.
with client.users.with_streaming_response.me() as response:
print(response.headers.get("X-My-Header"))
for line in response.iter_lines():
print(line)
The context manager is required so that the response will reliably be closed.
Making custom/undocumented requests
This library is typed for convenient access to the documented API.
If you need to access undocumented endpoints, params, or response properties, the library can still be used.
Undocumented endpoints
To make requests to undocumented endpoints, you can make requests using client.get, client.post, and other
http verbs. Options on the client will be respected (such as retries) when making this request.
import httpx
response = client.post(
"/foo",
cast_to=httpx.Response,
body={"my_param": True},
)
print(response.headers.get("x-foo"))
Undocumented request params
If you want to explicitly send an extra param, you can do so with the extra_query, extra_body, and extra_headers request
options.
Undocumented response properties
To access undocumented response properties, you can access the extra fields like response.unknown_prop. You
can also get all the extra fields on the Pydantic model as a dict with
response.model_extra.
Configuring the HTTP client
You can directly override the httpx client to customize it for your use case, including:
- Support for proxies
- Custom transports
- Additional advanced functionality
import httpx
from gumnut import Gumnut, DefaultHttpxClient
client = Gumnut(
# Or use the `GUMNUT_BASE_URL` env var
base_url="http://my.test.server.example.com:8083",
http_client=DefaultHttpxClient(
proxy="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
You can also customize the client on a per-request basis by using with_options():
client.with_options(http_client=DefaultHttpxClient(...))
Managing HTTP resources
By default the library closes underlying HTTP connections whenever the client is garbage collected. You can manually close the client using the .close() method if desired, or with a context manager that closes when exiting.
from gumnut import Gumnut
with Gumnut() as client:
# make requests here
...
# HTTP client is now closed
Versioning
This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes that only affect static types, without breaking runtime behavior.
- Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
- Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.
Determining the installed version
If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.
You can determine the version that is being used at runtime with:
import gumnut
print(gumnut.__version__)
Requirements
Python 3.11 or higher.
Contributing
Metadata
Release files for gumnut-sdk 0.188.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| gumnut_sdk-0.188.0.tar.gz | 368.3 kB | With provenance | Details for gumnut_sdk-0.188.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| gumnut_sdk-0.188.0-py3-none-any.whl | Python 3 | none | any | Details for gumnut_sdk-0.188.0-py3-none-any.whl |
Total release size: 643.7 kB
Release files / gumnut_sdk-0.188.0.tar.gz
| Download URL | gumnut_sdk-0.188.0.tar.gz |
|---|---|
| Size | 368.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
aa707f23c31ee5367b1591c208ff790589a0ecaec5d9eae828431cfc6f19a450
|
|
BLAKE2b-256 checksum How to use checksums |
3538e889fe143ca6c6228b702b4bffc8553dad9c0e39805134d1ef9336d48ad8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.
Transparency logRelease files / gumnut_sdk-0.188.0-py3-none-any.whl
| Download URL | gumnut_sdk-0.188.0-py3-none-any.whl |
|---|---|
| Size | 275.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7f410200482d1fe14340add20a808d254bb6b0f5723536f84b10768f412f9511
|
|
BLAKE2b-256 checksum How to use checksums |
036d92576b054aaf0cea106ba9e59ce3c0459e5b30998dd6d5d7b3eb9e1b6fa4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.
Transparency logSecurity for gumnut-sdk 0.188.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for gumnut_sdk-0.188.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.