Robots Check API
Fetches robots.txt and answers whether a user agent may crawl a URL, showing the group, the winning rule and every rule that competed with it.
Agents read this page asGET /v1/robots-check/schemafree: schema, examples, errors, price
- Endpoint
- POST /v1/robots-check
- Price
- $0.002 per call
- Timeout
- 8 s
- max_timeout_seconds
- 29 (the whole call as the 402 envelope sells it: the timeout, plus payment verification and settlement around it)
- Response cap
- 500 KB (512,000 bytes)
- Family
- Feeds & site structure
When to use it
It needs the network, and the part an agent gets wrong on its own is precedence: RFC 9309 resolves conflicts by longest match, not first match. One fetch answers up to 50 paths.
When not to use it
- The destination needs more than 8 s to answer: the call ends with upstream_timeout (424).
- The destination is on a private or local network: the network guard refuses it with blocked_target (403).
Parameters
One JSON body. The schema is free at GET /v1/robots-check/schema.
| Field | Type | Required | Description |
|---|---|---|---|
| url | string | yes | Absolute http(s) URL to check, up to 2048 characters; robots.txt is fetched from the root of its origin and the verdict is for its path and query. |
| user_agent | string | no | Crawler product token or full User-Agent string, printable ASCII up to 200 characters; the text before the first slash or space picks the group, and the default is *. Default: "*". |
| include_sitemaps | boolean | no | Whether to return the Sitemap URLs listed in robots.txt; false returns null for sitemaps and its counters. Default: true. |
| additional_paths | array | no | Up to 50 more root-relative paths or absolute URLs on the same origin as url, each answered from the same robots.txt fetch in additional_results. |
Limits
| Limit | Value |
|---|---|
| Size cap | 500 KB (512,000 bytes) |
| Timeout | 8 s |
Show the JSON Schema the handler validates against
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"format": "uri",
"description": "Absolute http(s) URL to check, up to 2048 characters; robots.txt is fetched from the root of its origin and the verdict is for its path and query."
},
"user_agent": {
"default": "*",
"description": "Crawler product token or full User-Agent string, printable ASCII up to 200 characters; the text before the first slash or space picks the group, and the default is *.",
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[\\x20-\\x7e]+$"
},
"include_sitemaps": {
"default": true,
"description": "Whether to return the Sitemap URLs listed in robots.txt; false returns null for sitemaps and its counters.",
"type": "boolean"
},
"additional_paths": {
"description": "Up to 50 more root-relative paths or absolute URLs on the same origin as url, each answered from the same robots.txt fetch in additional_results.",
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
}
}
},
"required": [
"url"
],
"additionalProperties": false
}Example
The published example, verbatim: the request and the response it returns.
POST /v1/robots-check
content-type: application/json
payment-signature: <base64 x402 payload>
{
"url": "https://grist.tools/v1/whois",
"user_agent": "GPTBot",
"include_sitemaps": true,
"additional_paths": [
"/docs/whois",
"/v1/whois/schema"
]
}Without the payment-signature header the call answers 402 with the payment requirements, including this endpoint's price and its max_timeout_seconds, so the deadline is known before anything is paid. The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case we cannot state for you is a settlement call that fails without answering: the error message says so when that is what happened.
200 OK
payment-response: <base64 settlement receipt>
{
"url": "https://grist.tools/v1/whois",
"source_url": "https://grist.tools/robots.txt",
"robots_url": "https://grist.tools/robots.txt",
"robots_status": "found",
"robots_http_status": 200,
"user_agent": "GPTBot",
"user_agent_token": "GPTBot",
"allowed": false,
"decision_reason": "rule",
"matched_rule": {
"type": "disallow",
"path": "/v1/",
"line": 10,
"octet_length": 4
},
"matched_group": {
"user_agents": [
"*",
"GPTBot",
"ClaudeBot",
"Google-Extended",
"PerplexityBot",
"Applebot",
"Bytespider"
],
"is_wildcard": false,
"line": 1
},
"competing_rules": [
{
"type": "disallow",
"path": "/v1/",
"line": 10,
"octet_length": 4
},
{
"type": "allow",
"path": "/",
"line": 9,
"octet_length": 1
}
],
"competing_rules_total": 2,
"competing_rules_truncated": false,
"crawl_delay": null,
"sitemaps": [
"https://grist.tools/sitemap.xml"
],
"sitemaps_total": 1,
"sitemaps_truncated": false,
"groups_found": 1,
"rules_parsed": 8,
"unparsed_lines": 0,
"robots_size_bytes": 612,
"robots_truncated": false,
"additional_results": [
{
"path": "/docs/whois",
"allowed": true,
"decision_reason": "rule",
"matched_rule": {
"type": "allow",
"path": "/",
"line": 9,
"octet_length": 1
}
},
{
"path": "/v1/whois/schema",
"allowed": true,
"decision_reason": "rule",
"matched_rule": {
"type": "allow",
"path": "/v1/*/schema",
"line": 11,
"octet_length": 12
}
}
],
"fetched_at": "2026-09-01T12:00:00.000Z",
"checked_at": "2026-09-01T12:00:00.000Z"
}Response fields
| Field | Type | In the example |
|---|---|---|
| url | string | "https://grist.tools/v1/whois" |
| source_url | string | "https://grist.tools/robots.txt" |
| robots_url | string | "https://grist.tools/robots.txt" |
| robots_status | string | "found" |
| robots_http_status | number | 200 |
| user_agent | string | "GPTBot" |
| user_agent_token | string | "GPTBot" |
| allowed | boolean | false |
| decision_reason | string | "rule" |
| matched_rule | object | an object with type, path, line and octet_length |
| matched_group | object | an object with user_agents, is_wildcard and line |
| competing_rules | array | 2 items, each with type, path, line and octet_length |
| competing_rules_total | number | 2 |
| competing_rules_truncated | boolean | false |
| crawl_delay | null | null |
| sitemaps | array | 1 item |
| sitemaps_total | number | 1 |
| sitemaps_truncated | boolean | false |
| groups_found | number | 1 |
| rules_parsed | number | 8 |
| unparsed_lines | number | 0 |
| robots_size_bytes | number | 612 |
| robots_truncated | boolean | false |
| additional_results | array | 2 items, each with path, allowed, decision_reason and matched_rule |
| fetched_at | string | "2026-09-01T12:00:00.000Z" |
| checked_at | string | "2026-09-01T12:00:00.000Z" |
Deterministic: the same input returns the same output. Clock-derived fields, when present, are declared in the response.
Call it from code
The client reads the 402, signs the payment and retries on its own.
// robots-check: $0.002 per call, paid in USD Coin on eip155:8453 via x402
// Install: npm install @x402/fetch@2 @x402/evm@2 viem@2
// Save as client.mjs (ES module, Node 18+), export EVM_PRIVATE_KEY with the paying wallet's key in your shell, then run: node client.mjs
// The wrapper reads the 402 (payment-required), signs and retries with payment-signature.
import { wrapFetchWithPayment, x402Client, decodePaymentResponseHeader } from '@x402/fetch'
import { ExactEvmScheme } from '@x402/evm/exact/client'
import { privateKeyToAccount } from 'viem/accounts'
const account = privateKeyToAccount(process.env.EVM_PRIVATE_KEY)
const client = new x402Client().register('eip155:8453', new ExactEvmScheme(account))
const fetchWithPayment = wrapFetchWithPayment(fetch, client)
const body = {
"url": "https://grist.tools/v1/whois",
"user_agent": "GPTBot",
"include_sitemaps": true,
"additional_paths": [
"/docs/whois",
"/v1/whois/schema"
]
}
const res = await fetchWithPayment('https://grist.tools/v1/robots-check', {
method: 'POST',
headers: { 'content-type': 'application/json' },
body: JSON.stringify(body),
})
console.log(res.status, await res.json())
const settle = res.headers.get('payment-response')
if (settle) console.log(decodePaymentResponseHeader(settle).transaction)# robots-check: $0.002 per call, paid in USD Coin on eip155:8453 via x402
# Install: pip install "x402[requests,evm]>=2.24,<3"
# The session reads the 402 (payment-required), signs and retries with payment-signature.
import os
from eth_account import Account
from x402 import x402ClientSync
from x402.http import decode_payment_response_header
from x402.http.clients.requests import x402_requests
from x402.mechanisms.evm.exact import register_exact_evm_client
from x402.mechanisms.evm.signers import EthAccountSigner
account = Account.from_key(os.environ["EVM_PRIVATE_KEY"])
client = x402ClientSync()
register_exact_evm_client(client, EthAccountSigner(account), networks="eip155:8453")
session = x402_requests(client)
payload = {
"url": "https://grist.tools/v1/whois",
"user_agent": "GPTBot",
"include_sitemaps": True,
"additional_paths": [
"/docs/whois",
"/v1/whois/schema"
]
}
res = session.post("https://grist.tools/v1/robots-check", json=payload)
print(res.status_code, res.json())
settle = res.headers.get("payment-response")
if settle:
print(decode_payment_response_header(settle).transaction)# robots-check: $0.002 per call, paid in USD Coin on eip155:8453 via x402
# 1. Unpaid call: HTTP 402, the requirements in the payment-required header (base64 JSON) and in the body.
curl -i -X POST 'https://grist.tools/v1/robots-check' -H 'content-type: application/json' -d '{"url":"https://grist.tools/v1/whois","user_agent":"GPTBot","include_sitemaps":true,"additional_paths":["/docs/whois","/v1/whois/schema"]}'
# 2. Same call with the signed payment (an EIP-3009 authorization, EIP-712 signed: it cannot be
# typed by hand). x-payment is accepted as the v1 alternative. HTTP 200 carries payment-response.
curl -i -X POST 'https://grist.tools/v1/robots-check' -H 'content-type: application/json' -H 'payment-signature: <base64 x402 payload>' -d '{"url":"https://grist.tools/v1/whois","user_agent":"GPTBot","include_sitemaps":true,"additional_paths":["/docs/whois","/v1/whois/schema"]}'Errors
Every error is typed JSON. Only a successful call is settled.
| Code | HTTP | When |
|---|---|---|
| invalid_input | 400 | The body does not match the schema on this page. Nothing is charged. The body does not match the schema; its fields are url, user_agent, include_sitemaps and additional_paths. |
| blocked_target | 403 | The destination is refused by the network guard: a disallowed address, or, for HTTP requests, a scheme other than http/https, a port other than 80/443, or credentials in the URL. |
| upstream_timeout | 424 | The destination you named did not answer before the declared timeout for this endpoint expired. |
| internal | 500 | Our fault, and in almost every case nothing is charged. The exceptions come after the call has run and the settlement call was made: the message "The work was done but settlement could not be completed", and the messages starting with "Payment settlement returned". There, whether the payment moved is unknown to us as well. The payment moves at most once: its nonce is single-use and settlement is idempotent, so a retry with it is never charged twice. A retry is normally refused with a 402: replay_consumed, an expiry reason, or a reason saying the nonce was already used once the transfer is on-chain. Only if our server restarted before the transfer was final can a retry run the call again. Even then, the payment moves at most once. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain; to call again, sign a new payment. |
| rate_limited | 429 | Too many calls from the same payer, or too many calls towards the same destination domain. Nothing is charged. |
| concurrency_limit, registry_at_capacity, upstream_unavailable | 503 | We could not serve the call right now. Retryable: wait the number of seconds in the retry-after header, then repeat the call. concurrency_limit and registry_at_capacity mean we were at capacity: the call did not run. You can send the same payment again if its validBefore is still far enough away to cover another call. If it is not, the retry gets a 402 authorization_validity_too_short: sign a new payment. upstream_unavailable means our internal service failed or did not answer in time: the call may already have run and the payment may have been settled. A retry with the same payment can get a 402 whose error field says why. authorization_validity_too_short: too little time is left before validBefore to cover another call. This check comes before the replay check, so it does not tell whether the first payment was settled. replay_consumed (the payment was used and may have been settled) or replay_exhausted (too many attempts): sign a new payment. replay_in_flight: the first call is still running, so wait and do not pay again. invalid_exact_evm_nonce_already_used: the transfer is already on-chain, so this payment cannot move again. Sign a new payment. An authorization can be settled only once, since its nonce is single-use. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain. |
| misconfigured | 503 | The service is not configured to serve calls. The call did not run and nothing is charged. It needs a fix on our side, so there is no retry delay to wait for. |
Input that is rejected before the tool runs (malformed JSON, schema mismatch, body over the size limit) is never charged.
Questions
How much does a call to the Robots Check API cost?
$0.002 per call, paid in USD Coin on Base via x402. There is no account and no API key: the price is in the 402 answer, before anything is paid.
What is the timeout of robots-check?
The endpoint itself runs for at most 8 s. max_timeout_seconds in the 402 answer is 29: that covers the whole call, including payment verification and settlement around it.
How large can a response from robots-check be?
The response-size cap is 500 KB (512,000 bytes).
Is the robots-check input schema free to read?
Yes. GET https://grist.tools/v1/robots-check/schema returns the input schema for free, paid endpoints included.
What happens if a call to robots-check fails?
The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case that cannot be stated in advance is a settlement call that fails without answering: the error message says so when that is what happened.
What does robots-check return?
A JSON object with 26 top-level fields: url, source_url, robots_url, robots_status, robots_http_status, user_agent, user_agent_token, allowed, decision_reason, matched_rule, matched_group, competing_rules, competing_rules_total, competing_rules_truncated, crawl_delay, sitemaps, sitemaps_total, sitemaps_truncated, groups_found, rules_parsed, unparsed_lines, robots_size_bytes, robots_truncated, additional_results, fetched_at and checked_at. The example on this page is a real call.