BoxRouter Python SDK — discovery preview

An early, read-only BoxRouter client for discovering the provider routes available to your workspace. Requires Python 3.11 or later and access to a BoxRouter deployment. This preview supports provider discovery only; sandbox creation and other SDK operations are not included. Its API may change before the full SDK release.

python -m pip install --pre boxrouter

Set BOXROUTER_BASE_URL to your deployment's API base URL and BOXROUTER_API_KEY to your BoxRouter API key. Then:

import os

from boxrouter import AuthenticatedClient
from boxrouter.api.providers import list_providers

with AuthenticatedClient(
    base_url=os.environ["BOXROUTER_BASE_URL"],
    token=os.environ["BOXROUTER_API_KEY"],
    raise_on_unexpected_status=True,
) as client:
    response = list_providers.sync_detailed(client=client)
    if response.status_code != 200 or response.parsed is None:
        raise RuntimeError(f"Provider discovery failed: HTTP {response.status_code}")
    print(response.parsed.to_dict())

The generated endpoint also provides asyncio_detailed for asynchronous clients. Errors are available as the response's HTTP status and raw content; the preview does not include the full SDK's typed error models. Discovery reports current visibility and eligibility; it does not reserve capacity.

Licensed under Apache-2.0. Contact: maintainer@boxrouter.ai.