Readiness Report

{
  "api": {
    "openapi": "3.1.0",
    "title": "Orders API",
    "version": "1.0.0"
  },
  "findings": [
    {
      "message": "no description",
      "rule": "descriptions",
      "where": "GET /orders"
    }
  ],
  "findingsTotal": 31,
  "operations": 5,
  "payment": {
    "network": "eip155:8453",
    "transaction": "0x…"
  },
  "report": "agent-readiness-report",
  "rules": [
    {
      "applicable": 5,
      "fix": "…",
      "id": "descriptions",
      "passing": 0,
      "title": "Descriptions say what the operation does, when to use it, and what it returns",
      "weight": 10
    }
  ],
  "score": 54,
  "source": "https://api.example.com/openapi.json",
  "suggestions": [
    {
      "description": "Lists orders, filtered and paged with status, limit, cursor. …",
      "fields": [
        "description"
      ],
      "operation": "GET /orders",
      "tool": "listOrders"
    }
  ],
  "verdict": "Agents will struggle with this API as it is."
}

# bash or zsh: see the payment challenge. Nothing is charged.
curl -sS -g -i -X POST 'https://latitude10.tech/api/readiness/report' \
  -H 'content-type: application/json' \
  --data-raw '{"url":"https://api.example.com/openapi.json"}'

# x402 v2 sends the challenge base64-encoded in the PAYMENT-REQUIRED header (v1 sends it in the body).
# To read the header:
curl -sS -g -o /dev/null -D - -X POST 'https://latitude10.tech/api/readiness/report' \
  -H 'content-type: application/json' \
  --data-raw '{"url":"https://api.example.com/openapi.json"}' \
  | grep -i '^payment-required:' | cut -d' ' -f2 | tr -d '\r' | base64 --decode

// npm i @x402/fetch @x402/evm viem
import { wrapFetchWithPayment, x402Client } from "@x402/fetch";
import { registerExactEvmScheme } from "@x402/evm/exact/client";
import { privateKeyToAccount } from "viem/accounts";

// Pays at most $0.1 per call.
const client = new x402Client().setSpendControls({ maxAmountPerPayment: "$0.1" });
registerExactEvmScheme(client, { signer: privateKeyToAccount(process.env.EVM_PRIVATE_KEY) });
const pay = wrapFetchWithPayment(fetch, client);

// Not sure it's safe to pay? ToolVet checks it first for $0.005. Pay for that from a separate
// client: this one is capped at $0.1 per payment. GET https://toolvet.app/api/v1/check?url=https%3A%2F%2Flatitude10.tech%2Fapi%2Freadiness%2Freport&method=POST
const res = await pay("https://latitude10.tech/api/readiness/report", {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    "url": "https://api.example.com/openapi.json"
  }),
});
console.log(res.status, await res.text());

# pip install "x402[requests,evm]"
import os
from eth_account import Account
from x402 import x402ClientSync
from x402.http.clients import x402_requests
from x402.mechanisms.evm import EthAccountSigner
from x402.mechanisms.evm.exact.register import register_exact_evm_client

# Pays at most $0.1 per call.
client = x402ClientSync().set_spend_controls({"max_amount_per_payment": "$0.1"})
register_exact_evm_client(client, EthAccountSigner(Account.from_key(os.environ["EVM_PRIVATE_KEY"])))

with x402_requests(client) as session:
    res = session.post(
        "https://latitude10.tech/api/readiness/report",
        json={
            "url": "https://api.example.com/openapi.json",
        },
    )
    print(res.status_code, res.text)