AgentPay AI logoDocumentation

Quickstart: Run AgentPay in 2 Minutes

Follow these step-by-step instructions to run the application locally or connect your own PayPal Sandbox keys.

Terminal Commands
# 1. Install dependencies
npm install

# 2. Start the local server
npm run dev

# 3. Open in your browser:
# http://localhost:3000

Live API Keys (Google Gemini & PayPal Sandbox)

100% Free Accounts

AgentPay runs out-of-the-box in Zero-Config mode so judges can evaluate everything immediately. If you want to connect live AI and PayPal network calls:

1. Google Gemini AI (Free)
  1. Visit Google AI Studio.
  2. Click "Create API Key" (free, no credit card required).
  3. Provides 15 RPM for live neural shopping reasoning.
2. PayPal Sandbox (Free)
  1. Visit developer.paypal.com.
  2. Click Dashboard → Apps & Credentials.
  3. Copy your Sandbox Client ID & Secret.
# Optional: In project root .env.local
GEMINI_API_KEY=your_gemini_key_here
PAYPAL_CLIENT_ID=your_sandbox_client_id_here
PAYPAL_CLIENT_SECRET=your_sandbox_client_secret_here

💡 No file editing required: You can also paste these keys directly inside the Dashboard by clicking "API Keys" in the top navigation bar!

Automated Tests (43 Unit • 7 Live Edge • 6 E2E)

Run npm test for all 43 Vitest checks, npm run test:edge for live Gemini/PayPal/Channel3/Elastic/Neon probes, and npm run test:e2e for Playwright Chrome verification.