Quickstart

python -m pip install afk-py
export OPENAI_API_KEY="..."

python -m pip install -e . pytest

from afk.agents import Agent
from afk.core import Runner

agent = Agent(
    name="assistant",
    model="gpt-5.5",
    instructions="Answer directly. Keep responses under 120 words.",
)

result = Runner().run_sync(
    agent,
    user_message="What is a mutex?",
)

print(result.final_text)
print(result.state)

from pydantic import BaseModel

from afk.agents import Agent, FailSafeConfig
from afk.core import Runner
from afk.tools import tool


class OrderArgs(BaseModel):
    order_id: str


@tool(
    args_model=OrderArgs,
    name="lookup_order",
    description="Look up a customer order by id.",
)
def lookup_order(args: OrderArgs) -> dict:
    return {
        "order_id": args.order_id,
        "status": "shipped",
        "eta": "Friday",
    }


agent = Agent(
    name="support-agent",
    model="gpt-5.5",
    instructions="Use lookup_order when the user asks about an order.",
    tools=[lookup_order],
    fail_safe=FailSafeConfig(
        max_steps=8,
        max_tool_calls=4,
        max_total_cost_usd=0.10,
    ),
)

result = Runner().run_sync(
    agent,
    user_message="Where is order A123?",
)

print(result.final_text)
print(len(result.tool_executions))