Python SDK Reference

pip install webagents

from webagents import BaseAgent, tool

agent = BaseAgent(
    name="my-agent",
    instructions="You are a helpful assistant.",
    model="gpt-4o",
    skills={"my_skill": MySkill()},
)

from webagents import Skill, tool, hook

class WeatherSkill(Skill):
    @tool(description="Get weather for a city")
    async def get_weather(self, city: str) -> str:
        return f"Weather in {city}: sunny"

    @hook("before_run")
    async def on_before_run(self, data):
        pass

@tool(name=None, description=None, scope="all", provides=None)
def my_tool(query: str) -> str:
    ...

@prompt(priority=50, scope="all")
def system_context() -> str:
    return "Additional context..."

@hook("before_run", priority=50, scope="all")
async def on_before_run(data):
    ...

@handoff(name=None, prompt=None, scope="all", subscribes=None, produces=None)
async def delegate_to_specialist(context, query: str):
    ...

@command("/search", description="Search the knowledge base")
async def search(query: str) -> str:
    ...

@http("/webhook", method="post", scope="all")
async def handle_webhook(request):
    ...

@websocket("/stream", scope="all")
async def handle_stream(ws):
    ...

@widget(name="chart", description="Render a chart", template="<div>{{ data }}</div>")
def render_chart(data: dict) -> dict:
    return {"data": data}

@observe(subscribes=["tool_call", "response"])
async def log_events(event):
    ...

from webagents.server.core.app import WebAgentsServer, create_server

server = create_server(
    title="My Agents",
    agents=[agent],
    enable_cors=True,
    url_prefix="/api",
)
server.run(port=8080)

from webagents.server.context.context_vars import Context

ctx = self.get_context()
ctx.session  # SessionState
ctx.auth     # AuthInfo
ctx.payment  # PaymentInfo

from webagents import AgentLoader

loader = AgentLoader()
agents = loader.load_directory("./agents")

from webagents import SessionManager, LocalState

manager = SessionManager()
state = manager.get_or_create("session-123")