Node.js Guide Applications

Interactive CLI tools that walk you through real Agents API flows using your own token against the demo environment. Built with Node.js built-in fetch and readline — no external dependencies. Requires Node 20+ LTS (same as the documentation site).

Setup

cd guides/node
# No dependencies needed — uses built-in fetch and readline

Available Guides

Payments Client

node payments-client.mjs YOUR_API_TOKEN

Walk through payment flows: browse intermediated payments, navigate recipient groups, create payment experiences, and claim payments.

Insurance Client

node insurance-client.mjs YOUR_API_TOKEN

Full insurance purchase flow: choose a type, fill the quote form, compare offers, apply for coverage, and get a payment link.

Form Handling

Both guides dynamically read the form schema returned by the API (inputs property) and prompt for each field interactively. The form filler supports:

• Required fields — marked with *
• Default values — shown in brackets, accepted by pressing Enter
• Type coercion — numbers, booleans, and strings are converted automatically
• oneOf options — displayed as a list; you can type the title or value
• Nested objects — grouped and indented under their parent key
• Arrays — prompted item-by-item until you enter an empty line
• Format hints — date, email, maxLength are shown in the prompt

No form fields are hardcoded — the guides adapt to whatever schema the API returns.

The guide files (payments-client.mjs, insurance-client.mjs) live alongside this documentation under guides/node/. Code blocks throughout the flow pages — Payments, Insurance — OSHC, Policy management — mirror the same patterns the guides use.