ToolVet
80trust / 100

Openapi Required Params

by OpenAPI required-params in Documents & files

x402 APIPassing, checked 4 h ago

For one operation, return the minimum set of inputs an agent must provide to make a successful call. Locate the op by `operationId` (preferred) or by `method`+`path`. Output is a single flat array tagged by `in`: `path` (always required), `query` / `header` / `cookie` (only when `required: true`), and `body.field` entries naming the top-level required fields of a required JSON request body.

POST
https://agent402.tools/api/openapi-required-params
Price
$0.002
per call in USDC
Uptime
100%
last 30 days
Response time
272 ms
544 ms slowest 5%
Last check
Passed
4 h ago, next any minute now

Run a free test callHow to call it

Reliability

All checks passedSome failedAll failedNot checked

Status and outage history · Atom feed · Watch with other listings

How to call it

POST https://agent402.tools/api/openapi-required-params

Each call costs $0.002 in USDC on Base, paid with the request over x402.

Run a free test callOne unpaid request, the way an agent sends it. You see the payment challenge it gets back. Nothing is charged.

Example request

From the listing.

POST https://agent402.tools/api/openapi-required-params
content-type: application/json

{
  "operationId": "createUser",
  "spec": {
    "openapi": "3.0.0",
    "paths": {
      "/users": {
        "post": {
          "operationId": "createUser",
          "requestBody": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "email": {
                      "type": "string"
                    },
                    "nickname": {
                      "type": "string"
                    },
                    "password": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "email",
                    "password"
                  ],
                  "type": "object"
                }
              }
            },
            "required": true
          },
          "responses": {
            "201": {}
          }
        }
      },
      "/users/{id}": {
        "get": {
          "operationId": "getUser",
          "parameters": [
            {
              "in": "path",
              "name": "id",
              "required": true,
              "schema": {
                "type": "string"
              }
            },
            {
              "in": "query",
              "name": "verbose",
              "required": false,
              "schema": {
                "type": "boolean"
              }
            },
            {
              "in": "header",
              "name": "X-Trace-Id",
              "required": true,
              "schema": {
                "type": "string"
              }
            }
          ],
          "responses": {
            "200": {}
          }
        }
      }
    }
  }
}

Parameters

ParameterTypeRequiredDescription
methodanyNoIf no operationId, HTTP method (e.g. GET)
operationIdanyNoLocate by operationId (preferred)
pathanyNoIf no operationId, exact path (e.g. /users/{id})
specanyYesOpenAPI/Swagger document (object or JSON string)

Example response

The provider's example. We can't check it without paying.

{
  "bodyContentType": "application/json",
  "hasBody": true,
  "method": "POST",
  "operationId": "createUser",
  "path": "/users",
  "required": [
    {
      "in": "body.field",
      "name": "email",
      "type": "string"
    },
    {
      "in": "body.field",
      "name": "password",
      "type": "string"
    }
  ]
}

Call it from code

The curl command shows the payment challenge. The JavaScript and Python versions pay and call, and never pay more than $0.002.

curl: see the payment challenge
# bash or zsh: see the payment challenge. Nothing is charged.
curl -sS -g -i -X POST 'https://agent402.tools/api/openapi-required-params' \
  -H 'content-type: application/json' \
  --data-raw '{"operationId":"createUser","spec":{"openapi":"3.0.0","paths":{"/users":{"post":{"operationId":"createUser","requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"type":"string"},"nickname":{"type":"string"},"password":{"type":"string"}},"required":["email","password"],"type":"object"}}},"required":true},"responses":{"201":{}}}},"/users/{id}":{"get":{"operationId":"getUser","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"verbose","required":false,"schema":{"type":"boolean"}},{"in":"header","name":"X-Trace-Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{}}}}}}}'

# 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://agent402.tools/api/openapi-required-params' \
  -H 'content-type: application/json' \
  --data-raw '{"operationId":"createUser","spec":{"openapi":"3.0.0","paths":{"/users":{"post":{"operationId":"createUser","requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"type":"string"},"nickname":{"type":"string"},"password":{"type":"string"}},"required":["email","password"],"type":"object"}}},"required":true},"responses":{"201":{}}}},"/users/{id}":{"get":{"operationId":"getUser","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"verbose","required":false,"schema":{"type":"boolean"}},{"in":"header","name":"X-Trace-Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{}}}}}}}' \
  | grep -i '^payment-required:' | cut -d' ' -f2 | tr -d '\r' | base64 --decode
JavaScript: pay and call
// 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.002 per call.
const client = new x402Client().setSpendControls({ maxAmountPerPayment: "$0.002" });
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.002 per payment. GET https://toolvet.app/api/v1/check?url=https%3A%2F%2Fagent402.tools%2Fapi%2Fopenapi-required-params&method=POST
const res = await pay("https://agent402.tools/api/openapi-required-params", {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    "operationId": "createUser",
    "spec": {
      "openapi": "3.0.0",
      "paths": {
        "/users": {
          "post": {
            "operationId": "createUser",
            "requestBody": {
              "content": {
                "application/json": {
                  "schema": {
                    "properties": {
                      "email": {
                        "type": "string"
                      },
                      "nickname": {
                        "type": "string"
                      },
                      "password": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "email",
                      "password"
                    ],
                    "type": "object"
                  }
                }
              },
              "required": true
            },
            "responses": {
              "201": {}
            }
          }
        },
        "/users/{id}": {
          "get": {
            "operationId": "getUser",
            "parameters": [
              {
                "in": "path",
                "name": "id",
                "required": true,
                "schema": {
                  "type": "string"
                }
              },
              {
                "in": "query",
                "name": "verbose",
                "required": false,
                "schema": {
                  "type": "boolean"
                }
              },
              {
                "in": "header",
                "name": "X-Trace-Id",
                "required": true,
                "schema": {
                  "type": "string"
                }
              }
            ],
            "responses": {
              "200": {}
            }
          }
        }
      }
    }
  }),
});
console.log(res.status, await res.text());
Python: pay and call
# 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.002 per call.
client = x402ClientSync().set_spend_controls({"max_amount_per_payment": "$0.002"})
register_exact_evm_client(client, EthAccountSigner(Account.from_key(os.environ["EVM_PRIVATE_KEY"])))

with x402_requests(client) as session:
    res = session.post(
        "https://agent402.tools/api/openapi-required-params",
        json={
            "operationId": "createUser",
            "spec": {
                "openapi": "3.0.0",
                "paths": {
                    "/users": {
                        "post": {
                            "operationId": "createUser",
                            "requestBody": {
                                "content": {
                                    "application/json": {
                                        "schema": {
                                            "properties": {
                                                "email": {
                                                    "type": "string",
                                                },
                                                "nickname": {
                                                    "type": "string",
                                                },
                                                "password": {
                                                    "type": "string",
                                                },
                                            },
                                            "required": [
                                                "email",
                                                "password",
                                            ],
                                            "type": "object",
                                        },
                                    },
                                },
                                "required": True,
                            },
                            "responses": {
                                "201": {},
                            },
                        },
                    },
                    "/users/{id}": {
                        "get": {
                            "operationId": "getUser",
                            "parameters": [
                                {
                                    "in": "path",
                                    "name": "id",
                                    "required": True,
                                    "schema": {
                                        "type": "string",
                                    },
                                },
                                {
                                    "in": "query",
                                    "name": "verbose",
                                    "required": False,
                                    "schema": {
                                        "type": "boolean",
                                    },
                                },
                                {
                                    "in": "header",
                                    "name": "X-Trace-Id",
                                    "required": True,
                                    "schema": {
                                        "type": "string",
                                    },
                                },
                            ],
                            "responses": {
                                "200": {},
                            },
                        },
                    },
                },
            },
        },
    )
    print(res.status_code, res.text)

Security scan

No findings

We scan names, descriptions and tool definitions for hidden instructions and other prompt-injection patterns.

Recent checks

WhenResultHTTPTimePrice
4 h agoPassed402282 ms$0.002
8 h agoPassed402373 ms$0.002
13 h agoPassed402272 ms$0.002
18 h agoPassed402271 ms$0.002
22 h agoPassed402544 ms$0.002
Show 10 older checks
26 h agoPassed402200 ms$0.002
30 h agoPassed402593 ms$0.002
34 h agoPassed402273 ms$0.002
38 h agoPassed402201 ms$0.002
42 h agoPassed402321 ms$0.002
46 h agoPassed402197 ms$0.002
2 days agoPassed402252 ms$0.002
2 days agoPassed402328 ms$0.002
2 days agoPassed402338 ms$0.002
3 days agoPassed402332 ms$0.002