Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
urls
string[]
required

1 to 50 http or https URLs. Your usage tier can lower the maximum. A string that is not an absolute http or https URL does not fail the request: its result has status.type invalid_url.

Required array length: 1 - 50 elements
formats
enum<string>[]

What to return besides metadata, which is always returned for a page with content. highlights requires the highlights object. [] returns metadata only.

Available options:
markdown,
html,
links,
highlights
highlights
object

Highlights settings. Required when formats includes highlights, and allowed only then.

if_modified_since
string

A metadata.last_modified value from an earlier response, in IMF-fixdate form such as Thu, 03 Dec 1992 08:37:20 GMT. Requires exactly one URL and max_age_seconds 0. If the page has not changed since then, its result has status.type not_modified and no content, so keep the content you already have.

max_age_seconds
integer
default:172800

Maximum age of a stored copy to accept, up to 63072000 (two years). 0 always fetches the page live.

Required range: 0 <= x <= 63072000
cache_only
boolean
default:false

When true, answer only from stored copies at most max_age_seconds old and never fetch live. A URL without one has status.type no_content. Requires max_age_seconds above 0.

timeout_ms
integer
default:30000

Fetch time budget for each URL. URLs are fetched in parallel.

Required range: 1000 <= x <= 110000

Response

One document per input URL, in request order

request_id
string
required

The request ID, the same value as the X-Request-Id response header. Include it when you contact support.

results
object[]
required

One result per input URL, in request order.

usage
object
required

The number of billed URLs in this request and their cost at list price.