Fetch overview

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. HTML and PDF documents are supported. Optional JavaScript rendering is available for HTML pages, along with optional raw HTML and extracted image URLs. "pro" delivers significantly higher success rates on hard-to-retrieve pages. Pass a JSON Schema in schema to also get typed JSON from that same page in data. Default Fetch is unchanged: URL in, markdown out. Structured output is an optional extra on that same request.

Parameters

Parameter	Default	Description
`url`	(required)	The page to fetch. Must be a valid HTTP/HTTPS URL.
`mode`	`"standard"`	Retrieval mode. Use `"standard"` for regular pages. `"pro"` delivers significantly higher success rates on hard-to-retrieve pages.
`renderJs`	`false`	Render 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.
`includeRawHtml`	`false`	Return the original HTML alongside the markdown. Used for custom parsing or preservation of structures that markdown does not represent.
`extractImages`	`false`	Return a separate list of image URLs alongside the markdown.
`schema`	(optional)	JSON Schema of `type` `"object"` describing the JSON to extract from the page. When present, the response includes `data`. Field `description`s tell the model what to look for.
`instructions`	(optional)	Extra rules the schema cannot express, such as currency or which prices to keep. Requires `schema`. Maximum 4,000 characters.

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 mode, renderJs, includeRawHtml, extractImages, schema, and instructions is covered on the Fetch best practices page.

Structured output

schema turns structured output on. instructions is optional: schema without instructions is valid, and field descriptions do the work. When schema is present:

Existing response fields stay. Markdown is still returned. data is an object matching the schema for fields found on the page.
Fields with no grounded value are omitted, even if the schema marks them required. Values are not invented.
instructions without schema returns a 400.
schema must be a JSON Schema object (type "object"). An array or other root type returns a 400.
mode, renderJs, includeRawHtml, and extractImages are independent of structured output.
Fetch reads this URL only. It does not follow links. For many rows across a listing page, use Extract.
Search structured output stays on structuredOutputSchema. Fetch uses schema and instructions.

Structured output adds a model pass after the scrape, so the call is slower than markdown-only Fetch and costs $0.001 more. See pricing.

Constraints

Fetch supports HTML and PDF. Other binary URLs (ZIP, image, video) return a 400 error.

Fetch does not authenticate. Pages behind a login wall return what an anonymous visitor would see.

HTML pages over 20 MB and PDFs over 100 MB return a 400 error. See the rate-limits page for request-rate limits.

Pricing

Cost depends on mode and renderJs. Adding a schema for structured output adds a flat $0.001 on top of any combination.

`mode`	`renderJs`	Markdown only	With `schema`
`"standard"`	`false`	$0.001 per call	$0.002 per call
`"standard"`	`true`	$0.005 per call	$0.006 per call
`"pro"`	`false`	$0.005 per call	$0.006 per call
`"pro"`	`true`	$0.01 per call	$0.011 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",
    mode="standard",
    render_js=True,
)
print(response)

import { LinkupClient } from 'linkup-sdk';

const client = new LinkupClient({ apiKey: '<YOUR_LINKUP_API_KEY>' });

const response = await client.fetch({
  url: 'https://docs.linkup.so',
  mode: 'standard',
  renderJs: true,
});
console.log(response);

curl -X POST "https://api.linkup.so/v1/fetch" \
  -H "Authorization: Bearer $LINKUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://docs.linkup.so",
    "mode": "standard",
    "renderJs": true
  }'

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.

Structured output example

Structured output is live on POST /v1/fetch. If your current SDK release does not accept schema or instructions, send the same JSON body as the curl example.

from linkup import LinkupClient

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

schema = {
    "type": "object",
    "properties": {
        "jobs": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "position": {
                        "type": "string",
                        "description": "The job title or position",
                    },
                    "city": {
                        "type": "string",
                        "description": "The city where the job is located",
                    },
                },
            },
        }
    },
}

response = client.fetch(
    url="https://www.linkup.so/careers",
    schema=schema,
    instructions="If a position is listed in multiple cities, emit one jobs item per city so jobs[].city is a single city.",
)
print(response.data)

import { LinkupClient } from 'linkup-sdk';

const client = new LinkupClient({ apiKey: '<YOUR_LINKUP_API_KEY>' });

const schema = {
  type: 'object',
  properties: {
    jobs: {
      type: 'array',
      items: {
        type: 'object',
        properties: {
          position: {
            type: 'string',
            description: 'The job title or position',
          },
          city: {
            type: 'string',
            description: 'The city where the job is located',
          },
        },
      },
    },
  },
};

const response = await client.fetch({
  url: 'https://www.linkup.so/careers',
  schema,
  instructions:
    'If a position is listed in multiple cities, emit one jobs item per city so jobs[].city is a single city.',
});
console.log(response.data);

curl -X POST "https://api.linkup.so/v1/fetch" \
  -H "Authorization: Bearer $LINKUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.linkup.so/careers",
    "schema": {
      "type": "object",
      "properties": {
        "jobs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "position": {
                "type": "string",
                "description": "The job title or position"
              },
              "city": {
                "type": "string",
                "description": "The city where the job is located"
              }
            }
          }
        }
      }
    },
    "instructions": "If a position is listed in multiple cities, emit one jobs item per city so jobs[].city is a single city."
  }'

Successful response (abbreviated). markdown is still returned; data is present because schema was set:

{
  "markdown": "# Careers\n\n...",
  "data": {
    "jobs": [
      { "position": "Talent Acquisition", "city": "New York" },
      { "position": "Founding DevRel Engineer", "city": "NYC (NY)" },
      { "position": "Founding DevRel Engineer", "city": "San Francisco (CA)" }
    ]
  }
}

Best practices

JavaScript rendering, structured output, pairing with Search.

For AI agents

Tool definition and integration prompt.

API reference

Full parameter spec and response schema.

Get Started

Endpoints

Platform

Guides

Tutorials

FAQ

Parameters

Structured output

Constraints

Pricing

Example

Get your API key

Structured output example

Next

Best practices

For AI agents

API reference

​Parameters

​Structured output

​Constraints

​Pricing

​Example

Get your API key

​Structured output example

​Next

Best practices

For AI agents

API reference

Parameters

Structured output

Constraints

Pricing

Example

Structured output example

Next