# Microlink

> Turn any website into data. APIs for link previews, screenshots, PDF generation, and web scraping.

## API

- [Authentication](https://microlink.io/docs/api/basics/authentication.md): Securely authenticate your Microlink API requests using x-api-key headers. Includes best practices for Pro plan integration and protecting tokens via proxy for frontend usage.
- [Cache](https://microlink.io/docs/api/basics/cache.md): Optimize API performance with Microlink built-in cache layer. Understand unified vs. edge node caching, x-cache-status headers, and how to use ttl or force for cache invalidation.
- [Compression](https://microlink.io/docs/api/basics/compression.md): Reduce API latency and payload size using Brotli and Gzip compression. Learn how to configure Accept-Encoding headers and verify content-encoding for optimized Microlink API responses.
- [Endpoint](https://microlink.io/docs/api/basics/endpoint.md): Access Microlink API via free and pro endpoints. Learn how to perform HTTP GET requests, use camelCase or snake_case query parameters, and automate endpoint selection using Microlink Query Language (MQL).
- [Error codes](https://microlink.io/docs/api/basics/error-codes.md): Troubleshoot Microlink API error codes including EAUTH, ERATE, and EBRWSRTIMEOUT. Find solutions for authentication issues, rate limits, timeouts, and specific Pro plan parameter requirements.
- [Format](https://microlink.io/docs/api/basics/format.md): Understand the Microlink API response format based on the JSend specification. Learn about status codes, JSON data payloads, and how to handle error messages.
- [Rate limit](https://microlink.io/docs/api/basics/rate-limit.md): Understand Microlink API rate limits for free and pro endpoints. Monitor usage via x-rate-limit headers, handle HTTP 429, and scale your quota for high-concurrency.
- [CLI](https://microlink.io/docs/api/getting-started/cli.md): Install and use the CLI to interact with the API from your terminal. Perform requests, authenticate via API keys, and format JSON output.
- [Data fields](https://microlink.io/docs/api/getting-started/data-fields.md): Explore the default data fields extracted by Microlink API, including metadata, media properties, and HTTP status details like headers and redirects.
- [MCP](https://microlink.io/docs/api/getting-started/mcp.md): Connect Microlink MCP to your AI client to extract metadata, screenshots, PDFs, insights, media, markdown, and text from any URL.
- [Overview](https://microlink.io/docs/api/getting-started/overview.md): Get started with Microlink API. Learn how to automate browser actions, extract metadata, take screenshots, generate PDFs with a simple HTTP GET request.
- [adblock](https://microlink.io/docs/api/parameters/adblock.md): Improve performance and reduce response times by blocking non-essential advertisements, trackers, and cookie banners.
- [animations](https://microlink.io/docs/api/parameters/animations.md): Control CSS animations and transitions during website rendering. Ensures consistent snapshots by handling motion effects in the headless browser.
- [audio](https://microlink.io/docs/api/parameters/audio.md): Detect and extract audio sources from any URL. It returns browser-friendly audio URLs along with metadata enabling integration of media content from platforms.
- [cacheKey](https://microlink.io/docs/api/parameters/cacheKey.md): Take full control of cache identity to maximize hit rates and avoid redundant processing.
- [click](https://microlink.io/docs/api/parameters/click.md): Automate browser interactions by clicking specific DOM elements via CSS selectors. Use this parameter to trigger navigation, toggle UI components, or change page state.
- [colorScheme](https://microlink.io/docs/api/parameters/colorScheme.md): Force the browser to render websites in light or dark mode using the prefers-color-scheme CSS media feature.
- [data](https://microlink.io/docs/api/parameters/data.md): Define custom data extraction rules using CSS selectors with the Microlink Query Language (MQL). Extract specific content like prices, reviews, or any structured data from any URL.
- [device](https://microlink.io/docs/api/parameters/device.md): Emulate a wide range of mobile, tablet, and desktop devices by automatically setting the correct viewport, user agent, and screen resolution.
- [embed](https://microlink.io/docs/api/parameters/embed.md): Return a specific data field directly as the response body with appropriate content-type headers. Embed screenshots, PDFs, or extracted data directly in HTML, CSS, or Markdown.
- [filename](https://microlink.io/docs/api/parameters/filename.md): Define a custom name for generated assets like screenshots or PDFs using the filename parameter.
- [filter](https://microlink.io/docs/api/parameters/filter.md): Reduce response bandwidth and optimize payload size by selecting specific data fields.
- [force](https://microlink.io/docs/api/parameters/force.md): Bypass the Microlink CDN cache to fetch a fresh version of the target URL. Use the force parameter to invalidate existing cached copies and ensure the most up-to-date metadata.
- [function](https://microlink.io/docs/api/parameters/function.md): Execute custom JavaScript code inside a headless browser to perform advanced scraping or automation tasks. Gain full control over the page lifecycle with Puppeteer access.
- [headers](https://microlink.io/docs/api/parameters/headers.md): Configure custom HTTP headers to be sent with your requests to the target URL. This Pro feature allows for emulating specific browsers.
- [iframe](https://microlink.io/docs/api/parameters/iframe.md): The iframe parameter returns ready-to-use HTML and script tags for hundreds of providers.
- [insights](https://microlink.io/docs/api/parameters/insights.md): Analyze web performance and stack data with Microlink Insights. Extract identified technologies via Wappalyzer and detailed Lighthouse audit reports directly from any target URL.
- [insights › lighthouse](https://microlink.io/docs/api/parameters/insights/lighthouse.md): Generate comprehensive Google Lighthouse reports for any URL. Export web performance audits in JSON, HTML, or CSV formats using custom configurations via Microlink API.
- [insights › technologies](https://microlink.io/docs/api/parameters/insights/technologies.md): Identify the software stack behind any URL using Microlink technology detection. It returns a detailed list of frameworks, CDNs, and analytics tools with confidence scores.
- [javascript](https://microlink.io/docs/api/parameters/javascript.md): Control whether JavaScript is executed within the headless browser for a target URL.
- [mediaType](https://microlink.io/docs/api/parameters/mediaType.md): Switch between "screen" and "print" CSS media queries to control how a website renders for capture.
- [meta](https://microlink.io/docs/api/parameters/meta.md): Extract normalized metadata from any URL, including titles, descriptions, images, and logos.
- [modules](https://microlink.io/docs/api/parameters/modules.md): Inject JavaScript modules into a webpage during the rendering process.
- [palette](https://microlink.io/docs/api/parameters/palette.md): Extract dominant color palettes and accessibility-compliant color schemes from detected images.
- [pdf › format](https://microlink.io/docs/api/parameters/pdf/format.md): Customize the paper format for PDF generation from any URL. Supports standard sizes including A4, Letter, Legal, and Tabloid for high-quality.
- [pdf › height](https://microlink.io/docs/api/parameters/pdf/height.md): Set a custom paper height for your PDF generation using pixels, inches, or other CSS units. Fine-tune the dimensions of your website-to-PDF conversions.
- [pdf](https://microlink.io/docs/api/parameters/pdf.md): Generate high-quality PDFs from any website using Microlink headless browser infrastructure.
- [pdf › landscape](https://microlink.io/docs/api/parameters/pdf/landscape.md): Set the paper orientation to landscape for your website-to-PDF conversions. Toggle between portrait and landscape modes to optimize the layout of generated PDF documents.
- [pdf › margin](https://microlink.io/docs/api/parameters/pdf/margin.md): Configure custom paper margins for your website-to-PDF conversions. Specify unified margins or individual top, bottom, left, and right values.
- [pdf › pageRanges](https://microlink.io/docs/api/parameters/pdf/pageRanges.md): Define specific page ranges for your website-to-PDF conversion. Extract single pages or custom intervals like "1-5, 8, 11-13" from any URL using the Microlink API pageRanges parameter.
- [pdf › scale](https://microlink.io/docs/api/parameters/pdf/scale.md): Adjust the zoom level of your website-to-PDF conversions using the scale parameter with Microlink API automated browser.
- [pdf › width](https://microlink.io/docs/api/parameters/pdf/width.md): Set a custom paper width for your PDF generation using pixels, inches, or other CSS units. Fine-tune the horizontal dimensions of your website-to-PDF conversions.
- [ping](https://microlink.io/docs/api/parameters/ping.md): Validate the accessibility of all URLs extracted in the response payload. The ping parameter verifies that links to images, videos, or audio are publicly reachable.
- [prerender](https://microlink.io/docs/api/parameters/prerender.md): Optimize how content is fetched from the target URL by choosing between a headless browser or a simple HTTP request.
- [proxy](https://microlink.io/docs/api/parameters/proxy.md): Bypass IP rate limits, CAPTCHAs, and regional restrictions using high-quality proxy rotation.
- [retry](https://microlink.io/docs/api/parameters/retry.md): Configure the number of exponential backoff retries to attempt if the underlying browser encounters an unexpected internal error.
- [screenshot › animated](https://microlink.io/docs/api/parameters/screenshot/animated.md): Record a website as a short video instead of a static image. Capture animations, transitions and live content as an H.264 MP4 with a single API call.
- [screenshot › codeScheme](https://microlink.io/docs/api/parameters/screenshot/codeScheme.md): Beautify HTML and JSON content with professional code syntax highlighting using the codeScheme parameter. Choose from popular Prism themes like Darcula or provide a custom CSS URL.
- [screenshot › element](https://microlink.io/docs/api/parameters/screenshot/element.md): Capture a specific DOM element as a screenshot by providing a CSS selector. The Microlink API automatically waits for the element to be visible before rendering the image.
- [screenshot › fullPage](https://microlink.io/docs/api/parameters/screenshot/fullPage.md): Capture a high-resolution screenshot of the entire scrollable content of a website. Use the fullPage parameter to render the complete layout of a URL.
- [screenshot](https://microlink.io/docs/api/parameters/screenshot.md): Generate high-fidelity screenshots of any website with a single API call. Automatically handle headless browser infrastructure to extract visual data.
- [screenshot › omitBackground](https://microlink.io/docs/api/parameters/screenshot/omitBackground.md): Generate transparent screenshots by omitting the default white background of the webpage.
- [screenshot › overlay](https://microlink.io/docs/api/parameters/screenshot/overlay.md): Create professional screenshot compositions with customizable browser overlays and backgrounds.
- [screenshot › quality](https://microlink.io/docs/api/parameters/screenshot/quality.md): Control JPEG compression for website screenshots. Set quality between 0 and 100 to balance file size and visual fidelity.
- [screenshot › type](https://microlink.io/docs/api/parameters/screenshot/type.md): Choose between JPEG or PNG file formats for your website screenshots. Assets are automatically optimized and served in modern formats based on client device capabilities.
- [scripts](https://microlink.io/docs/api/parameters/scripts.md): Inject custom JavaScript into a webpage before it is rendered or captured.
- [scroll](https://microlink.io/docs/api/parameters/scroll.md): Navigate to specific sections of a webpage by scrolling to a DOM element matching a CSS selector.
- [staleTtl](https://microlink.io/docs/api/parameters/staleTtl.md): Optimize API performance by serving cached content while simultaneously refreshing it in the background.
- [styles](https://microlink.io/docs/api/parameters/styles.md): Inject custom CSS into a webpage before it is rendered or captured. The styles parameter supports both inline CSS rules and absolute URLs to external stylesheets.
- [timeout](https://microlink.io/docs/api/parameters/timeout.md): Define the maximum duration allowed for the API to process a request before timing out. The timeout parameter accepts values in milliseconds or human-readable formats.
- [ttl](https://microlink.io/docs/api/parameters/ttl.md): Define the cache expiration time for your requests to balance data freshness and response speed. The ttl parameter supports human-readable formats.
- [url](https://microlink.io/docs/api/parameters/url.md): The primary address of the website you want to process. The url parameter is the core requirement for any Microlink API request, serving as the base for metadata extraction.
- [video](https://microlink.io/docs/api/parameters/video.md): Detect and extract direct video source URLs from any website in a browser-friendly format.
- [viewport](https://microlink.io/docs/api/parameters/viewport.md): Customize the browser visible area and device capabilities to control how a website is rendered.
- [waitForSelector](https://microlink.io/docs/api/parameters/waitForSelector.md): Pause browser execution until a specific element is present in the DOM. The waitForSelector parameter ensures that dynamic content is fully rendered before extracting data.
- [waitForTimeout](https://microlink.io/docs/api/parameters/waitForTimeout.md): Force the headless browser to wait for a specific duration before capturing or extracting data from the target URL.
- [waitUntil](https://microlink.io/docs/api/parameters/waitUntil.md): Fine-tune when Microlink considers a page fully "loaded" by waiting for specific lifecycle events.

## Cards

- [Editor](https://microlink.io/docs/cards/getting-started/editor.md): Design and preview dynamic visual assets directly in the browser using the Cards Editor. Instantly shareable and can be programmatically populated with your own data.
- [Embed](https://microlink.io/docs/cards/getting-started/embed.md): Deploy your custom designs globally by embedding generated image URLs directly into your website markup. Cards are generated on-the-fly and then served via a high-performance CDN.
- [Overview](https://microlink.io/docs/cards/getting-started/overview.md): Create, automate, and scale dynamic visual assets with Microlink Cards, merges code and data. Use a React-based interactive editor, generate optimized images on the fly.
- [Presets](https://microlink.io/docs/cards/getting-started/presets.md): Utilize pre-defined design templates as the foundation for your dynamic visuals. Presets serve as reusable design building blocks that allow for the infinite generation of social media assets.
- [Query Variables](https://microlink.io/docs/cards/getting-started/query-variables.md): Dynamicize your designs by passing data directly through URL parameters to create unique variations of a single template.
- [Authentication](https://microlink.io/docs/cards/others/authentication.md): Securely authenticate your API requests while protecting your credentials from public exposure. You can safely inject your Pro API key and restrict usage to authorized domains.
- [Encoding](https://microlink.io/docs/cards/others/encoding.md): Manage how your design state and configuration are stored within the URL to ensure compatibility with the Microlink API.
- [Pricing](https://microlink.io/docs/cards/others/pricing.md): Cards operates on a consumption-based model tied to the Microlink API. Cloud-rendered screenshot served via a global edge network, usage counts toward your API quota.

## MQL

- [attr](https://microlink.io/docs/mql/data/attr.md): Extract HTML attributes, text, inner HTML, or serialize content from any URL using the Microlink Query Language (MQL) attr parameter.
- [evaluate](https://microlink.io/docs/mql/data/evaluate.md): Execute custom JavaScript strings or functions within the headless browser context to extract dynamic data or interact with the DOM using the evaluate parameter.
- [selector](https://microlink.io/docs/mql/data/selector.md): Define CSS selectors to target and extract specific HTML elements from any URL. Support for IDs, classes, pseudo-classes, and fallback logic for resilient scraping.
- [selectorAll](https://microlink.io/docs/mql/data/selectorAll.md): Extract multiple elements from a URL using CSS selectors. Similar to querySelectorAll, it returns a collection of structured data for lists, tables, or repeated patterns.
- [type](https://microlink.io/docs/mql/data/type.md): Validate and cast extracted values into specific data types like strings, numbers, images, or URLs. Ensure data consistency and correctness for your API responses.
- [API](https://microlink.io/docs/mql/getting-started/api.md): Technical documentation for the mql function. Learn how to configure URL targets, API keys, Node.js caching, and retry logic for high-performance web scraping and automation.
- [Installation](https://microlink.io/docs/mql/getting-started/installation.md): Install and set up the Microlink Query Language (MQL) client. Support for Node.js, Edge Functions (Vercel/Cloudflare), and direct Browser integration via ESM.
- [Overview](https://microlink.io/docs/mql/getting-started/overview.md): Use Microlink Query Language (MQL) to interact with Microlink API. A lightweight HTTP client for metadata extraction, custom data scraping, and browser automation.
- [Usage](https://microlink.io/docs/mql/getting-started/usage.md): Learn how to use the MQL library to fetch URL data. Detailed guide on handling API responses, objects, and MicrolinkError exceptions for robust error handling.
- [Basic rules definition](https://microlink.io/docs/mql/rules/basic.md): Learn how to define custom data extraction rules using MQL primitives: selectors, attributes, and types. Overwrite or extend default metadata to build custom APIs.
- [Fallbacks rules definition](https://microlink.io/docs/mql/rules/fallbacks.md): Implement resilient data scraping using fallback rules. Define multiple selector strategies to ensure data extraction success even when website structures or meta tags vary.
- [Nested rules definition](https://microlink.io/docs/mql/rules/nested.md): Organize your scraped data using nested rules. Map complex DOM structures into clean JSON objects by nesting selectors and attributes within a single parent property.

## Guides

- [Common patterns: Caching patterns](https://microlink.io/docs/guides/common/caching.md): Control cache TTL, serve stale responses while revalidating, bypass cache on demand, and verify caching behavior through response headers.
- [Common patterns: Private pages](https://microlink.io/docs/guides/common/private-pages.md): Access authenticated, session-based, or header-dependent pages safely. Choose between public headers and secret forwarding, use the right endpoint, and keep credentials secure.
- [Common patterns: Production patterns](https://microlink.io/docs/guides/common/production-patterns.md): Best practices for using Microlink API in production. Handle rate limits, choose the right endpoint, protect credentials, and build resilient integrations.
- [Common patterns: Proxy](https://microlink.io/docs/guides/common/proxy.md): Bypass IP blocking, CAPTCHAs, antibot protection, and regional restrictions using automatic or custom proxy rotation. Applies to every Microlink workflow.
- [Common patterns: Troubleshooting](https://microlink.io/docs/guides/common/troubleshooting.md): Debug common issues across all Microlink workflows. Fix timeouts, blocked sites, auth errors, plan-related errors, and learn to read response headers for diagnosis.
- [Content conversion](https://microlink.io/docs/guides/content-conversion.md): Convert any URL — a web page, a PDF, a docx, xlsx, or pptx document, or a JSON endpoint — into text, Markdown, HTML, or structured JSON with Microlink API.
- [JSON endpoint to JSON](https://microlink.io/docs/guides/content-conversion/json-endpoint-to-json.md): Use Microlink API to fetch a JSON endpoint URL and return its parsed response body as structured JSON.
- [URL to HTML](https://microlink.io/docs/guides/content-conversion/url-to-html.md): Use Microlink API to fetch, render, and return HTML from any URL — a web page, a PDF, or a docx, xlsx, or pptx document — either as JSON or as a direct HTML response.
- [URL to Markdown](https://microlink.io/docs/guides/content-conversion/url-to-markdown.md): Use Microlink API to convert any URL — a web page, a PDF, or a docx, xlsx, or pptx document — into Markdown for search, LLM, and document workflows.
- [URL to Text](https://microlink.io/docs/guides/content-conversion/url-to-text.md): Use Microlink API to convert any URL — a web page, a PDF, or a docx, xlsx, or pptx document — into readable plain text, either inside JSON or as a direct text response.
- [Data extraction: Caching and performance](https://microlink.io/docs/guides/data-extraction/caching-and-performance.md): Speed up repeated data extraction by reducing unnecessary work, choosing the right fetch mode, and applying the right cache strategy.
- [Data extraction: Defining rules](https://microlink.io/docs/guides/data-extraction/defining-rules.md): Model single fields, collections, nested objects, fallback logic, and computed values so Microlink returns the exact JSON shape you need.
- [Data extraction: Delivery and response shaping](https://microlink.io/docs/guides/data-extraction/delivery-and-response.md): Choose between full JSON, smaller filtered payloads, or direct field responses when consuming extracted data from Microlink API.
- [Data extraction](https://microlink.io/docs/guides/data-extraction.md): Extract exactly the fields you need from any page with Microlink API, understand how MQL rules shape the response, and choose the right next step for dynamic or private targets.
- [Data extraction: Page preparation](https://microlink.io/docs/guides/data-extraction/page-preparation.md): Render the right page state before extraction. Choose fetch mode, wait for dynamic content, emulate the right variant, and mutate the DOM when needed.
- [Data extraction: Private pages](https://microlink.io/docs/guides/data-extraction/private-pages.md): Extract data from authenticated, session-based, or header-dependent pages safely.
- [Data extraction: Troubleshooting](https://microlink.io/docs/guides/data-extraction/troubleshooting.md): Debug empty fields, wrong selectors, timing issues, and collection shape errors when extracting custom data.
- [Embed: Caching and performance](https://microlink.io/docs/guides/embed/caching-and-performance.md): Keep embeds fast at scale. Cache embed responses, avoid hot-linking issues, prefer direct embed for static markup, and tune TTL for the right freshness.
- [Embed: Generate custom previews with AI](https://microlink.io/docs/guides/embed/custom-previews-with-ai.md): Skip the SDK and ship link previews styled to your project. Use the Microlink metadata API for the data and let Cursor, Claude Code, or any AI coding assistant generate the markup that matches your existing design system.
- [Embed: iframe parameter](https://microlink.io/docs/guides/embed/iframe.md): Return ready-to-inject embed HTML and scripts from any oEmbed provider. Learn what the iframe field returns, how to inject it, when to use it instead of a custom card, and which providers are supported.
- [Embed](https://microlink.io/docs/guides/embed.md): Turn any URL into a rich preview, an interactive player, or a plain asset URL. Pick the SDK, the oEmbed iframe, or metadata-driven HTML — every approach starts from the same API call.
- [Embed: Metadata API with custom HTML/CSS](https://microlink.io/docs/guides/embed/metadata-api.md): Build link previews entirely in your own markup. Use the Microlink metadata API to fetch normalized fields, then style them with custom HTML and CSS to match your design system.
- [Embed: Private pages and proxy](https://microlink.io/docs/guides/embed/private-pages-and-proxy.md): Embed authenticated dashboards, geofenced content, and pages blocked by antibot systems. Forward credentials safely, route through proxies, and keep secrets out of public embed URLs.
- [Embed: SDK](https://microlink.io/docs/guides/embed/sdk.md): The Microlink SDK turns any URL into a preview card or interactive iframe with one drop-in component. Available for React, Vue, and vanilla JavaScript, under 10KB, framework-agnostic.
- [Embed: Troubleshooting](https://microlink.io/docs/guides/embed/troubleshooting.md): Debug embed-specific failures: missing iframes, broken images, hot-linking blocks, missing og:image, and inconsistent provider widgets.
- [Function: Browser interaction](https://microlink.io/docs/guides/function/browser-interaction.md): Use Puppeteer to interact with a headless browser — click, wait, navigate, extract data, and combine with other Microlink parameters.
- [Function](https://microlink.io/docs/guides/function.md): Run custom JavaScript remotely inside Microlink's headless browser, return exactly the result you need, and know when to reach for functions over simpler workflows.
- [Function: Profiling and performance](https://microlink.io/docs/guides/function/profiling-and-performance.md): Understand execution phases, plan limits, and optimization techniques for function requests. Use profiling data to find bottlenecks and reduce execution time.
- [Function: Troubleshooting](https://microlink.io/docs/guides/function/troubleshooting.md): Handle function errors, understand resource limit errors, and debug common failure modes in function requests.
- [Function: Writing functions](https://microlink.io/docs/guides/function/writing-functions.md): Write simple JavaScript functions that run remotely in a Node.js sandbox. Return any value, pass custom parameters, and use npm packages — no browser needed.
- [Guides](https://microlink.io/docs/guides.md): Step-by-step guides for common Microlink workflows. Learn how to query public search surfaces, capture screenshots, extract custom data, generate PDFs, extract metadata, and more with practical examples.
- [Insights: Caching and performance](https://microlink.io/docs/guides/insights/caching-and-performance.md): Optimize Insights requests for speed and cost. Cache expensive Lighthouse runs, skip unnecessary work, and choose the right analysis mode for your use case.
- [Insights](https://microlink.io/docs/guides/insights.md): Analyze any URL with Microlink Insights, choose between technology detection and Lighthouse audits, and move quickly to the right next step.
- [Insights: Lighthouse reports](https://microlink.io/docs/guides/insights/lighthouse-reports.md): Generate Lighthouse audits with Microlink Insights, choose the right output format, and tune reports with presets or custom Lighthouse settings.
- [Insights: Technology detection](https://microlink.io/docs/guides/insights/technology-detection.md): Identify the frameworks, platforms, analytics tools, and infrastructure behind any URL using Microlink Insights.
- [Insights: Troubleshooting](https://microlink.io/docs/guides/insights/troubleshooting.md): Debug missing or wrong Insights results. Fix empty analyses, timing issues, timeouts, wrong page variants, and blocked sites.
- [Metadata: Caching and performance](https://microlink.io/docs/guides/metadata/caching-and-performance.md): Optimize metadata extraction for speed and freshness. Limit detection work, avoid unnecessary enrichments, and apply the right cache strategy.
- [Metadata: Choosing fields](https://microlink.io/docs/guides/metadata/choosing-fields.md): Request only the normalized metadata fields you actually need, and understand how Microlink represents text, media, and missing values.
- [Metadata: Delivery and response shaping](https://microlink.io/docs/guides/metadata/delivery-and-response.md): Keep the full metadata payload, trim it with filter, or return a single field directly with embed.
- [Metadata: Extending results](https://microlink.io/docs/guides/metadata/extending-results.md): Go beyond the standard metadata fields by adding custom extraction rules, ready-to-use oEmbed HTML, color palettes, or site analysis.
- [Metadata](https://microlink.io/docs/guides/metadata.md): Extract normalized metadata from any URL with Microlink API, choose the fields you need, and learn the right next step for dynamic pages, response shaping, and private targets.
- [Metadata: Page preparation](https://microlink.io/docs/guides/metadata/page-preparation.md): Render the right version of the page before metadata extraction. Choose fetch mode, waits, and JavaScript behavior for dynamic or SPA targets.
- [Metadata: Private pages](https://microlink.io/docs/guides/metadata/private-pages.md): Extract metadata from pages behind logins, sessions, or header-based personalization safely.
- [Metadata: Troubleshooting](https://microlink.io/docs/guides/metadata/troubleshooting.md): Debug missing or wrong metadata. Fix null fields, dynamic-page issues, and wrong page variants.
- [PDF: Caching and performance](https://microlink.io/docs/guides/pdf/caching-and-performance.md): Optimize Microlink PDF generation for speed and cost. Skip unnecessary metadata, reduce rendering work, and apply the right cache strategy.
- [PDF: Delivery and embedding](https://microlink.io/docs/guides/pdf/embedding.md): Choose how to consume Microlink PDFs. Use JSON plus CDN URLs in backend workflows, or return the PDF directly for download links, previews, and embedded viewers.
- [PDF](https://microlink.io/docs/guides/pdf.md): Generate your first PDF from any website with Microlink API, understand the PDF response, and choose the right next step for layout, delivery, and caching.
- [PDF: Page preparation](https://microlink.io/docs/guides/pdf/page-preparation.md): Prepare a page before Microlink prints it to PDF. Choose print or screen CSS, wait for dynamic content, click UI controls, inject CSS, and clean up unwanted elements.
- [PDF: Page size and layout](https://microlink.io/docs/guides/pdf/page-size-and-layout.md): Control the paper size and printed layout of generated PDFs. Choose standard formats or custom dimensions, set margins, switch orientation, scale content, and export specific page ranges.
- [PDF: Private pages](https://microlink.io/docs/guides/pdf/private-pages.md): Generate PDFs from pages behind logins, sessions, or header-based personalization safely.
- [PDF: Troubleshooting](https://microlink.io/docs/guides/pdf/troubleshooting.md): Debug PDF generation failures and wrong output. Fix missing content, bad layout, and wrong print styling.
- [Screenshot: Browser settings](https://microlink.io/docs/guides/screenshot/browser-settings.md): Configure the headless browser before capturing a screenshot. Set viewport dimensions, emulate devices, force dark mode, control CSS media type, and manage animations.
- [Screenshot: Caching and performance](https://microlink.io/docs/guides/screenshot/caching-and-performance.md): Optimize Microlink screenshot requests for speed and cost. Disable unnecessary metadata, tune browser settings, and apply the right cache strategy.
- [Screenshot: Customizing output](https://microlink.io/docs/guides/screenshot/customizing-output.md): Control what your Microlink screenshot captures and how it looks. Full-page mode, element targeting, format selection, transparent backgrounds, browser overlays, and code themes.
- [Screenshot: Delivery and embedding](https://microlink.io/docs/guides/screenshot/embedding.md): Choose the right way to consume Microlink screenshots. Use JSON responses and CDN URLs in app workflows, or embed screenshots directly in HTML, CSS, Markdown, and OG tags.
- [Screenshot](https://microlink.io/docs/guides/screenshot.md): Take your first website screenshot with Microlink API, learn how screenshot options work, and choose the right delivery mode for your use case.
- [Screenshot: Page interaction](https://microlink.io/docs/guides/screenshot/page-interaction.md): Interact with web pages before taking a screenshot. Click buttons, scroll to sections, wait for content, inject CSS and JavaScript, and block ads.
- [Screenshot: Private pages](https://microlink.io/docs/guides/screenshot/private-pages.md): Capture screenshots of pages behind logins, sessions, or header-based personalization safely.
- [Screenshot: Troubleshooting](https://microlink.io/docs/guides/screenshot/troubleshooting.md): Debug screenshot failures and wrong captures. Fix blank screenshots, timing issues, wrong capture areas, overlay errors, and antibot protections.
- [Search: Autocomplete](https://microlink.io/docs/guides/search/autocomplete.md): Search suggestions as the user types. Use it for query expansion, demand modeling, and prompt seeding.
- [Search: Content expansion](https://microlink.io/docs/guides/search/content-expansion.md): Fetch full HTML or Markdown for search results and SERP pages. Learn the two-step retrieval model that keeps search lightweight and only expands the results worth reading more deeply.
- [Search: Images](https://microlink.io/docs/guides/search/images.md): Full-resolution image URLs with dimensions. Use it for visual references, asset discovery, and image metadata retrieval.
- [Search](https://microlink.io/docs/guides/search.md): Structured search results as JSON — no HTML parsing, no browser. Built for agents, prompts, and RAG pipelines.
- [Search: Maps](https://microlink.io/docs/guides/search/maps.md): Detailed place data with ratings, hours, and pricing. Use it when you need richer metadata than Places provides.
- [Search: News](https://microlink.io/docs/guides/search/news.md): Recent articles with publisher, date, and thumbnail. Use it when freshness matters and your workflow depends on publication timestamps.
- [Search: Patents](https://microlink.io/docs/guides/search/patents.md): Patent filings with ISO 8601 dates and metadata. Use it for prior-art research, invention monitoring, and filing lookup.
- [Search: Integration patterns](https://microlink.io/docs/guides/search/patterns.md): Practical patterns for using @microlink/google in agent frameworks, RAG pipelines, news monitoring, entity lookup, academic research, and product intelligence workflows.
- [Search: Places](https://microlink.io/docs/guides/search/places.md): Local business listings with coordinates and contact info. Use it for local entity lookup when you need addresses, phone numbers, and geographic coordinates.
- [Search: Scholar](https://microlink.io/docs/guides/search/scholar.md): Academic papers with citation counts and PDF links. Use it for technical or scientific research workflows that need papers, citations, and publication context.
- [Search: Web Search](https://microlink.io/docs/guides/search/search.md): Web results with knowledge graph, related questions, and related searches. The default surface when you omit type.
- [Search: Shopping](https://microlink.io/docs/guides/search/shopping.md): Product listings with parsed prices and structured ratings. Use it for product intelligence, price comparison, and merchant research.
- [Search: Videos](https://microlink.io/docs/guides/search/videos.md): Video metadata with duration in milliseconds. Use it for tutorial discovery, content research, and video SERP coverage.
- [What is Microlink](https://microlink.io/docs/guides/what-is-microlink.md): Understand what Microlink is, when to use it, and how a single API call replaces browser infrastructure, scraping scripts, and rendering pipelines.

## SDK

- [Overview](https://microlink.io/docs/sdk/getting-started/overview.md): Implementation guide for Microlink SDK. Transform plain URLs into beautiful, high-performance link previews, embeds, and media players with less than 10KB of JS.
- [Styling](https://microlink.io/docs/sdk/getting-started/styling.md): Customize the look and feel of your link previews using CSS variables and BEM classes. Learn how to style Microlink SDK components to match your brand design system.
- [Jekyll](https://microlink.io/docs/sdk/integrations/jekyll.md): Learn how to integrate Microlink SDK with Jekyll to create beautiful link previews in your blog posts. Use simple Markdown to automate URL-to-preview conversion.
- [React](https://microlink.io/docs/sdk/integrations/react.md): Implement beautiful link previews in React applications using the official Microlink SDK. Supports styled-components, custom props, and all Microlink API parameters.
- [Vanilla](https://microlink.io/docs/sdk/integrations/vanilla.md): Add beautiful link previews to any website with Microlink Vanilla. Integrate via CDN or npm, use CSS selectors for auto-replacement, and pass API parameters.
- [Vue](https://microlink.io/docs/sdk/integrations/vue.md): Integrate beautiful link previews into Vue.js apps using the official Microlink SDK. Supports global registration, custom props, and CSS variable styling.
- [apiKey](https://microlink.io/docs/sdk/parameters/api-key.md): Authenticate your Microlink SDK requests using your API key to increase rate limits and access Pro features.
- [contrast](https://microlink.io/docs/sdk/parameters/contrast.md): Enable high-contrast mode for link previews based on predominant image colors. Improves accessibility and creates visually striking cards that adapt to your content.
- [direction](https://microlink.io/docs/sdk/parameters/direction.md): Configure the text direction of your link previews. Support for LTR (left-to-right) and RTL (right-to-left) layouts.
- [fetchData](https://microlink.io/docs/sdk/parameters/fetch-data.md): Control how link data is retrieved. Enable internal API calls for real-time metadata extraction or disable it to provide custom pre-fetched data manually.
- [lazy](https://microlink.io/docs/sdk/parameters/lazy.md): Optimize performance with lazy loading for link previews. Use the lazy parameter to trigger API calls only when cards enter the viewport.
- [mediaRef](https://microlink.io/docs/sdk/parameters/media-ref.md): Access the underlying DOM reference of the media component using the mediaRef prop. Perfect for programmatic playback control or attaching custom event listeners.
- [autoPlay](https://microlink.io/docs/sdk/parameters/media/auto-play.md): Control the media playback behavior of your link previews. Use the autoPlay parameter to enable or disable automatic video and audio playback for Microlink SDK components.
- [controls](https://microlink.io/docs/sdk/parameters/media/controls.md): Enable or disable native media player controls for video and audio in your link previews. Use the controls parameter to customize the interface of Microlink SDK.
- [media](https://microlink.io/docs/sdk/parameters/media.md): Select the primary media type for your link previews. Support for images, logos, video, audio, screenshots, and iframes with automatic fallback logic.
- [loop](https://microlink.io/docs/sdk/parameters/media/loop.md): Configure media looping for your link previews. Use the loop parameter to specify whether video or audio content should restart automatically after finishing.
- [muted](https://microlink.io/docs/sdk/parameters/media/muted.md): Control the audio state of media within your link previews. Use the muted parameter to enable or disable sound for auto-playing videos and audio components.
- [setData](https://microlink.io/docs/sdk/parameters/set-data.md): Manually override or augment extracted metadata. Pass an object or a function to completely transform the data before the link preview is rendered.
- [size](https://microlink.io/docs/sdk/parameters/size.md): Define the visual dimensions of your link previews. Choose between small, normal, or large sizes to best fit your application layout and content density requirements.
- [url](https://microlink.io/docs/sdk/parameters/url.md): Learn how to use the required url parameter to extract data, capture screenshots, or generate PDFs from any target website using the Microlink API.
