USF Agents — Simplify the Complex, Amplify the Intelligent for Enterprise

Orchestrate multiple agents with ease: register agents, integrate tools, define custom instructions, and leverage multiple models.
Enterprise-grade and production-ready, with full control, deep customization, strong defaults, clear boundaries, and developer-focused APIs.

USF Agents

This is the official documentation for the USF Agents Python SDK.

📖 Docs: Quickstart | Installation | Configuration | Troubleshooting / FAQ

Installation & Requirements

Requirements

• Python 3.9+
• USF API key (set as an environment variable)

Install the SDK

pip install usf-agents

Other package managers:

# uv
uv add usf-agents

# poetry
poetry add usf-agents

# pdm
pdm add usf-agents

Set Your API Key

# macOS/Linux
export USF_API_KEY=YOUR_KEY

# Windows PowerShell
$env:USF_API_KEY="YOUR_KEY"

# Windows CMD
set USF_API_KEY=YOUR_KEY

(Optional) Virtual Environment

python -m venv .venv

# macOS/Linux
source .venv/bin/activate

# Windows PowerShell
.venv\Scripts\Activate.ps1

Verify Installation

pip show usf-agents

Minimal import check:

python - <<'PY'
try:
    import usf_agents
    print("usf_agents import: OK")
except Exception as e:
    print("Import failed:", e)
PY

Quick Sanity Run

Requires your USF_API_KEY to be set.

# sanity.py
import os
import asyncio
import nest_asyncio
from usf_agents import ManagerAgent

nest_asyncio.apply()

async def main():
    mgr = ManagerAgent(
        usf_config={
            "api_key": os.getenv("USF_API_KEY"),
            "model": "usf-mini"
        }
    )
    result = await mgr.run("Say 'hello world'", {"mode": "auto"})
    if result.get("status") == "final":
        print("Final:", result.get("content"))
    else:
        print("Pending tool calls:", result.get("tool_calls"))

if __name__ == "__main__":
    asyncio.run(main())

Run it:

python sanity.py

Documentation

Getting Started

• Quickstart
• Installation
• Configuration
• Troubleshooting / FAQ

Tools

• Overview
• Docstrings
• Decorator
• Explicit Schema
• Type Mapping
• Registry & Batching

Multi-Agent

• Overview
• Execution Modes
• Context Modes
• Manager-driven Delegation
• Skip Planning (No Tools)
• Custom Instruction

Jupyter Notebook Guides

• Email Drafting Assistant
• Customer Support Triage
• Planner-Worker Delegation
• Strict JSON Output
• Currency Converter

FastAPI Apps

• Email Drafting Assistant
• Customer Support Triage
• Planner-Worker Delegation
• Strict JSON Output
• Currency Converter

License

See LICENSE.