Skip to main content

Python SDK for the Superagent Guard service.

Project description

Superagent Guard Python SDK

Python client for sending commands to the Superagent Guard endpoint.

Installation

pip install superagent-ai

Local development with uv

From the repository root, install the package (including test extras) and create a managed virtual environment:

cd guard/python
uv sync --extra tests

This will provision .venv, install the SDK in editable mode, and pull in the testing dependencies. Once synced, run the test suite with:

uv run pytest tests

Quick start

import asyncio
from superagent_guard import create_guard

async def main() -> None:
    guard = create_guard(
        api_base_url="https://example.com/api/guard",
        api_key="sk-...",
    )

    result = await guard(
        "Generate a friendly greeting",
        on_block=lambda reason: print("Guard blocked:", reason),
        on_pass=lambda: print("Guard passed"),
    )

    if result.rejected:
        print("Rejected with:", result.reasoning)
    else:
        print("Approved", result.decision)

    await guard.aclose()

asyncio.run(main())

Options

  • api_base_url – fully qualified URL for your Guard endpoint.
  • api_key – API key provisioned in Superagent.
  • timeout – optional request timeout (defaults to 10 seconds).
  • client – optionally provide your own configured httpx.AsyncClient.

The returned GuardResult includes both the raw analysis payload from the Guard endpoint and the parsed decision for straightforward policy enforcement.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

superagent_ai-0.0.5.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

superagent_ai-0.0.5-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file superagent_ai-0.0.5.tar.gz.

File metadata

  • Download URL: superagent_ai-0.0.5.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for superagent_ai-0.0.5.tar.gz
Algorithm Hash digest
SHA256 486ae9d42369e037a7b393a3a7408472b0d8627da19641e38fd8e72f2d18992a
MD5 efbadee630b06dcfb27523e2cdece118
BLAKE2b-256 b78fe08b1813ddf55b861d10b5d540555cd0715d5ddf3121c5db34a328b283ca

See more details on using hashes here.

File details

Details for the file superagent_ai-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: superagent_ai-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for superagent_ai-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b7cae50c125dfd508d56e140e315578f1e4c15b80f3bb2d9c1b61e8a10d5d482
MD5 e704e9848066b58eabe8dbedaf261c52
BLAKE2b-256 e6d1a9c22a6469aaabeba90fc3f95a4f51a61ac3640cec5ed4ab38f96e2d4b6e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page