Skip to main content
GET
Fetch a web page

Authorizations

x-api-key
string
header
required

API key from the API Console.

Query Parameters

url
string<uri>
required

Full http(s) URL of the page to fetch.

format
enum<string>
default:json

Response format: json (structured, default) or context (LLM-ready markdown).

Available options:
json,
context
effort
enum<string>

How thoroughly to retrieve the page: low favors speed, max spends the most time extracting content — useful for pages that are slow to load or render content client-side. Omit for the server's adaptive default. Invalid values return a 400 listing the valid tiers. Fetch failures (422, 503) are never billed, regardless of effort.

Available options:
low,
medium,
high,
max
maxContentLength
integer

Maximum content characters to return (default 200000).

Required range: x >= 1
query
string

Optional query string to scope extraction to. When set, the response includes query_extracts, query_snippet, and query_hash fields scoped to this query.

Response

Extracted page content

url
string
title
string
description
string
content
string

Clean extracted text content

markdown
string

Clean extracted content as markdown, when available.

extracts
string[]

Key passage extracts from the page, when available.

snippet
string

Short excerpt from the page.

author
string
date
string
site_name
string
image
string
lang
string
word_count
integer
truncated
boolean
query_extracts
string[]

Text extracts from the page most relevant to query. Only present when query is set.

query_snippet
string

Short excerpt from the page most relevant to query. Only present when query is set.

query_hash
string

Hash identifying the query used to scope this response. Only present when query is set.

partial
boolean

Whether this is a partial response returned before the page finished retrieving. Only present when true.

retry_after_seconds
integer

Seconds to wait before retrying for the full content. Only present on partial responses.

metrics
object