API Reference
URL Metadata Fetcher
Use to fetch page metadata from a URL: title, description, Open Graph, favicon, HTTP status, and content type. Optional main-content text. One URL or items[]. Not article text (Web Content Cleaner) and not a link list (Link Extractor). If error is worker_chunk_failed, retry those items; the URL was not fetched. The HTTP body has correlation_id and data. The item array is data.results.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
const body = JSON.stringify({ "url": "https://www.python.org/", "include_content": false, "follow_redirects": true, "timeout": 10})fetch("https://example.com/api/v1/tools/get_url_metadata", { method: "POST", headers: { "Content-Type": "application/json" }, body}){ "correlation_id": "00000000-0000-4000-8000-000000000001", "data": { "results": [ { "data": { "title": "Welcome to Python.org", "description": "The official home of the Python Programming Language", "favicon": "https://www.python.org/static/favicon.ico", "og": { "title": "Welcome to Python.org", "description": "The official home of the Python Programming Language" } }, "meta": { "url": "https://www.python.org/", "final_url": "https://www.python.org/", "status_code": 200, "content_type": "text/html; charset=utf-8", "via_proxy": false, "retries": 0 } } ] }}