Get contents

POST

contents

curl -X POST 'https://api.exa.ai/contents' \
  -H 'Authorization: Bearer YOUR-EXA-API-KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "urls": ["https://arxiv.org/abs/2307.06435"],
    "text": true
  }'

Get your Exa API key

Authorizations

Authorization

string

header

required

API key can be provided either via x-api-key header or Authorization header with Bearer scheme

Body

application/json

urls

string[]

required

Array of URLs to crawl (backwards compatible with 'ids' parameter).

ids

string[]

deprecated

Deprecated - use 'urls' instead. Array of document IDs obtained from searches.

text

If true, returns full page text with default settings. If false, disables text return.

highlights

object

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

summary

object

Summary of the webpage

livecrawl

enum<string>

Options for livecrawling pages. 'never': Disable livecrawling (default for neural search). 'fallback': Livecrawl when cache is empty (default for keyword search). 'always': Always livecrawl. 'auto': Use an LLM to detect if query needs real-time content.

Available options:

never,

fallback,

always,

auto

livecrawlTimeout

integer

default:

10000

The timeout for livecrawling in milliseconds.

subpages

integer

default:

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

subpageTarget

Keyword to find specific subpages of search results. Can be a single string or an array of strings, comma delimited.

extras

object

Extra parameters to pass.

Response

200 - application/json

requestId

string

Unique identifier for the request

results

object[]

results.title

string

The title of the search result.

results.url

string

The URL of the search result.

results.publishedDate

string | null

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

results.author

string | null

If available, the author of the content.

results.score

number | null

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

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.favicon

string

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

results.text

string

The full content text of the search result.

results.highlights

string[]

Array of highlights extracted from the search result content.

results.highlightScores

number[]

Array of cosine similarity scores for each highlighted

results.summary

string

Summary of the webpage

results.subpages

object[]

Array of subpages for the search result.

results.subpages.title

string

The title of the search result.

results.subpages.url

string

The URL of the search result.

results.subpages.publishedDate

string | null

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

results.subpages.author

string | null

If available, the author of the content.

results.subpages.score

number | null

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

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.favicon

string

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

results.subpages.text

string

The full content text of the search result.

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.summary

string

Summary of the webpage

results.subpages.subpages

object[]

Array of subpages for 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.subpages.publishedDate

string | null

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

results.subpages.subpages.author

string | null

If available, the author of the content.

results.subpages.subpages.score

number | null

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

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.favicon

string

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

results.subpages.subpages.text

string

The full content text of the search result.

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.summary

string

Summary of the webpage

results.subpages.subpages.subpages

object[]

Array of subpages for the search result.

results.subpages.subpages.extras

object

Results from extras.

results.subpages.extras

object

Results from extras.

results.extras

object

Results from extras.

costDollars

object

Search Find similar links

curl -X POST 'https://api.exa.ai/contents' \
  -H 'Authorization: Bearer YOUR-EXA-API-KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "urls": ["https://arxiv.org/abs/2307.06435"],
    "text": true
  }'

Getting Started

API Reference

RAG Quick Start Guide

Concepts

Admin

Get contents

Get your Exa API key

Authorizations

Body

Response