---
source_url: "https://jina.ai/api-dashboard/"
title: Jina Search Foundation API
mirrored_at: 2026-08-11T01:39:27.855Z
host: jina.ai
cited_in_42a: true
mirror_canonical: "https://index.42a.ai/jina.ai/api-dashboard/index"
---

> **Original source:** https://jina.ai/api-dashboard/

Parameters

The target URL to fetch content from

Add API Key for Higher Rate Limit

Enter your Jina API key to access a higher rate limit. For latest rate limit information, please refer to the table below.[Learn more](https://jina.ai/reader#rate-limit)

Browser Engine (Quality/Speed)

Choose the browser engine for fetching the webpage content. This affects the quality, speed, completeness, accessibility of the content.[Learn more](https://jina.ai/api-dashboard/reader-speed-test)

Default

Content Format

You can control the level of detail in the response to prevent over-filtering. The default pipeline is optimized for most websites and LLM input.

Default

JSON Response

The response will be in JSON format, containing the URL, title, content, and timestamp (if available). In Search mode, it returns a list of five entries, each following the described JSON structure.

Timeout (seconds)

Maximum time to wait for page load. Increase for slow pages, decrease for simple static pages.

Token Budget

Limits the maximum number of tokens used for this request. Exceeding this limit will cause the request to fail.

Use ReaderLM-v2

Experimental

Uses ReaderLM-v2 for HTML to Markdown conversion, to deliver high-quality results for websites with complex structures and contents. Costs 3x tokens![Learn more](https://jina.ai/news/readerlm-v2-frontier-small-language-model-for-html-to-markdown-and-json)

Extract Only (CSS Selector)

Only extract content matching these CSS selectors. Example: article, .main-content, #post-body

Wait For (CSS Selector)

Wait until these elements appear before extracting content. Useful for dynamically loaded content.

Exclude (CSS Selector)

Remove these elements before extraction. Example: nav, footer, .sidebar, #ads

Remove All Images

Strip all images from the output. Reduces token usage when images are not needed.

OpenAI Citation Format

Format links for OpenAI's web browsing tool. Uses special citation markers compatible with GPT models.[Learn more](https://cookbook.openai.com/articles/openai-harmony#browser-tool)

Links Summary Section

A "Buttons & Links" section will be created at the end. This helps the downstream LLMs or web agents navigating the page or take further actions.

None

Images Summary Section

An "Images" section will be created at the end. This gives the downstream LLMs an overview of all visuals on the page, which may improve reasoning.

None

Browser Viewport Size

POST

Set browser window dimensions. Affects responsive layouts and content visibility.[Learn more](https://pptr.dev/api/puppeteer.viewport)

Forward Cookie

Our API server can forward your custom cookie settings when accessing the URL, which is useful for pages requiring extra authentication. Note that requests with cookies will not be cached.[Learn more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie)

Image Caption

Captions all images at the specified URL, adding 'Image \[idx\]: \[caption\]' as an alt tag for those without one. This allows downstream LLMs to interact with the images in activities such as reasoning and summarizing.

Use a Proxy Server

Our API server can utilize your proxy to access URLs, which is helpful for pages accessible only through specific proxies.[Learn more](https://en.wikipedia.org/wiki/Proxy_server)

Use a Country-Specific Proxy Server

Set country code for location-based proxy server. Use 'auto' for optimal selection or 'none' to disable.

Bypass Cached Content

Our API caches URL contents for a certain amount of time. Set it to true to ignore the cached result and fetch the content from the URL directly.

Cache Tolerance (seconds)

Accept cached content if younger than N seconds. Set to 0 for fresh content (same as Bypass Cache), or higher values to allow faster responses from cache.

Page Ready Timing

When to consider a page fully loaded. Later timings wait longer but capture more dynamic content.

Default

Custom User-Agent

Override the browser User-Agent string. Useful for accessing sites that require specific browsers or block crawlers.

Custom Referer

Set the HTTP Referer header. Some sites check this to verify traffic comes from expected sources.

Preserve Base64 Images

Keep inline base64-encoded images in markdown output instead of converting them to external URLs.

Do Not Cache or Track

Prevent this request from being cached or logged on our servers. Use for sensitive URLs.

Github Flavored Markdown

Opt in/out features from GFM (Github Flavored Markdown).

Enabled

Stream Mode

Stream mode is beneficial for large target pages, allowing more time for the page to fully render. If standard mode results in incomplete content, consider using Stream mode.[Learn more](https://github.com/jina-ai/reader?tab=readme-ov-file#streaming-mode)

Customize Browser Locale

Control the browser locale to render the page. Lots of websites serve different content based on the locale.[Learn more](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language)

Respect robots.txt

Check robots.txt rules before fetching. Specify which bot name to use for the check.

Include iframe Content

Extract content from embedded iframes. Enable for pages with content loaded in iframes.

Include Shadow DOM

Extract content from Shadow DOM components. Enable for pages using web components.

Use Final URL as Base

Resolve relative URLs using the final destination URL after redirects, instead of the original URL.

Local PDF/HTML file

POST

Use Reader on your local PDF and HTML file by uploading them. Only support pdf and html files. For HTML, please also specify a reference URL for better parsing related CSS/JS scripts.

Run JavaScript Before Extraction

POST

Execute custom JS to modify the page before content extraction. Can be inline code or a URL to a script file.[Learn more](https://developer.mozilla.org/en-US/docs/Web/JavaScript)

Heading Style

Sets markdown heading format (passed to Turndown).

Hash Style

Horizontal Rule Style

Defines markdown horizontal rule format (passed to Turndown).

Bullet Point Style

Sets bullet list marker character (passed to Turndown).

\*

Emphasis Style

Defines markdown emphasis delimiter (passed to Turndown).

\_

Strong Emphasis Style

Sets markdown strong emphasis delimiter (passed to Turndown).

\*\*

Link Style

Determines markdown link format (passed to Turndown).

Inline

EU Residency

Experimental

When enabled, infrastructure and data processing for this request are located within the EU.