Get contents

Get your Exa API key

Authorizations

x-api-key

string

header

required

Body

application/json

ids

string[]

required

Array of document IDs obtained from searches

extras

object

Extra parameters to pass.

highlights

object

Relevant extract(s) from the webpage.

livecrawl

enum<string>

Options for livecrawling contents. Default is "never" for neural/auto search, "fallback" for keyword search.

Available options:

never,

fallback,

always

livecrawlTimeout

integer

The timeout for livecrawling in milliseconds. Max and default is 10000.

subpages

integer

The number of subpages to crawl.

subpageTarget

The target subpage or subpages. Can be a single string or an array of strings.

summary

object

Summary of the webpage

text

object

Parsed contents of the page.

Response

200 - application/json

results

object[]

results.author

string | null

If available, the author of the content.

results.extras

object

Results from extras.

results.favicon

string

The URL of the favicon for the search result's domain.

results.highlights

string[]

Array of highlights extracted from the search result content.

results.highlightScores

number[]

Array of cosine similarity scores for each highlighted

results.id

string

The temporary ID for the document. Useful for /contents endpoint.

results.image

string

The URL of an image associated with the search result, if available.

results.publishedDate

string | null

An estimate of the creation date, from parsing HTML content. Format is YYYY-MM-DD.

results.score

number | null

A number from 0 to 1 representing similarity between the query/url and the result.

results.subpages

object[]

Array of subpages for the search result.

results.subpages.author

string | null

If available, the author of the content.

results.subpages.extras

object

Results from extras.

results.subpages.favicon

string

The URL of the favicon for the search result's domain.

results.subpages.highlights

string[]

Array of highlights extracted from the search result content.

results.subpages.highlightScores

number[]

Array of cosine similarity scores for each highlighted

results.subpages.id

string

The temporary ID for the document. Useful for /contents endpoint.

results.subpages.image

string

The URL of an image associated with the search result, if available.

results.subpages.publishedDate

string | null

An estimate of the creation date, from parsing HTML content. Format is YYYY-MM-DD.

results.subpages.score

number | null

A number from 0 to 1 representing similarity between the query/url and the result.

results.subpages.subpages

object[]

Array of subpages for the search result.

results.subpages.subpages.author

string | null

If available, the author of the content.

results.subpages.subpages.extras

object

Results from extras.

results.subpages.subpages.favicon

string

The URL of the favicon for the search result's domain.

results.subpages.subpages.highlights

string[]

Array of highlights extracted from the search result content.

results.subpages.subpages.highlightScores

number[]

Array of cosine similarity scores for each highlighted

results.subpages.subpages.id

string

The temporary ID for the document. Useful for /contents endpoint.

results.subpages.subpages.image

string

The URL of an image associated with the search result, if available.

results.subpages.subpages.publishedDate

string | null

An estimate of the creation date, from parsing HTML content. Format is YYYY-MM-DD.

results.subpages.subpages.score

number | null

A number from 0 to 1 representing similarity between the query/url and the result.

results.subpages.subpages.subpages

object[]

Array of subpages for the search result.

results.subpages.subpages.summary

string

Summary of the webpage

results.subpages.subpages.text

string

The full content text of the search result.

results.subpages.subpages.title

string

The title of the search result.

results.subpages.subpages.url

string

The URL of the search result.

results.subpages.summary

string

Summary of the webpage

results.subpages.text

string

The full content text of the search result.

results.subpages.title

string

The title of the search result.

results.subpages.url

string

The URL of the search result.

results.summary

string

Summary of the webpage

results.text

string

The full content text of the search result.

results.title

string

The title of the search result.

results.url

string

The URL of the search result.

Getting Started

API Reference

RAG Quick Start Guide

Concepts

Admin

Get contents

Get your Exa API key

Authorizations

Body

Response