Python API Reference

Reference for the public symbols of briefcase-ai v4.4.0. Signatures match the shipped SDK. Each module page lists an install command, the import path, and one small runnable usage.

Looking for the narrative?

This section is the exhaustive signature reference. For a worked walkthrough of the SDK, start with the Python SDK guide.

Install the base package:

pip install briefcase-ai

Optional feature extras install only what they need.

Most extras add no dependencies

Most extras (replay, drift, sanitize, storage, validate, guardrails, rag, correlation, external, events, routing, vcs, bitemporal, compliance) pull in no third-party dependencies and exist to document intent. Only otel, lakefs, bitemporal-iceberg, and mcp install external packages.

Modules

briefcase API reference for briefcase.

briefcase.controls Gateways, ports, quota, retry, and provider fallback.

briefcase.integrity Canonical JSON, hash chains, stores, and signatures.

briefcase.auto Reversible framework auto-instrumentation.

briefcase.storage API reference for briefcase.storage.

briefcase.replay API reference for briefcase.replay.

briefcase.drift API reference for briefcase.drift.

briefcase.cost API reference for briefcase.cost.

briefcase.sanitize API reference for briefcase.sanitize.

briefcase.validation API reference for briefcase.validation.

briefcase.guardrails API reference for briefcase.guardrails.

briefcase.rag API reference for briefcase.rag.

briefcase.correlation API reference for briefcase.correlation.

briefcase.events API reference for briefcase.events.

briefcase.external API reference for briefcase.external.

briefcase.routing API reference for briefcase.routing.

briefcase.bitemporal API reference for briefcase.bitemporal.

briefcase.compliance API reference for briefcase.compliance.

briefcase.otel API reference for briefcase.otel.

briefcase.exporters API reference for briefcase.exporters.

briefcase.mcp API reference for briefcase.mcp.

briefcase.integrations.lakefs API reference for briefcase.integrations.lakefs.

briefcase.integrations.evals API reference for briefcase.integrations.evals.

briefcase.integrations.gym API reference for briefcase.integrations.gym.