Skip to main content
POST

Get your Exa API key

Authorizations

x-api-key
string
header
required

Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .

Body

application/json

Provide either ids or urls, but not both.

ids
string[]
required

Document IDs obtained from searches.

Required array length: 1 - 100 elements
Required string length: 1 - 2048
Example:
urls
string[]

URLs to crawl (backwards compatible with the ids parameter).

Required array length: 1 - 100 elements
Required string length: 1 - 2048
Example:
compliance
enum<string> | null

Enterprise-only compliance mode. Set to hipaa to require HIPAA-safe processing. Requests fail closed or restrict features when the requested behavior requires non-HIPAA-safe processors.

Available options:
hipaa
Example:

"hipaa"

text
default:false

Text extraction options for each result.

highlights
default:false

Text snippets the LLM identifies as most relevant from each page.

summary
object | null

Summary of the webpage.

extras
object | null

Extra parameters to pass.

context
deprecated

Deprecated: Use highlights or text instead. Returns page contents as a combined context string.

Example:

true

livecrawl
enum<string> | null
deprecated

Deprecated: Use maxAgeHours instead for content freshness control. livecrawl does not guarantee freshly fetched parser output and may be served according to server freshness policy. Do not send livecrawl and maxAgeHours together.

Available options:
never,
always,
fallback,
preferred
Example:

"preferred"

livecrawlTimeout
integer | null
default:10000

The timeout for livecrawling in milliseconds.

Required range: 0 < x <= 90000
Example:

1000

maxAgeHours
integer | null

Maximum age of cached content in hours. Positive values use cached content if it is less than this many hours old; 0 fetches fresh content and is the supported way to apply text rendering options to newly fetched pages; -1 always uses cache; omitted uses fallback fetching when cached content is unavailable. Maximum supported value is 720 hours.

Required range: -1 <= x <= 720
Example:

24

subpages
integer | null
default:0

The number of subpages to crawl. The actual number crawled may be limited by system constraints.

Required range: 0 <= x <= 100
Example:

1

subpageTarget

Term to find specific subpages of search results. Can be a single string or an array of strings.

Required string length: 1 - 100
Example:

"sources"

Response

200 - application/json

OK

requestId
string

Unique identifier for the request.

Example:

"b5947044c4b78efa9552a7c89b306d95"

results
object[]
context
string
deprecated

Deprecated. Combined context string from search results. Use highlights or text instead.

statuses
object[]

Status information for each requested URL or document ID.

costDollars
object

Endpoint-dependent estimated dollar cost breakdown for the completed request. Billing is computed from usage counters rather than this response object.