Skip to main content
POST
Python

Authorizations

x-api-key
string
header
required

Headers

parallel-beta
string | null
deprecated

Body

application/json

Extract request.

urls
string[]
required
objective
string | null

If provided, focuses extracted content on the specified search objective.

search_queries
string[] | null

If provided, focuses extracted content on the specified keyword search queries.

fetch_policy
FetchPolicy · object | null

Fetch policy: determines when to return cached content from the index (faster) vs fetching live content (fresher). Default is to use a dynamic policy based on the search objective and url.

excerpts
default:true

Include excerpts from each URL relevant to the search objective and queries. Note that if neither objective nor search_queries is provided, excerpts are redundant with full content.

full_content
default:false

Include full content from each URL. Note that if neither objective nor search_queries is provided, excerpts are redundant with full content.

session_id
string | null

Session identifier to track calls across separate search and extract calls, to be used as part of a larger task. Specifying it may give better contextual results for subsequent API calls.

Maximum string length: 1000
client_model
string | null

The model generating this request and consuming the results. Enables optimizations and tailors default settings for the model's capabilities.

Example:

"claude-opus-4-7"

Response

Successful Response

Fetch result.

extract_id
string
required

Extract request ID, e.g. extract_cad0a6d2dec046bd95ae900527d880e7

results
ExtractResult · object[]
required

Successful extract results.

errors
ExtractError · object[]
required

Extract errors: requested URLs not in the results.

warnings
Warning · object[] | null

Warnings for the extract request, if any.

usage
UsageItem · object[] | null

Usage metrics for the extract request.