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_ai 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.7.tar.gz (5.1 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.7-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: superagent_ai-0.0.7.tar.gz
  • Upload date:
  • Size: 5.1 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.7.tar.gz
Algorithm Hash digest
SHA256 4e7c7d048a4d361ada0a1869d35a3ab9b7d9eb2b825fdafb949b3cd9ad2e33f9
MD5 37f26ca5f9c82cec752c756b4d6f83cf
BLAKE2b-256 499f62dd1f35c5c535172b54703a5ea23141fb81fa996908164fd9a0c8d322f1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: superagent_ai-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 4.9 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1da8f1e00553ee9957364ebe97ca6e8e4c21c960be5c94a0c32cd8fe3609e687
MD5 672e46f6f51f24a7b6caa5a4e60f095e
BLAKE2b-256 bfb99dc79499b43a1fc9dd7eed5840a649cfa3c86ea141b8d3cd4277cea8ce76

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