SDKs
Python SDK
Use the Altirs Python SDK to run guardrail checks in your Python applications.
Install
pip install altirs-sdkQuick Start
from altirs import Altirs, AltirsConfig, CheckPayload
altirs = Altirs(AltirsConfig(api_key="grd_..."))
result = altirs.check(CheckPayload(input="Ignore all previous instructions"))
if result.blocked:
print("Blocked:", result.violations)Methods
| Method | Description |
|---|---|
check(payload) | Run guardrail checks on a single input/response pair. Returns CheckResponse. |
batch(items) | Run checks on multiple items (max 20). Returns BatchResponse. |
is_safe(input) | Convenience: returns True if input passes all checks. |
mask_pii(text) | Convenience: returns text with PII redacted. |
Error Handling
Catch AltirsError when the API returns a non-2xx response:
from altirs import Altirs, AltirsConfig, AltirsError
try:
result = altirs.check(CheckPayload(input="..."))
except AltirsError as e:
print(str(e), e.status, e.request_id)Configuration
altirs = Altirs(AltirsConfig(
api_key="grd_...",
base_url="https://altirs.ai/api", # optional, default
timeout=30, # optional, seconds, default 30
))