llms.txt
# Microlink
> Turn any website into data. APIs for link previews, screenshots, PDF generation, and web scraping.
## Machine-readable
- [OpenAPI](https://microlink.io/openapi.json): Microlink API specification
- [Agent feedback](https://microlink.io/.well-known/agent-feedback.json): How agents report Microlink API problems
## API overview
- [Microlink API: Turn Any URL into Screenshots, PDFs, and Data](https://microlink.io/api.md): The Microlink API turns any URL into screenshots, PDFs, metadata, markdown, and HTML with one REST call. Free API key with 100 requests a month.
## AI overview
- [Microlink AI: Prompt Your Agent to Use Microlink](https://microlink.io/ai.md): Paste one prompt into Claude, Cursor, or ChatGPT. The Microlink skill is the entry point for screenshots, PDFs, markdown, and scraping. Free API key, no credit card.
## API
- [Microlink 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 production integration and protecting tokens via proxy for frontend usage.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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 the SDK.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: CLI](https://microlink.io/docs/api/getting-started/cli.md): Install and use the CLI to interact with the API from your terminal. Every product is a subcommand; flags map to API options.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: adblock](https://microlink.io/docs/api/parameters/adblock.md): Improve performance and reduce response times by blocking non-essential advertisements, trackers, and cookie banners.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: cacheKey](https://microlink.io/docs/api/parameters/cacheKey.md): Take full control of cache identity to maximize hit rates and avoid redundant processing.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: data](https://microlink.io/docs/api/parameters/data.md): Define custom data extraction rules using CSS selectors. Extract specific content like prices, reviews, or any structured data from any URL, through the API or the SDK.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: filename](https://microlink.io/docs/api/parameters/filename.md): Define a custom name for generated assets like screenshots or PDFs using the filename parameter.
- [Microlink API: filter](https://microlink.io/docs/api/parameters/filter.md): Reduce response bandwidth and optimize payload size by selecting specific data fields.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: iframe](https://microlink.io/docs/api/parameters/iframe.md): The iframe parameter returns ready-to-use HTML and script tags for hundreds of providers.
- [Microlink API: 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.
- [Microlink API: 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.
- [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.
- [Microlink API: javascript](https://microlink.io/docs/api/parameters/javascript.md): Control whether JavaScript is executed within the headless browser for a target URL.
- [Microlink API: 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.
- [Microlink API: meta](https://microlink.io/docs/api/parameters/meta.md): Extract normalized metadata from any URL, including titles, descriptions, images, and logos.
- [Microlink API: modules](https://microlink.io/docs/api/parameters/modules.md): Inject JavaScript modules into a webpage during the rendering process.
- [Microlink API: palette](https://microlink.io/docs/api/parameters/palette.md): Extract dominant color palettes and accessibility-compliant color schemes from detected images.
- [Microlink API: pdf](https://microlink.io/docs/api/parameters/pdf.md): Generate high-quality PDFs from any website using Microlink headless browser infrastructure.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: proxy](https://microlink.io/docs/api/parameters/proxy.md): Bypass IP rate limits, CAPTCHAs, and regional restrictions using high-quality proxy rotation.
- [Microlink API: proxy › location](https://microlink.io/docs/api/parameters/proxy/location.md): Route the request through a proxy IP in a specific country to fetch region-specific content.
- [Microlink API: proxy › url](https://microlink.io/docs/api/parameters/proxy/url.md): Route every sub-request through your own HTTP proxy server.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: screenshot › omitBackground](https://microlink.io/docs/api/parameters/screenshot/omitBackground.md): Generate transparent screenshots by omitting the default white background of the webpage.
- [Microlink API: screenshot › overlay](https://microlink.io/docs/api/parameters/screenshot/overlay.md): Create professional screenshot compositions with customizable browser overlays and backgrounds.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: scripts](https://microlink.io/docs/api/parameters/scripts.md): Inject custom JavaScript into a webpage before it is rendered or captured.
- [Microlink API: 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.
- [Microlink API: staleTtl](https://microlink.io/docs/api/parameters/staleTtl.md): Optimize API performance by serving cached content while simultaneously refreshing it in the background.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: video](https://microlink.io/docs/api/parameters/video.md): Detect and extract direct video source URLs from any website in a browser-friendly format.
- [Microlink API: viewport](https://microlink.io/docs/api/parameters/viewport.md): Customize the browser visible area and device capabilities to control how a website is rendered.
- [Microlink API: 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.
- [Microlink API: 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.
- [Microlink API: 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
- [Microlink 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.
- [Microlink Cards: 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.
- [Microlink Cards: 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.
- [Microlink Cards: 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.
- [Microlink Cards: 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.
- [Microlink Cards: 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 API key and restrict usage to authorized domains.
- [Microlink Cards: 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.
- [Microlink Cards: 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.
## Guides
- [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.
- [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 str
