Modus

import modus

client = modus.Modus(api_key="modus_xxx")
for scope in client.scopes.list():
    print(scope.name)

Write operations use ModusManagement (Management section).

class Modus(api_key: str | None = None, *, base_url: str | None = None, agent_host: str | None = None, organization_id: str | None = None, base_urls: Mapping[str, str] | None = None, timeout: float | Timeout | None = None, max_retries: int | None = None)

Bases: object Synchronous Modus API client. Instantiate once and reuse across your script or application. The client is thread-safe for concurrent GET requests.

Parameters:
- api_key – Your Modus API key. If omitted, reads from the MODUS_API_KEY environment variable.
- base_url – API origin without a path suffix (default https://api.getmodus.com).
- timeout – Request timeout as seconds or httpx.Timeout. Default is 5s connect and 300s read.
- max_retries – Number of automatic retries on 429/5xx (default 2).

close()

close() → None

Close the underlying HTTP connection pool.

AsyncModus

class AsyncModus(api_key: str | None = None, *, base_url: str | None = None, agent_host: str | None = None, organization_id: str | None = None, base_urls: Mapping[str, str] | None = None, timeout: float | Timeout | None = None, max_retries: int | None = None)

Bases: object Asynchronous Modus API client.

Parameters:
- api_key – Your Modus API key. If omitted, reads from MODUS_API_KEY.
- base_url – API origin without a path suffix (default https://api.getmodus.com).
- timeout – Request timeout as seconds or httpx.Timeout. Default is 5s connect and 300s read.
- max_retries – Retries on 429/5xx (default 2).

aclose()

async aclose() → None

Close the underlying async HTTP connection pool.

Types

Errors

Getting Started

API Reference

Modus

Modus

close()

AsyncModus

aclose()

​Modus

​close()

​AsyncModus

​aclose()

Modus

close()

AsyncModus

aclose()