Python SDK

uv add superagent-ai

import asyncio
from superagent_ai import create_client

async def main() -> None:
    client = create_client(
        api_base_url="https://app.superagent.sh/api",  # Optional, this is the default
        api_key="sk-...",
    )

    # Guard: Analyze commands for security threats
    guard_result = await client.guard(
        "Write a hello world script",
        on_block=lambda reason: print("Guard blocked:", reason),
        on_pass=lambda: print("Guard approved!"),
    )

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

    # Redact: Remove sensitive data from text
    redact_result = await client.redact(
        "My email is john@example.com and SSN is 123-45-6789"
    )

    print(redact_result.redacted)
    # Output: "My email is <REDACTED_EMAIL> and SSN is <REDACTED_SSN>"

    # Verify: Check claims against source materials
    verify_result = await client.verify(
        "The company was founded in 2020 and has 500 employees",
        [
            {
                "name": "About Us",
                "content": "Founded in 2020, our company has grown rapidly...",
                "url": "https://example.com/about"
            },
            {
                "name": "Team Page",
                "content": "We currently have over 450 team members...",
                "url": "https://example.com/team"
            }
        ]
    )

    print(verify_result.claims)
    # Output: Array of claim verifications with verdicts, evidence, and reasoning

    await client.aclose()

asyncio.run(main())

import asyncio
from superagent_ai import create_client

async def main() -> None:
    async with create_client(api_key="sk-...") as client:
        result = await client.guard("command")
        redacted = await client.redact("text")

asyncio.run(main())

import asyncio
from superagent_ai import create_client

async def main() -> None:
    async with create_client(api_key="sk-...") as client:
        result = await client.verify(
            "The company was founded in 2020 and has 500 employees.",
            [
                {
                    "name": "About Us",
                    "content": "Founded in 2020, our company has grown rapidly...",
                    "url": "https://example.com/about"
                },
                {
                    "name": "Team Page",
                    "content": "We currently have over 450 team members...",
                    "url": "https://example.com/team"
                }
            ]
        )

        # Iterate through claims to check verdicts
        for claim in result.claims:
            print(f"Claim: {claim['claim']}")
            print(f"Verdict: {'✓ True' if claim['verdict'] else '✗ False'}")
            print(f"Evidence: {claim['evidence']}")
            print(f"Reasoning: {claim['reasoning']}")
            print(f"Sources: {', '.join(s['name'] for s in claim['sources'])}")
            print('---')

asyncio.run(main())

client = create_client(api_key="sk-...")

result = await client.redact(
    "My credit card is 4532-1234-5678-9010 and my email is john@example.com",
    entities=["credit card numbers", "email addresses"]
)
# The model will redact the specified entity types based on your natural language descriptions

client = create_client(api_key="sk-...")

result = await client.redact(
    "Check out https://github.com/user/repo and https://secret.com/data",
    url_whitelist=["https://github.com", "https://example.com"]
)
# Output: "Check out https://github.com/user/repo and <URL_REDACTED>"

import asyncio
from superagent_ai import create_client

async def main() -> None:
    async with create_client(api_key="sk-...") as client:
        # Get redacted PDF file
        with open("sensitive-document.pdf", "rb") as pdf_file:
            result = await client.redact(
                pdf_file,  # Pass file as first parameter
                format="pdf",  # Returns PDF bytes
                entities=["SSN", "credit card numbers", "email addresses"]
            )

        # Save the redacted PDF
        if result.pdf:
            with open("redacted-output.pdf", "wb") as output_file:
                output_file.write(result.pdf)
            print("Redacted PDF saved to redacted-output.pdf")

asyncio.run(main())

import asyncio
from superagent_ai import create_client

async def main() -> None:
    async with create_client(api_key="sk-...") as client:
        # Get redacted text from PDF
        with open("sensitive-document.pdf", "rb") as pdf_file:
            result = await client.redact(
                pdf_file,  # Pass file as first parameter
                format="json",  # Returns JSON with redacted text (default)
                entities=["SSN", "credit card numbers", "email addresses"]
            )

            print(result.redacted)  # Redacted text extracted from the PDF
            print(result.reasoning) # Explanation of what was redacted

asyncio.run(main())

import asyncio
from superagent_ai import create_client

async def main() -> None:
    async with create_client(api_key="sk-...") as client:
        # Analyze PDF file for security threats
        with open("document.pdf", "rb") as pdf_file:
            result = await client.guard(
                pdf_file,  # Pass file as first parameter
                on_block=lambda reason: print("Guard blocked:", reason),
                on_pass=lambda: print("Guard approved!"),
            )

        # Check the analysis result
        if result.rejected:
            print(f"Document contains security threats: {result.reasoning}")
            if result.decision:
                print(f"Violation types: {result.decision.get('violation_types', [])}")
                print(f"CWE codes: {result.decision.get('cwe_codes', [])}")
        else:
            print(f"Document is safe: {result.reasoning}")

asyncio.run(main())

from superagent_ai import GuardError

try:
    result = await client.guard("command")
except GuardError as error:
    print(f"Guard error: {error}")