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-guard

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.data.classification)

    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 classification 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.1.tar.gz (4.7 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.1-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: superagent_ai-0.0.1.tar.gz
  • Upload date:
  • Size: 4.7 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.1.tar.gz
Algorithm Hash digest
SHA256 25097c3bb08c003ddd2d1bdf48f25c86ccdcc16e377a9fc37747e1e59d649d51
MD5 4b08171aa9ae7e5fffee6d934f5d6448
BLAKE2b-256 002009763e762f8067192de05fd3be376173a92771f61ba27e64bd254cac7aec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: superagent_ai-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.3 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1ff13d00e54fcbebd8951c722abf73d6197e5360b96220c2e7e740c2f82a5384
MD5 afc24f36d96d6309258cf90ad1c3251e
BLAKE2b-256 3ee1c7a440379707364c44da2634f97572b8286d5daffb47698e2aad363ff470

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