Skip to main content

Exa full reference

This is the full reference documentation for the Exa agent connector.

Supported entities and actions

The Exa connector supports the following entities and actions.

EntityActions
Search ResultsList
ContentsList
Similar ResultsList

Search Results

Search Results List

Perform a search with an Exa prompt-engineered query and retrieve a list of relevant results. Optionally request contents (text, highlights, summary) inline with the search results. Supports filtering by domain, date, category, and number of results.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "exa",
"entity": "search_results",
"action": "list",
"params": {
"query": "<str>"
}
}'

Python SDK

await exa.search_results.list(
query="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "search_results",
"action": "list",
"params": {
"query": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
querystringYesThe search query string.
type"auto" | "instant" | "fast" | "deep-lite" | "deep" | "deep-reasoning"NoThe type of search. auto intelligently selects the best mode, instant provides lowest latency, fast uses lower-latency models, deep-lite provides lightweight synthesis, deep performs in-depth research with synthesis, and deep-reasoning adds more reasoning for complex searches.
category"company" | "research paper" | "news" | "personal site" | "financial report" | "people"NoA data category to focus on for improved result quality.
numResultsintegerNoNumber of results to return (max 100).
includeDomainsarray<string>NoList of domains to include. If specified, results will only come from these domains.
excludeDomainsarray<string>NoList of domains to exclude. If specified, no results will be returned from these domains.
startPublishedDatestringNoOnly return links published after this date. ISO 8601 format.
endPublishedDatestringNoOnly return links published before this date. ISO 8601 format.
startCrawlDatestringNoOnly return links crawled by Exa after this date. ISO 8601 format.
endCrawlDatestringNoOnly return links crawled by Exa before this date. ISO 8601 format.
contentsobjectNoOptions for requesting page contents inline with search results.
contents.textboolean | objectNoText extraction options. Pass true for defaults or an object for advanced options.
contents.highlightsboolean | objectNoHighlight extraction options. Pass true for defaults or an object for advanced options.
contents.summaryobjectNoSummary generation options.
contents.summary.querystringNoCustom query for the LLM-generated summary.
moderationbooleanNoEnable content moderation to filter unsafe content.
Response Schema

Records

Field NameTypeDescription
titlestring
urlstring
idstring
publishedDatestring
authorstring | null
imagestring
faviconstring
textstring
highlightsarray<string>
highlightScoresarray<number>
summarystring
scorenumber

Contents

Contents List

Get the full page contents, summaries, and metadata for a list of URLs. Returns instant results from Exa's cache, with automatic live crawling as fallback for uncached pages. Use this to retrieve text, highlights, and summaries for specific URLs.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "exa",
"entity": "contents",
"action": "list",
"params": {
"urls": []
}
}'

Python SDK

await exa.contents.list(
urls=[]
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "contents",
"action": "list",
"params": {
"urls": []
}
}'

Parameters

Parameter NameTypeRequiredDescription
urlsarray<string>YesArray of URLs to retrieve contents for.
textboolean | objectNoText extraction options. Pass true for defaults or an object for advanced options.
highlightsboolean | objectNoHighlight extraction options. Pass true for defaults or an object for advanced options.
summaryobjectNoSummary generation options.
summary.querystringNoCustom query for the LLM-generated summary.
Response Schema

Records

Field NameTypeDescription
titlestring
urlstring
idstring
publishedDatestring
authorstring | null
imagestring
faviconstring
textstring
highlightsarray<string>
highlightScoresarray<number>
summarystring
scorenumber

Similar Results

Similar Results List

Find web pages similar to a given URL. Uses Exa's embeddings to find semantically similar content. Supports filtering by domains and dates.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "exa",
"entity": "similar_results",
"action": "list",
"params": {
"url": "<str>"
}
}'

Python SDK

await exa.similar_results.list(
url="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "similar_results",
"action": "list",
"params": {
"url": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
urlstringYesThe URL to find similar pages for.
numResultsintegerNoNumber of similar results to return (max 100).
includeDomainsarray<string>NoList of domains to include. If specified, results will only come from these domains.
excludeDomainsarray<string>NoList of domains to exclude. If specified, no results will be returned from these domains.
startPublishedDatestringNoOnly return links published after this date. ISO 8601 format.
endPublishedDatestringNoOnly return links published before this date. ISO 8601 format.
startCrawlDatestringNoOnly return links crawled by Exa after this date. ISO 8601 format.
endCrawlDatestringNoOnly return links crawled by Exa before this date. ISO 8601 format.
contentsobjectNoOptions for requesting page contents inline with similar page results.
contents.textboolean | objectNoText extraction options. Pass true for defaults or an object for advanced options.
contents.highlightsboolean | objectNoHighlight extraction options. Pass true for defaults or an object for advanced options.
contents.summaryobjectNoSummary generation options.
contents.summary.querystringNoCustom query for the LLM-generated summary.
Response Schema

Records

Field NameTypeDescription
titlestring
urlstring
idstring
publishedDatestring
authorstring | null
imagestring
faviconstring
textstring
highlightsarray<string>
highlightScoresarray<number>
summarystring
scorenumber