Python Guide Applications

Interactive CLI tools that walk you through real Agents API flows using your own token against the demo environment.

Setup

cd guides/python
pip install -r requirements.txt

Set your API token:

export AGENTS_API_TOKEN="your-token-here"

Available Guides

Payments Client

Walk through payment flows interactively: browse intermediated payments, create payment experiences, or claim payments.

python payments_client.py

Insurance Client

Walk through the full insurance purchase flow: choose a type, get quotes, compare offers, apply, and get a payment link.

python insurance_client.py

HATEOAS Navigator (Library)

A reusable HATEOASClient class used by both guides. You can also use it in your own scripts:

from hateoas_navigator import HATEOASClient

client = HATEOASClient(
    base_url="https://api-platform.demo.flywire.com/agents/v2/",
    token="your-token"
)

root = client.discover()
types = client.follow(root, "insurance-types")

The full sources for these guides ship with the documentation site itself under guides/python/. Code blocks throughout the flow pages (Payments, Insurance — OSHC, Policy management) mirror the same patterns the guides use.