Skip to main content

​
Installation

ProofRail ships as a Python package on PyPI. Install the core SDK, then add framework-specific extras for whichever orchestration tools you use.

​
Requirements

  • Python 3.10 or later
  • A ProofRail account and API key — sign up at proofrail.dev

​
Core SDK

pip install proofrail
This installs the framework-agnostic Chain context manager, the policy engine, payload sanitization, and the backend HTTP client. Use this directly if you’re orchestrating agents yourself.

​
Framework adapters

ProofRail ships adapters for the most-used agent frameworks. Install only what you need. 
pip install "proofrail[langgraph]"
Each extra installs the framework itself if not already present, plus any framework-specific helpers ProofRail uses.
Framework version compatibility is documented per adapter. See Framework Integration for the pinned ranges. Supported version ranges are pinned in sdk/pyproject.toml; install with a compatible framework version in your environment.

​
Verify your install

import proofrail
print(proofrail.__version__)
Should print the installed version (e.g., 0.1.0).

​
Get your API key

Sign up at proofrail.dev. After verifying your email, create an API key from the dashboard. Keys are prefixed with prail_ and shown once at creation — store yours in a secrets manager or .env file. 
# .env
PROOFRAIL_API_KEY=prail_your_key_here

​
Initialize the SDK

import os
import proofrail

proofrail.init(api_key=os.environ["PROOFRAIL_API_KEY"])
That’s the minimum. The SDK has many configuration options for tuning behavior — see Configuration Reference for the full surface.

​
What’s next

Quickstart

First governed chain in under 10 minutes.

Configuration

Every init() parameter, explained.