SDK Reference

from phronedge import PhronEdge

pe = PhronEdge(
    api_key="pe_live_...",          # or set PHRONEDGE_API_KEY env var
    gateway_url="https://...",       # default: api.phronedge.com/api/v1
    timeout=30,                      # request timeout in seconds
    raise_on_block=False,            # raise GovernanceError on block
)

# Minimal (reads API key from env)
pe = PhronEdge()

# Explicit
pe = PhronEdge(
    api_key="pe_live_4178c0c2db3641efb66c81f9",
    raise_on_block=True,
)

@pe.govern("tool_name")
def my_tool(params):
    return result

{
    "blocked": True,
    "reason": "Agent clearance PUB does not meet PII_HEALTH requirement",
    "checkpoint": "Data Classification",
    "regulation": "GDPR Art. 9 Special Categories",
    "retry": True,
    "message": "Tool call blocked by PhronEdge governance."
}

pe = PhronEdge()

@pe.govern("read_database")
def read_database(query):
    return db.read(query)

@pe.govern("write_database")
def write_database(table, data):
    return db.write(table, data)

@pe.govern("delete_record")
def delete_record(table, record_id):
    return db.delete(table, record_id)

# Each tool is independently governed.
# An agent might be allowed to read but blocked from writing or deleting.

from phronedge import PhronEdge, GovernanceError

pe = PhronEdge(raise_on_block=True)

@pe.govern("sensitive_operation")
def sensitive_operation(data):
    return process(data)

try:
    result = sensitive_operation({"patient_id": "P-123"})
except GovernanceError as e:
    print(e.checkpoint)    # "PII Detector"
    print(e.regulation)    # "GDPR Art. 9"
    print(e.reason)        # "PII detected in input: patient_id"
    print(e.blocked)       # True
    print(e.retry)         # True (can retry with sanitized input)

results = pe.scan("path/to/agent.py")

for vuln in results.vulnerabilities:
    print(f"{vuln.severity}: {vuln.description}")
    print(f"  Fix: {vuln.recommendation}")

status = pe.status("claims-investigator")

print(status.state)          # "active" | "quarantined" | "killed"
print(status.calls_today)    # 1,234
print(status.blocks_today)   # 3
print(status.last_event)     # last governance event details

# Export as OPA Rego
rego = pe.export("rego")
with open("policy.rego", "w") as f:
    f.write(rego)

# Export as YAML
yaml_policy = pe.export("yaml")

# Export as JSON
json_policy = pe.export("json")