Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.linkup.so/llms.txt

Use this file to discover all available pages before exploring further.

Fetch is Linkup’s real-time page content extractor. Given a URL, the /fetch route returns a clean markdown rendering of the page, optimized for LLM consumption. Optional JavaScript rendering is available, along with optional raw HTML and extracted image URLs.

Parameters

ParameterDefaultDescription
url(required)The page to fetch. Must be a valid HTTP/HTTPS URL.
renderJsfalseRender the page’s JavaScript before extraction. Required for client-side-rendered pages (SPAs, dashboards, many modern marketing sites). See pricing for the rendered-call rate.
includeRawHtmlfalseReturn the original HTML alongside the markdown. Used for custom parsing or preservation of structures that markdown does not represent.
extractImagesfalseReturn a separate list of image URLs alongside the markdown.
In agentic pipelines, set renderJs to true by default. Many modern sites are client-side rendered; switch to false only after confirming the specific site renders server-side.
When and how to use renderJs, includeRawHtml, and extractImages is covered on the Fetch best practices page.

Constraints

Fetch is HTML only. Binary URLs (PDF, ZIP, image, video) return a 400 error.
Fetch does not authenticate. Pages behind a login wall return what an anonymous visitor would see.
Pages over 20 MB return a 400 error. See the rate-limits page for request-rate limits.

Pricing

ModeCost
renderJs is false$0.001 per call
renderJs is true$0.005 per call

Example

Get your API key

Create a Linkup account for free to get your API key.
from linkup import LinkupClient

client = LinkupClient(api_key="<YOUR_LINKUP_API_KEY>")

response = client.fetch(
    url="https://docs.linkup.so",
    render_js=True,
)
print(response)
Successful response:
{
  "markdown": "# Linkup docs\n\nGet started for free, no credit card required...",
  "rawHtml": "<!doctype html><html>...</html>",
  "images": [
    { "alt": "Linkup logo", "url": "https://docs.linkup.so/images/logo-light.svg" }
  ]
}
rawHtml is present only when includeRawHtml is true. images is present only when extractImages is true. markdown is always returned.

Next

Best practices

JavaScript rendering, common patterns, constraints.

For AI agents

Tool definition and integration prompt.

API reference

Full parameter spec and response schema.