Skip to main content
POST
Extract page content

Authorizations

Authorization
string
header
required

An API key from the dashboard, sk_live_…, sent as Authorization: Bearer sk_live_….

Body

application/json
urls
string<uri>[]
required

The pages to extract, 1–20 absolute URLs. Providers that take one URL per call are fanned out by Helve.

Required array length: 1 - 20 elements
provider
enum<string>

Which provider fetches and cleans the pages. auto (default) picks the first configured provider in Helve's priority order. Brave and Perplexity have no extraction product.

Available options:
exa,
tavily,
parallel,
serper,
firecrawl,
linkup,
valyu,
jina,
octen,
auto
query
string

What you are extracting for. Drives focused excerpts and summaries on providers that support them (Exa, Tavily, Parallel, Firecrawl, Valyu).

Minimum string length: 1
content
object

What to return for each URL.

Return the page's outbound links in links. Native on Exa.

include_images
boolean

Return the page's image URLs in images. Native on Exa and Tavily.

max_age_hours
integer

Accept a cached copy up to this many hours old; 0 forces a live fetch. Native on Exa.

Required range: 0 <= x <= 720
timeout_ms
integer

Per-page fetch timeout in milliseconds, 1000–90000. Native on Exa and Tavily.

Required range: 1000 <= x <= 90000
strict
boolean

When true, any parameter the serving provider cannot honour is a 400 instead of a warning. Default false.

provider_options
object

Escape hatch for provider-native parameters, keyed by provider id and merged into that provider's request unchanged.

Response

Extracted content

id
string
required

Helve's id for this extraction, ext_….

provider
enum<string>
required

The provider that served the request, resolved from auto.

Available options:
exa,
tavily,
parallel,
serper,
firecrawl,
linkup,
valyu,
jina,
octen
results
object[]
required

One entry per successfully extracted URL.

failed
object[]
required

URLs the provider could not fetch, with its reason. Partial success is a 200.

warnings
object[]
required

How the request was adjusted for the serving provider. Empty when it was honoured exactly.

usage
object
required
latency_ms
number
required

Wall-clock time Helve spent on the request.