shadeform

Python SDK for the Shadeform API: one API for finding, launching and managing GPU instances across clouds. Typed with Pydantic, sync and async, Python 3.10+.

Quick start

pip install shadeform
export SHADEFORM_API_KEY=...   # Settings > API Keys in the Shadeform console

The quickest way to get a key onto a machine is the Shadeform CLI: shade auth login signs you in through the browser and stores a key in the OS keychain (see the CLI docs). The SDK reads SHADEFORM_API_KEY from the environment, or takes security=models.Security(api_key="...") explicitly.

from shadeform import Shadeform

with Shadeform() as sf:
    # Cheapest available H100 across every cloud
    types = sf.instances.list_types(gpu_type="H100", available="true", sort="price")
    t = types.instance_types[0]
    print(t.cloud, t.shade_instance_type, t.hourly_price, "cents/hr")

    region = next(a.region for a in t.availability if a.available)
    created = sf.instances.create(
        cloud=t.cloud,
        region=region,
        shade_instance_type=t.shade_instance_type,
        name="hello-gpu",
    )
    print("created", created.id)

    info = sf.instances.get(instance_id=created.id)
    print(info.status, info.ip, info.ssh_user)

One call per resource

from pathlib import Path
from shadeform import Shadeform

with Shadeform() as sf:
    # Instances
    for i in sf.instances.list().instances:
        print(i.id, i.name, i.cloud, i.region, i.status, i.hourly_price)

    # SSH keys
    pub = Path("~/.ssh/id_ed25519.pub").expanduser().read_text()
    sf.ssh_keys.add(name="laptop", public_key=pub)
    print([k.name for k in sf.ssh_keys.list().ssh_keys])

    # Templates (saved launch configurations)
    print([t.name for t in sf.templates.list_featured().templates])

    # Volumes
    print([v.display_name for v in sf.volumes.list_types().volume_types])
    sf.volumes.create(cloud="hyperstack", region="canada-1", name="training-data", size_in_gb=100)

Every method has an _async twin (await sf.instances.list_async()); see Available Resources and Operations for the full list and docs/sdks for per-method examples.

Other interfaces

• shade CLI: the same API from the terminal; shade auth login to sign in.
• Hosted MCP server: https://mcp.shadeform.ai for Claude, Cursor and other MCP clients.
• REST API reference.

This package is generated from the public OpenAPI document with Speakeasy; the sections below are maintained by the generator.

Summary

Shadeform API: Shadeform is a single API and platform for deploying and managing cloud GPUs.

Table of Contents

• shadeform
  • Quick start
  • Other interfaces
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add shadeform

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install shadeform

Poetry

Poetry 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 shadeform

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from shadeform python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "shadeform",
# ]
# ///

from shadeform import Shadeform

sdk = Shadeform(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, 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.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
import os
from shadeform import Shadeform, models


with Shadeform(
    security=models.Security(
        api_key=os.getenv("SHADEFORM_API_KEY", ""),
    ),
) as s_client:

    res = s_client.instances.list()

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
import os
from shadeform import Shadeform, models

async def main():

    async with Shadeform(
        security=models.Security(
            api_key=os.getenv("SHADEFORM_API_KEY", ""),
        ),
    ) as s_client:

        res = await s_client.instances.list_async()

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name	Type	Scheme	Environment Variable
api_key	apiKey	API key	SHADEFORM_API_KEY
oauth2	oauth2	OAuth2 token	SHADEFORM_OAUTH2

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import os
from shadeform import Shadeform, models


with Shadeform(
    security=models.Security(
        api_key=os.getenv("SHADEFORM_API_KEY", ""),
    ),
) as s_client:

    res = s_client.instances.list()

    # Handle response
    print(res)

Available Resources and Operations

Available methods

Instances

• list - List instances
• create - Create an instance
• list_types - List instance types
• delete - Delete an instance
• get - Get an instance
• restart - Restart an instance
• update - Update an instance
• update_model - Update an instance's model configuration

SshKeys

• list - List SSH keys
• add - Add an SSH key
• delete - Delete an SSH key
• get - Get an SSH key
• set_default - Set the default SSH key

Templates

• list - List templates
• list_featured - List featured templates
• save - Save a template
• delete - Delete a template
• get - Get a template
• update - Update a template

Volumes

• list - List volumes
• create - Create a volume
• list_types - List volume types
• delete - Delete a volume
• get - Get a volume

Retries

Some 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 shadeform import Shadeform, models
from shadeform.utils import BackoffStrategy, RetryConfig


with Shadeform(
    security=models.Security(
        api_key=os.getenv("SHADEFORM_API_KEY", ""),
    ),
) as s_client:

    res = s_client.instances.list(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If 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 shadeform import Shadeform, models
from shadeform.utils import BackoffStrategy, RetryConfig


with Shadeform(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=models.Security(
        api_key=os.getenv("SHADEFORM_API_KEY", ""),
    ),
) as s_client:

    res = s_client.instances.list()

    # Handle response
    print(res)

Error Handling

ShadeformError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
err.message	str	Error message
err.status_code	int	HTTP response status code eg 404
err.headers	httpx.Headers	HTTP response headers
err.body	str	HTTP body. Can be empty string if no body is returned.
err.raw_response	httpx.Response	Raw HTTP response
err.data		Optional. Some errors may contain structured data. See Error Classes.

Example

import os
from shadeform import Shadeform, errors, models


with Shadeform(
    security=models.Security(
        api_key=os.getenv("SHADEFORM_API_KEY", ""),
    ),
) as s_client:
    res = None
    try:

        res = s_client.instances.list()

        # Handle response
        print(res)


    except errors.ShadeformError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.HTTPError):
            print(e.data.detail)  # Optional[str]
            print(e.data.errors)  # OptionalNullable[List[models.ErrorItem]]
            print(e.data.instance)  # Optional[str]
            print(e.data.status)  # Optional[int]
            print(e.data.title)  # Optional[str]

Error Classes

Primary errors:

• ShadeformError: The base class for HTTP error responses.
  • HTTPError: HTTPError schema.

Less common errors (6)

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from ShadeformError:

• DefaultErrorResponse: DefaultErrorResponse schema. Status code 409. Applicable to 9 of 24 methods.*
• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can 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 shadeform import Shadeform, models


with Shadeform(
    server_url="https://api.shadeform.ai",
    security=models.Security(
        api_key=os.getenv("SHADEFORM_API_KEY", ""),
    ),
) as s_client:

    res = s_client.instances.list()

    # Handle response
    print(res)

Custom HTTP Client

The 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 shadeform import Shadeform
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Shadeform(client=http_client)

or you could wrap the client with your own custom logic:

from shadeform import Shadeform
from shadeform.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 = Shadeform(async_client=CustomClient(httpx.AsyncClient()))

httpx2 (Pydantic's httpx fork)

httpx2 is Pydantic's maintained fork of httpx. To run this SDK on httpx2, call alias_httpx() at your program's entry point, before importing the SDK, so every import httpx — including the ones inside the SDK — resolves to httpx2:

import httpx2

httpx2.alias_httpx()

from shadeform import Shadeform

s = Shadeform()

An SDK can also be generated against httpx2 directly, so it depends on the fork instead of httpx, by setting python.httpClientLibrary: httpx2 in gen.yaml.

Resource Management

The Shadeform class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

import os
from shadeform import Shadeform, models
def main():

    with Shadeform(
        security=models.Security(
            api_key=os.getenv("SHADEFORM_API_KEY", ""),
        ),
    ) as s_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Shadeform(
        security=models.Security(
            api_key=os.getenv("SHADEFORM_API_KEY", ""),
        ),
    ) as s_client:
        # Rest of application here...

Debugging

You 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 shadeform import Shadeform
import logging

logging.basicConfig(level=logging.DEBUG)
s = Shadeform(debug_logger=logging.getLogger("shadeform"))

You can also enable a default debug logger by setting an environment variable SHADEFORM_DEBUG to true.

Development

Maturity

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.

Contributions

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.

SDK Created by Speakeasy