Skip to main content

ModusOptions

Bases: TypedDict Constructor options for Modus, AsyncModus, and ModusManagement. Pass these as keyword arguments to the client constructor — you rarely construct this TypedDict yourself. Keys:
  • api_key — Modus API key; falls back to MODUS_API_KEY
  • base_url — API origin without a path suffix (default https://api.getmodus.com)
  • timeout — seconds or httpx.Timeout (default 5s connect / 300s read)
  • max_retries — retries on 429/5xx (default 2)
  • agent_host / organization_id / base_urls — staging/local escape hatches; usually omit
Example:

api_key

base_url

agent_host

organization_id

base_urls

timeout

max_retries