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(
    api_key=os.environ["ALBUS_API_KEY"],
) as albus:
    response = albus.sessions.list_sessions()
    print(response.sessions)

Run or resume a session by ID, and wait for the assistant response:

import os

from albus_sdk import Albus, models


with Albus(
    api_key=os.environ["ALBUS_API_KEY"],
    timeout_ms=130_000,
) as albus:
    response = albus.sessions.run_session(
        id="support-triage-1",
        user_prompt="Summarize the latest ticket.",
        agent_name="support-triage",
        agent=models.AgentConfig(
            model=models.Model(name="gemini-3.6-flash"),
        ),
        wait_timeout_seconds=120,
    )
    message = response.result.message
    if message is None:
        print("the invocation has not answered yet")
    else:
        print(message.content)

message is the single assistant message the invocation produced, and is absent when the invocation has not answered yet; read it later with albus.sessions.get_session, which returns the session's full messages history.

Pass 0 for wait_timeout_seconds to return as soon as the invocation is accepted, and omit it to wait up to 30 minutes for the response. Waiting long-polls, so construct the client with a timeout_ms above the longest wait — it is a client-wide setting, and the underlying HTTP client otherwise gives up after its own 5-second default.

AsyncAlbus exposes the same operations as coroutines:

import asyncio
import os

from albus_sdk import AsyncAlbus, models


async def main() -> None:
    async with AsyncAlbus(
        api_key=os.environ["ALBUS_API_KEY"],
    ) as albus:
        response = await albus.auth.whoami()
        print(response)


asyncio.run(main())

api_key is the only credential. When it is not passed, the SDK reads ALBUS_API_KEY from the environment; when that is unset too, it sends requests as the user signed in with albus login, acting in the organization that session selected. Albus() is therefore sufficient on a machine with either configured. 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

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
import os


with Albus(
    api_key=os.getenv("ALBUS_API_KEY", ""),
) as albus:

    res = albus.secrets.list_secrets()

    # Handle response
    print(res)

An Async SDK client can also be used to make asynchronous requests by importing it and asyncio.

# Asynchronous Example
from albus_sdk import AsyncAlbus
import asyncio
import os

async def main():

    async with AsyncAlbus(
        api_key=os.getenv("ALBUS_API_KEY", ""),
    ) as albus:

        res = await albus.secrets.list_secrets()

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:

# Synchronous Example
from albus_sdk import Albus
import os


with Albus(
    api_key=os.getenv("ALBUS_API_KEY", ""),
) as albus:

    res = albus.secrets.list_secrets()

    # Handle response
    print(res)

An Async SDK client can also be used to make asynchronous requests by importing it and asyncio.

# Asynchronous Example
from albus_sdk import AsyncAlbus
import asyncio
import os

async def main():

    async with AsyncAlbus(
        api_key=os.getenv("ALBUS_API_KEY", ""),
    ) as albus:

        res = await albus.secrets.list_secrets()

        # Handle response
        print(res)

asyncio.run(main())

Available Resources and Operations

Retries

Only run_session supports retries. Configure its default retry policy with retry_config when constructing the SDK, or pass retry_config directly to a single run_session invocation. Omit it to inherit the SDK default; pass None to disable retries for that invocation.

Error Handling

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

Example

# Synchronous Example
from albus_sdk import Albus, errors
import os


with Albus(
    api_key=os.getenv("ALBUS_API_KEY", ""),
) 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

An Async SDK client can also be used to make asynchronous requests by importing it and asyncio.

# Asynchronous Example
from albus_sdk import AsyncAlbus, errors
import asyncio
import os

async def main():

    async with AsyncAlbus(
        api_key=os.getenv("ALBUS_API_KEY", ""),
    ) as albus:
        res = None
        try:

            res = await 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

asyncio.run(main())

Error Classes

Primary errors:

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

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

# Synchronous Example
from albus_sdk import Albus
import os


with Albus(
    server_url="https://albus.sh/api/v1",
    api_key=os.getenv("ALBUS_API_KEY", ""),
) as albus:

    res = albus.secrets.list_secrets()

    # Handle response
    print(res)

An Async SDK client can also be used to make asynchronous requests by importing it and asyncio.

# Asynchronous Example
from albus_sdk import AsyncAlbus
import asyncio
import os

async def main():

    async with AsyncAlbus(
        server_url="https://albus.sh/api/v1",
        api_key=os.getenv("ALBUS_API_KEY", ""),
    ) as albus:

        res = await albus.secrets.list_secrets()

        # Handle response
        print(res)

asyncio.run(main())

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 and AsyncAlbus classes implement the context manager protocol and register finalizer functions to close the underlying HTTPX clients they use under the hood. This will close HTTP connections, release memory and free up other resources held by the SDKs. 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 SDK instances via context managers and reuse them across the application.

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

    with Albus(
        api_key=os.getenv("ALBUS_API_KEY", ""),
    ) as albus:
        # Rest of application here...


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

    async with AsyncAlbus(
        api_key=os.getenv("ALBUS_API_KEY", ""),
    ) 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 SDK version to produce:

./tools/generate 0.1.0

The source is the authoritative api/openapi.yaml in the Albus repository, where this SDK is developed; pass a path as a second argument only to preview against a different specification.

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