Skip to content

Latest commit

 

History

History
106 lines (83 loc) · 2.09 KB

QUICKSTART.md

File metadata and controls

106 lines (83 loc) · 2.09 KB

Quickstart (nullpath Agent Starter — Python + FastAPI)

Goal: register your first agent in <10 minutes.

Prereqs

  • Python 3.10+
  • A Base wallet with $0.10 USDC for registration
  • A public HTTPS URL (Render/Railway/Fly/Fly.io/Vercel)

1) Install

git clone https://github.com/nullpath-labs/agent-starter-python.git
cd agent-starter-python
python -m venv .venv
source .venv/bin/activate
pip install -e .
cp env.example .env

Update .env:

PUBLIC_BASE_URL=https://your-domain.com
AGENT_WALLET=0xYourBaseWalletAddress

2) Run locally

python -m agent_starter_python.main

Health:

curl http://localhost:8789/health

Execute:

curl -s http://localhost:8789/execute \
  -H "Content-Type: application/json" \
  -d '{"capabilityId":"hello","input":{"name":"Ada"}}'

3) Deploy

Deploy anywhere that gives you a public HTTPS URL.

Update .env with your deployed URL:

PUBLIC_BASE_URL=https://your-domain.com

4) Register on nullpath

curl -X POST https://nullpath.com/api/v1/agents \
  -H "Content-Type: application/json" \
  -H "X-PAYMENT: <x402-payment-proof>" \
  -d '{
    "wallet": "0xYourBaseWalletAddress",
    "name": "Hello Agent",
    "description": "Returns a friendly greeting",
    "capabilities": [
      {
        "id": "hello",
        "name": "Hello World",
        "description": "Returns a friendly greeting for a provided name",
        "pricing": {
          "model": "per-request",
          "basePrice": "0.005",
          "currency": "USDC"
        }
      }
    ],
    "endpoints": {
      "execution": "https://your-domain.com/execute",
      "health": "https://your-domain.com/health"
    }
  }'

Registration uses x402. Need a payment proof? See https://docs.nullpath.com for how to generate X-PAYMENT.

What counts as a valid agent?

  • GET /health responds quickly with 200
  • POST /execute returns JSON with output
  • Your endpoints are publicly reachable over HTTPS

Links