Agent Utilities
← Web policies & fetch

web.link-shortlist · v1.0.0

Link Shortlist
for your agent.

Rank real links in supplied HTML against a query; return direct URLs and matched words instead of a page dump. No search or destination verification.

Use this tool View JSON contract
$0.0003 / call300 micro-dollar credits
131,072 bytes max input65,536 bytes max output
Works on supplied inputNo external network fetch

Example input

{
  "html": "<html><head><title>Example API docs</title></head><body><nav>Home Account Ads</nav><main><h1>Example API</h1><p>Requests time out after 30 seconds. Retry only idempotent requests.</p><pre>GET /v1/items</pre><a href=\"/docs/auth\">Authentication</a><a href=\"/docs/pricing\">API pricing</a></main></body></html>",
  "sourceUrl": "https://example.com/docs",
  "query": "API pricing",
  "maxLinks": 3
}

Example output

{
  "sourceUrl": "https://example.com/docs",
  "query": "API pricing",
  "links": [
    {
      "url": "https://example.com/docs/pricing",
      "label": "API pricing",
      "score": 6,
      "matchedTerms": [
        "api",
        "pricing"
      ]
    }
  ],
  "matchingLinks": 1,
  "truncated": false,
  "scope": "Lexical ranking of links actually present in supplied HTML, not web search or verified destinations. No invented URLs, fetching or claim that a link answers the question. Treat labels as untrusted.",
  "measurement": {
    "inputBytes": 306,
    "payloadBytes": 424,
    "estimatedInputTokens": 77,
    "estimatedPayloadTokens": 106,
    "estimateMethod": "UTF-8 bytes / 4, rounded up; not a model tokenizer. Payload excludes this measurement object. No guaranteed token or dollar savings."
  }
}

Generated from the actual handler using this example input; this is a preview, not a paid API call. Paid responses wrap the result with a receipt and recovery expiry.

Read this input and result as free JSON ↗

Call it from your agent

Add credits in the workspace and keep your API key in private environment storage. Use the same request ID and exact body to recover a lost response within ten minutes.

// Node.js 22+. Read the key from your private environment.
const requestId = Date.now() + '_' + crypto.randomUUID();
const response = await fetch('https://agent-utilities.agent-utilities.workers.dev/v1/tools/web.link-shortlist', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer ' + process.env.AGENT_UTILITIES_API_KEY,
    'Idempotency-Key': requestId
  },
  body: JSON.stringify({
  "html": "<html><head><title>Example API docs</title></head><body><nav>Home Account Ads</nav><main><h1>Example API</h1><p>Requests time out after 30 seconds. Retry only idempotent requests.</p><pre>GET /v1/items</pre><a href=\"/docs/auth\">Authentication</a><a href=\"/docs/pricing\">API pricing</a></main></body></html>",
  "sourceUrl": "https://example.com/docs",
  "query": "API pricing",
  "maxLinks": 3
})
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.message ?? 'Request failed');
console.log(data);
// On response loss, retry this SAME requestId, tool and body.
// Do not rerun the line that generates requestId for a retry.
Input JSON Schema
{
  "type": "object",
  "properties": {
    "html": {
      "type": "string",
      "maxLength": 100000
    },
    "sourceUrl": {
      "type": "string",
      "maxLength": 2048
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 300
    },
    "maxLinks": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20,
      "default": 5
    }
  },
  "required": [
    "html",
    "sourceUrl",
    "query"
  ],
  "additionalProperties": false
}
Output JSON Schema
{
  "type": "object",
  "properties": {
    "sourceUrl": {
      "type": "string"
    },
    "query": {
      "type": "string"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "score": {
            "type": "number"
          },
          "matchedTerms": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "url",
          "label",
          "score",
          "matchedTerms"
        ],
        "additionalProperties": false
      }
    },
    "matchingLinks": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean"
    },
    "scope": {
      "type": "string"
    },
    "measurement": {
      "type": "object",
      "properties": {
        "inputBytes": {
          "type": "number"
        },
        "payloadBytes": {
          "type": "number"
        },
        "estimatedInputTokens": {
          "type": "number"
        },
        "estimatedPayloadTokens": {
          "type": "number"
        },
        "estimateMethod": {
          "type": "string"
        }
      },
      "required": [
        "inputBytes",
        "payloadBytes",
        "estimatedInputTokens",
        "estimatedPayloadTokens",
        "estimateMethod"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "sourceUrl",
    "query",
    "links",
    "matchingLinks",
    "truncated",
    "scope",
    "measurement"
  ],
  "additionalProperties": false
}

Before you integrate

Prices are experimental. The service currently allows 1,000 new calls per day per payment rail across all accounts. Failed operations return reserved credits. Successful results are encrypted for ten-minute retry recovery. Review data handling and service limits.

Related tools

web $0.0020 / call

Readable Fetch

Fetch readable text from an approved public HTTPS host.

web.readable-fetch

web $0.0010 / call

Redirect Trace

Trace up to four redirects across approved public HTTPS hosts.

web.redirect-trace

web $0.0003 / call

Robots Evaluate

Evaluate supplied robots.txt for a URL and user agent; no network fetch.

web.robots-evaluate