Python SDK for AI Agent Safety Filter - validate AI agent actions against policies
Project description
AI Firewall Python SDK
Validate AI agent actions against policies before execution.
Installation
pip install ai-firewall
Or install from source:
cd sdk/python
pip install -e .
Quick Start
from ai_firewall import AIFirewall
# Initialize the client
fw = AIFirewall(
api_key="af_your_api_key",
project_id="your-project-id",
base_url="http://localhost:8000" # Your firewall server URL
)
# Validate an action before executing
result = fw.execute(
agent_name="invoice_agent",
action_type="pay_invoice",
params={
"vendor": "VendorA",
"amount": 5000,
"currency": "USD"
}
)
if result.allowed:
# Safe to proceed with the action
pay_invoice(result.action_id)
else:
# Action was blocked
print(f"Blocked: {result.reason}")
log_blocked_action(result.action_id, result.reason)
Strict Mode
Use strict mode to automatically raise an exception when actions are blocked:
fw = AIFirewall(
api_key="af_xxx",
project_id="my-project",
strict=True # Raises ActionBlockedError when blocked
)
try:
result = fw.execute("agent", "risky_action", {"amount": 1000000})
# This only runs if action is allowed
do_risky_action()
except ActionBlockedError as e:
print(f"Action {e.action_id} was blocked: {e.reason}")
Policy Management
# Get current policy
policy = fw.get_policy()
print(f"Policy version: {policy.version}")
print(f"Rules: {policy.rules}")
# Update policy
new_policy = fw.update_policy(
rules=[
{
"action_type": "pay_invoice",
"constraints": {
"params.amount": {"max": 10000}
}
}
],
version="2.0"
)
Audit Logs
# Get recent logs
logs = fw.get_logs(page=1, page_size=50)
for entry in logs.items:
status = "✓" if entry.allowed else "✗"
print(f"{status} {entry.agent_name}: {entry.action_type}")
# Filter blocked actions
blocked = fw.get_logs(allowed=False)
# Get statistics
stats = fw.get_stats()
print(f"Block rate: {stats['block_rate']}%")
Context Manager
with AIFirewall(api_key="...", project_id="...") as fw:
result = fw.execute("agent", "action", {})
# Connection automatically closed
Exceptions
from ai_firewall import (
AIFirewallError, # Base exception
AuthenticationError, # Invalid API key
ProjectNotFoundError, # Project doesn't exist
PolicyNotFoundError, # No active policy
ActionBlockedError, # Action blocked (strict mode)
NetworkError, # Connection failed
)
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ai_firewall-0.1.0.tar.gz
(6.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ai_firewall-0.1.0.tar.gz.
File metadata
- Download URL: ai_firewall-0.1.0.tar.gz
- Upload date:
- Size: 6.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c2cc31417fef4d556e4edab2ea648bd756c56934a588a66f57e31ab8410a813
|
|
| MD5 |
e7e4ae148906f641c076bd1b86025cd1
|
|
| BLAKE2b-256 |
73cd0a1619728f74318ed270ff7e7ca9467a1c933962ddc4a424bdca634952a3
|
File details
Details for the file ai_firewall-0.1.0-py3-none-any.whl.
File metadata
- Download URL: ai_firewall-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9c44ff67154884e05b2cb351a80b1eb304ecdae261a00dd369329080167e1039
|
|
| MD5 |
4b7cb8dd55874510eb91c302f8364e69
|
|
| BLAKE2b-256 |
a506ad83aa9c99489f40fa4cea1952a0794e3e9c36e20ac6f64e36a0740bddda
|