albus-sdk 0.1.0

Official Python SDK for the Albus API.

albus-sdk

Official, type-safe Python SDK for the Albus API.

Quickstart

Install the SDK from PyPI:

pip install albus-sdk

Session operations use an organization API key:

import os

from albus_sdk import Albus, models


with Albus(
    security=models.Security(
        api_key_auth=os.environ["ALBUS_API_KEY_AUTH"],
    ),
) as albus:
    response = albus.sessions.list_sessions()
    print(response.sessions)

User and token operations use a user bearer token. Every synchronous operation also has an asynchronous method with an _async suffix:

import asyncio
import os

from albus_sdk import Albus, models


async def main() -> None:
    async with Albus(
        security=models.Security(
            bearer_auth=os.environ["ALBUS_BEARER_AUTH"],
        ),
    ) as albus:
        response = await albus.auth.whoami_async()
        print(response)


asyncio.run(main())

Secret operations accept either credential. The SDK also reads ALBUS_API_KEY_AUTH and ALBUS_BEARER_AUTH directly from the environment, so Albus() is sufficient when the appropriate variable is set. Production requests use https://albus.sh/api by default.

Summary

Albus API: Albus service REST API

Table of Contents

• albus-sdk
  • Quickstart
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Regeneration
  • Checks
  • Releases
  • Maturity
  • Contributions

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

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 albus-sdk

PIP

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

pip install albus-sdk

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 albus-sdk

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 albus-sdk 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 = [
#     "albus-sdk",
# ]
# ///

from albus_sdk import Albus

sdk = Albus(
  # 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
from albus_sdk import Albus, models
import os


with Albus(
    security=models.Security(
        bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
    ),
) as albus:

    res = albus.secrets.list_secrets()

    # Handle response
    print(res)

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

# Asynchronous Example
from albus_sdk import Albus, models
import asyncio
import os

async def main():

    async with Albus(
        security=models.Security(
            bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
        ),
    ) as albus:

        res = await albus.secrets.list_secrets_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
bearer_auth	http	HTTP Bearer	ALBUS_BEARER_AUTH
api_key_auth	http	HTTP Bearer	ALBUS_API_KEY_AUTH

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:

from albus_sdk import Albus, models
import os


with Albus(
    security=models.Security(
        bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
    ),
) as albus:

    res = albus.secrets.list_secrets()

    # Handle response
    print(res)

Available Resources and Operations

Available methods

Auth

• whoami - Get current user information

Health

• health - Health check endpoint

Secrets

• list_secrets - List all secrets
• create_secret - Create a secret
• get_secret - Get a secret by name
• update_secret - Update a secret by name
• delete_secret - Delete a secret by name

Sessions

• list_sessions - List all sessions
• get_session - Get a session with its messages
• run_session - Run or resume a session
• delete_session - Delete a session
• get_session_audit - List a session's audit log

Tokens

• list_tokens - List all API tokens. Never returns token values, only metadata.
• create_token - Create an API token. The token value is returned only in this response.
• get_token - Get token metadata by ID. Never returns the token value.
• delete_token - Revoke an API token by ID

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:

from albus_sdk import Albus, models
from albus_sdk.utils import BackoffStrategy, RetryConfig
import os


with Albus(
    security=models.Security(
        bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
    ),
) as albus:

    res = albus.secrets.list_secrets(
        retries=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:

from albus_sdk import Albus, models
from albus_sdk.utils import BackoffStrategy, RetryConfig
import os


with Albus(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=models.Security(
        bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
    ),
) as albus:

    res = albus.secrets.list_secrets()

    # Handle response
    print(res)

Error Handling

AlbusError 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

from albus_sdk import Albus, errors, models
import os


with Albus(
    security=models.Security(
        bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
    ),
) as albus:
    res = None
    try:

        res = albus.secrets.list_secrets()

        # Handle response
        print(res)


    except errors.AlbusError 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.ErrUnauthorized):
            print(e.data.message)  # str

Error Classes

Primary errors:

• AlbusError: The base class for HTTP error responses.
  • ErrUnauthorized: Status code 401. *

Less common errors (12)

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 AlbusError:

• ErrNotFound: Not found. Status code 404. Applicable to 8 of 16 methods.*
• ErrBadRequest: Status code 400. Applicable to 5 of 16 methods.*
• ErrConflict: Idempotency key reused with a different request body. Status code 409. Applicable to 1 of 16 methods.*
• ErrLocked: Another invocation is currently running for this session. Status code 423. Applicable to 1 of 16 methods.*
• ErrRunFailed: The harness run failed instead of producing a response (only possible with wait=true, or when replaying a failed invocation). The body carries the failure kind and detail. Status code 502. Applicable to 1 of 16 methods.*
• HealthResponseError: Service is healthy. Status code 503. Applicable to 1 of 16 methods.*
• ErrTimeout: Timed out waiting for the assistant response. Status code 504. Applicable to 1 of 16 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

Select Server by Index

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	Description
0	https://albus.sh/api	Production server
1	http://localhost:8080	Local development server

Example

from albus_sdk import Albus, models
import os


with Albus(
    server_idx=0,
    security=models.Security(
        bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
    ),
) as albus:

    res = albus.secrets.list_secrets()

    # Handle response
    print(res)

Override Server URL Per-Client

The 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:

from albus_sdk import Albus, models
import os


with Albus(
    server_url="http://localhost:8080",
    security=models.Security(
        bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
    ),
) as albus:

    res = albus.secrets.list_secrets()

    # 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 albus_sdk import Albus
import httpx

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

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

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

Resource Management

The Albus 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.

from albus_sdk import Albus, models
import os
def main():

    with Albus(
        security=models.Security(
            bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
        ),
    ) as albus:
        # Rest of application here...


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

    async with Albus(
        security=models.Security(
            bearer_auth=os.getenv("ALBUS_BEARER_AUTH", ""),
        ),
    ) as albus:
        # 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 albus_sdk import Albus
import logging

logging.basicConfig(level=logging.DEBUG)
s = Albus(debug_logger=logging.getLogger("albus_sdk"))

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

Development

Regeneration

Regeneration requires uv, Speakeasy authentication, and the Speakeasy CLI version pinned in .speakeasy/workflow.yaml.

Run the generator with the authoritative private OpenAPI specification and the SDK version to produce:

./tools/generate /path/to/albus/api/openapi.yaml 0.1.0

The command copies the exact specification snapshot into this repository, generates the SDK without uploading the specification, normalizes known generator metadata, and runs the complete local check. Review and commit the specification, generated code, documentation, and lock files together.

Checks

Install uv and the pinned Speakeasy CLI, then run the complete local check:

./tools/check

This lints the OpenAPI snapshot, checks the generated package with MyPy and Pyright, runs the handwritten tests, builds both package formats, validates their metadata, and installs the wheel on Python 3.10 and 3.14.

Releases

Publishing is manual during the MVP. Follow RELEASING.md to validate and publish a generated version with the guarded local script.

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