Skip to main content
Exa logo
  • Category: web search & research
  • Auth: API_KEY, BEARER_TOKEN
  • Composio-managed OAuth available? N/A
  • Tools: 65
  • Triggers: 0
  • Slug: EXA
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: EXA_ANSWERGenerates a direct, citation-backed answer to a clear natural language question or topic using Exa’s search, adept at both specific answers and detailed summaries for open-ended queries. Response contains an answer field (summary) and a citations field (supporting URLs). Citations may include low-credibility sources; verify authoritative references for factual use.Instant: Supported on the latest version.Instant pricing: $0.005 per answer

Input Parameters

boolean
Set to true to include the full text content of the cited source documents in the citations part of the response. Defaults to false.
string ("exa" | "exa-pro")
Specifies the search model to use. ‘exa’ uses a single, direct query. ‘exa-pro’ uses two expanded queries for potentially more comprehensive results. Allowed values are ‘exa’ or ‘exa-pro’. Defaults to ‘exa’.
string
required
The natural language question or search query for which an answer is sought. The query should be specific enough to guide the search effectively. Include concrete entities, dates, locations, or jurisdictions to avoid ambiguous results. For time-sensitive data, include explicit time framing (e.g., ‘as of 2024’) since results may reflect stale information.
boolean
Set to true to receive the response as a stream of server-sent events (SSE). This is useful for displaying results incrementally. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_BATCH_SEARCH_MONITORSDelete, pause, or unpause one batch of matching Search API monitors, not Websets monitors. Defaults to dry_run=true: previews matches without changes. Set dry_run=false explicitly to apply the action; deletion is permanent and cannot be undone. When has_more is true, repeat the request until has_more is false to process all matches. Dry-run previews do not consume matches, so repeating a preview does not advance the batch. Does not automatically process further batches.

Input Parameters

integer
Maximum monitors processed in this batch (1-500).
string ("delete" | "pause" | "unpause")
required
Delete permanently, pause, or unpause (activate) matching monitors.
object
required
At least one filter field is required to prevent accidental bulk operations.
boolean
Preview affected monitors without changing them. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CANCEL_AGENT_RUNCancel a queued or running Agent run immediately without returning results. Usage accrued before cancellation is still billed. If the run is already terminal, Exa returns the existing run unchanged.

Input Parameters

string
required
Agent run ID to cancel. New IDs use the agent_run_ prefix. Only letters, digits, underscores, and hyphens are allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CANCEL_WEBSETCancel all operations on a Webset, stopping searches and enrichments. The Webset is marked idle; this does not delete the Webset.

Input Parameters

string
required
ID or externalId of the Webset to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CANCEL_WEBSET_ENRICHMENTCancel a running Webset enrichment and return its updated state. All running work for the specified enrichment is canceled. A canceled enrichment cannot be resumed.

Input Parameters

string
required
ID of the enrichment to cancel.
string
required
ID or externalId of the Webset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CANCEL_WEBSET_SEARCHCancel a running search in a Webset and return its updated state. Cancels only the specified search, not all searches in the Webset.

Input Parameters

string
required
ID of the running search to cancel.
string
required
ID or externalId of the Webset containing the search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CREATE_AGENT_RUNStart an asynchronous Exa Agent run for multi-step web research or enrichment. Save the returned ID and poll Get Agent Run until the run reaches a terminal status.

Input Parameters

object
Known data rows to process and records or entities to exclude.
string
required
Natural-language research, list-building, or enrichment instructions.
object
Optional spending and duration limits for metered auto or ultra effort.
string ("minimal" | "low" | "medium" | "high" | "xhigh" | "auto" | "ultra")
Cost and reasoning effort for the run.
object
Caller-defined string metadata stored with the run.
array
Up to five Exa Connect data providers to enable.
object
JSON Schema for validated structured output.
string
Additional guidance such as source preferences or deduplication rules.
string
Completed Agent run ID to use as context for a follow-up run.
string
Opaque non-personal end-user ID for usage attribution. Never send names, emails, or phone numbers; retained even under Zero Data Retention.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CREATE_API_KEYCreate an API key for the authenticated Exa team. Requires Team Management enabled for the team (contact support@exa.ai) and a service API key, not an ordinary search key. Treat the returned key record as sensitive; never log credentials. Creating keys is not idempotent.

Input Parameters

string
Optional name for the API key.
integer
Optional rate limit in requests per second, within the team’s limit.
integer
Optional budget in cents for the current billing period; resets next period. Null removes the budget.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CREATE_IMPORTTool to create a new import to upload data into a Webset. Use when you need to initialize an import before uploading the data file.

Input Parameters

object
CSV-specific settings for the import.
integer
Size of the import in bytes.
integer
Number of items in the import.
string
Title of the import.
object
required
Entity information for the import.
string
required
Format of the import file (e.g., ‘csv’).
object
Additional metadata for the import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CREATE_MONITORTool to create a new Monitor. Use when you need to schedule automated updates for a Webset without manual runs.

Input Parameters

object
required
How often the monitor will run.
object
required
Behavior to perform when monitor runs.
object
Key-value pairs to associate with the Monitor.
string
required
The ID of the Webset to attach this Monitor to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CREATE_SEARCH_MONITORCreate a Search API monitor that delivers new, deduplicated search results to a webhook. Omit trigger for manual runs only. Save webhookSecret securely: it is returned only at creation. Not a Websets monitor.

Input Parameters

string
Optional monitor display name.
Search executed by this monitor.
object
Optional schedule; omit for manual runs only.
object
required
Destination for monitor events.
object
Caller metadata echoed in webhook deliveries.
string
Synthesis format, or null; defaults to text when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CREATE_WEBHOOKCreate a webhook delivering selected events to your URL. Store the signing secret securely: it is returned only on creation, not on later retrievals.

Input Parameters

string
required
Destination URI for webhook deliveries.
array
required
Events that trigger the webhook.
object
Optional string key-value pairs associated with the webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CREATE_WEBSETTool to create a new Webset with search, import, and enrichment setup. Use when you need to configure and seed a Webset in one call.

Input Parameters

array
Import data from existing Websets or Imports.
object
required
Initial search configuration for the Webset.
object
Arbitrary key-value pairs to associate with this Webset.
string
External identifier to reference the Webset in your system.
array
Enrichments to apply to Webset items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CREATE_WEBSET_ENRICHMENTCreate an enrichment task for items in an existing Webset. Returns the enrichment’s current state; creation does not imply completion.

Input Parameters

string ("text" | "date" | "number" | "options" | "email" | "phone" | "url")
Response format; omit to let Exa select it from the description.
string
required
ID or externalId of the Webset to enrich.
array
Choices for the enrichment agent when format is options.
object
Caller-supplied string key-value metadata.
string
required
Enrichment task to perform for each Webset item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_CREATE_WEBSET_SEARCHCreate a search for an existing Webset and return its initial state. Searches run asynchronously. By default, existing results are reused and evaluated against the new criteria; override replaces items, append adds items.

Input Parameters

number
required
Number of items to attempt to find; actual results may be fewer.
string
required
Natural-language search requirements. URLs are crawled as additional context.
array
Sources to limit the search to, optionally with related-entity searches.
string
Entity to find; detected from the query when omitted.
boolean
Whether to estimate the total number of relevant results.
string
required
ID or externalId of the Webset to search within.
array
Imports or Websets whose items are excluded from this search.
string ("override" | "append")
Replace existing items (override) or add to existing items (append).
array
One to five evaluation criteria; generated from the query when omitted.
object
Caller-supplied string metadata attached to this search.
integer
Soft cap on matching people per current employer for people searches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_DELETE_AGENT_RUNDelete a stored Exa Agent run by ID and return its deletion receipt.

Input Parameters

string
required
ID of the stored Agent run to delete, usually prefixed with agent_run_. Only letters, digits, underscores, and hyphens are allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_DELETE_API_KEYDelete an API key belonging to the authenticated team using a Team Management service key. Never delete the key authenticating the current connection. Use only a disposable key for testing; deletion revokes the target key’s access.

Input Parameters

string
required
ID of the API key to delete. Never delete the key authenticating the current connection; use a disposable key for testing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_DELETE_IMPORTTool to delete an existing import. Use when you need to permanently remove an import by its ID.

Input Parameters

string
required
The ID of the import to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_DELETE_SEARCH_MONITORPermanently delete a Search API monitor and return the deleted monitor. This cannot be undone. Not a Websets monitor.

Input Parameters

string
required
ID of the Search API monitor to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_DELETE_WEBHOOKDelete a webhook, making its status inactive and stopping future deliveries to its URL. Returns the webhook’s updated state.

Input Parameters

string
required
ID of the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_DELETE_WEBSETTool to delete a Webset. Use after confirming the Webset ID to permanently remove the Webset and all its items.

Input Parameters

string
required
The id or externalId of the Webset to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_DELETE_WEBSET_ENRICHMENTDelete a Webset enrichment and return the deleted enrichment. Cancels running enrichments and makes all results generated by this enrichment unavailable.

Input Parameters

string
required
ID of the enrichment to delete.
string
required
ID or external ID of the parent Webset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_DELETE_WEBSET_ITEMDelete an item from a Webset and return the deleted item. Cancels any enrichment process for the item.

Input Parameters

string
required
ID of the Webset item to delete.
string
required
ID or externalId of the parent Webset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_DELETE_WEBSETS_MONITORDelete a Websets monitor and return the deleted monitor. Uses the Websets API, not the separate Search /monitors API.

Input Parameters

string
required
ID of the Websets monitor to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_FIND_SIMILARFind web pages related to a supplied URL using an Exa Search query, with a choice of result count and optional page text or highlights. Search ranking differs from the legacy embedding-similarity ranking. DEPRECATED: This action now uses Search instead of the deprecated Find Similar endpoint; prefer EXA_SEARCH for new code.

Input Parameters

string
required
The URL for which to find semantically similar web pages. This must be a valid and accessible web address. Must be fully qualified (include scheme and domain); do not pass partial paths, redirect stubs, or snippet text. Specific, content-rich URLs yield more diverse results than generic landing pages.
boolean
Set to true to request the full text content of each similar page. Defaults to false. Combining text=true with large num_results produces very large payloads; prefer highlights or summary when processing size is constrained.
boolean
Set to true to request a generated summary for each similar page. Defaults to false.
boolean
Set to true to request relevant text snippets (highlights) from each similar page. Defaults to false.
integer
The desired number of similar web pages to return. Must be an integer between 1 and 100, inclusive. Defaults to 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_AGENT_RUNRetrieve an Agent run to inspect its status, output, citations, usage, or cost.

Input Parameters

string
required
Agent run ID returned by Create Agent Run. New run IDs use the agent_run_ prefix and may contain only letters, digits, underscores, and hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_API_KEYTool to retrieve details of a specific API key by its ID. Use when you need to fetch information about an API key in the team management context.

Input Parameters

string
required
The unique identifier of the API key to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_API_KEY_USAGEGet an Exa API key’s total cost and cost breakdown for a time period. Requires Team Management enabled for the team (contact support@exa.ai) and a service API key, not an ordinary search key. Defaults to the last 30 days.

Input Parameters

string
required
Unique identifier of the API key.
string
ISO 8601 usage-period end. Defaults to the current time.
string ("hour" | "day" | "month")
Accepted by Exa but has no effect on the response.
string
ISO 8601 usage-period start. Defaults to 30 days ago; must be within the last 180 days and before end_date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_CONTENTS_ACTIONRetrieve text / highlights / summary / subpages from URLs. The endpoint returns HTTP 200 even when individual URLs fail — always inspect statuses[] for CRAWL_NOT_FOUND, CRAWL_LIVECRAWL_TIMEOUT, SOURCE_NOT_AVAILABLE. Control freshness with maxAgeHours (0 = always livecrawl, -1 = cache only). Use subpages + subpageTarget to crawl linked pages within a site in one request.Instant: Supported on the latest version.Instant pricing: $0.001 per page per content type

Input Parameters

array
(Deprecated alias for ‘urls’) A list of document IDs or URLs. Use ‘urls’ parameter instead for consistency with the Exa API.
string
Controls text extraction. Accepts a boolean or a TextOptions object. If True (the default for this tool), sends Exa’s documented text=true mode and extracts full-page text using default settings. If False or None, no text is extracted. Provide a TextOptions object to customize text extraction (e.g., max_characters, include_html_tags, verbosity).
array
A list of fully qualified URLs (e.g., ‘https://example.com/article’) or document IDs (strings obtained from Exa search results) for which to retrieve content. At least one URL or ID must be provided.
object
Configuration for extracting additional metadata from documents.
string
Controls AI-generated summary extraction. Accepts a boolean or SummaryOptions. If True, generates a summary; if False or None, no summary. Use SummaryOptions for custom settings (e.g., query, schema).
integer
Number of subpages to crawl per URL. Enables crawling linked pages within a site in one request. Defaults to 0 (no subpage crawling).
string
Controls highlight extraction. Accepts a boolean or HighlightOptions. If True, extracts AI highlights (default settings); if False or None, no highlights. Use HighlightOptions for custom settings (e.g., query, max_characters).
integer
Controls content freshness. 0 = always livecrawl, -1 = never livecrawl (cache only), None or positive integer = livecrawl as fallback if cached content is older than specified hours.
string
Keywords to prioritize for subpage selection when crawling subpages. Can be a single string or list of strings. Only relevant when subpages > 0.
integer
Timeout in milliseconds for livecrawl operations. Recommended: 10000-15000 when forcing livecrawl. Defaults to 10000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_EVENTTool to get details of a specific event by its ID. Use when you have an event ID and need its full details.

Input Parameters

string
required
The unique identifier of the event to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_IMPORTRetrieve an import by ID to inspect its status, entity count, and failure details.

Input Parameters

string
required
ID of the import to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_SEARCH_MONITORRetrieve a Search API monitor’s configuration, status, and next scheduled run by ID. Not a Websets monitor.

Input Parameters

string
required
ID of the Search API monitor to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_SEARCH_MONITOR_RUNRetrieve a Search API monitor run’s status and full output when completed. Not a Websets monitor run.

Input Parameters

string
required
ID of the parent Search API monitor.
string
required
ID of the run to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_WEBHOOKRetrieve a webhook’s status, events, destination URL, and metadata by ID. The signing secret is not returned; it is available only on creation.

Input Parameters

string
required
ID of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_WEBSETRetrieve a Webset by ID or external ID, including its status and operations. Set expand to [“items”] to include up to the first 100 items. This does not retrieve additional item pages.

Input Parameters

string
required
Webset ID or external ID.
array
Include items to return up to the first 100 Webset items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_WEBSET_ENRICHMENTRetrieve an enrichment configured on a Webset, including its status, description, format, and options.

Input Parameters

string
required
ID of the enrichment to retrieve.
string
required
ID or external ID of the Webset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_WEBSET_ITEMRetrieve a Webset item by ID, including its properties, evaluations, and enrichments.

Input Parameters

string
required
ID of the Webset item to retrieve.
string
required
ID or externalId of the Webset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_WEBSET_SEARCHRetrieve a Webset search by ID to inspect its status, progress, and recall metrics.

Input Parameters

string
required
ID of the search to retrieve.
string
required
ID or externalId of the Webset containing the search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_WEBSETS_MONITORRetrieve a Websets monitor’s status, schedule, search behavior, and last run. Uses the Websets API, not the separate Search /monitors API.

Input Parameters

string
required
ID of the Websets monitor to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_WEBSETS_MONITOR_RUNRetrieve a Websets monitor run’s status, type, timestamps, and failure reason. Uses the Websets API, not the separate Search /monitors API.

Input Parameters

string
required
ID of the Websets monitor run to retrieve.
string
required
ID of the Websets monitor owning the run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_GET_WEBSETS_TEAM_INFOGet the authenticated Websets team’s identity, current concurrency usage, and limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_AGENT_RUN_EVENTSList one page of stored Exa Agent run events as JSON, with cursor pagination. The response accepts only the five lifecycle event types; a page containing other event types fails validation.

Input Parameters

integer
Number of events per page, from 1 to 100.
string
required
Agent run ID returned when creating a run. Only letters, digits, underscores, and hyphens are allowed.
string
Pagination cursor from the previous event list’s nextCursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_AGENT_RUNSList one page of your team’s Exa Agent runs, ordered newest to oldest. Pass the returned nextCursor as cursor to retrieve the next page when hasMore is true. This action does not automatically paginate.

Input Parameters

integer
Number of Agent runs per page, from 1 to 100.
string
Pagination cursor: use nextCursor from the previous list response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_API_KEYSList the authenticated Exa team’s API keys, or retrieve one by API key ID. Requires Team Management enabled for the team (contact support@exa.ai) and a service API key, not an ordinary search key. Returns apiKeys without a filter or apiKey with api_key_id; the endpoint has no documented pagination. Treat returned key records as sensitive; never log credentials.

Input Parameters

string
Optional API key ID to retrieve a specific key instead of all keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_EVENTSTool to list all events that have occurred in the system. Use when you need to paginate through the event history.

Input Parameters

integer
The number of results to return (1–200, default 25).
array
Filter events by one or more event types.
string
The cursor to paginate through the results.
string
Filter events created at or after this UTC timestamp (inclusive). Must be a valid ISO 8601 datetime string.
string
Filter events created at or before this UTC timestamp (inclusive). Must be a valid ISO 8601 datetime string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_IMPORTSList Websets imports with cursor-based pagination to inspect import jobs.

Input Parameters

integer
The number of results to return (1–200, default 25).
string
The cursor to paginate through the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_SEARCH_MONITOR_RUNSList one page of a Search API monitor’s runs, newest first, including status and output. Not for Websets monitors. When hasMore is true, pass nextCursor as cursor to retrieve the next page. Does not automatically paginate.

Input Parameters

string
required
The Search API monitor ID, not a Websets monitor ID.
integer
Number of runs per page (1-100); defaults to 50.
string
nextCursor from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_SEARCH_MONITORSList one page of the authenticated team’s Search API monitors, not Websets monitors. Filter by status, name, or metadata. When hasMore is true, pass nextCursor as cursor to fetch another page. Does not automatically paginate.

Input Parameters

string
Case-insensitive substring filter on monitor name.
integer
Number of monitors per page (1-100).
string
nextCursor from the preceding page.
string ("active" | "paused" | "disabled")
Filter by monitor status.
object
Exact-match metadata filters; all supplied pairs must match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_WEBHOOK_ATTEMPTSList one page of a webhook’s delivery attempts in descending order. Filter by event type or success status and pass nextCursor as cursor to retrieve another page. Does not automatically paginate.

Input Parameters

string
required
ID of the webhook whose attempts to list.
integer
Number of results per page.
string
Pagination cursor from a previous page.
string ("webset.created" | "webset.deleted" | "webset.paused" | "webset.idle" | "webset.search.created" | "webset.search.canceled" | "webset.search.completed" | "webset.search.updated" | "import.created" | "import.completed" | "webset.item.created" | "webset.item.enriched" | "monitor.created" | "monitor.updated" | "monitor.deleted" | "monitor.run.created" | "monitor.run.completed" | "webset.export.created" | "webset.export.completed")
Filter attempts by event type.
boolean
Filter attempts by success status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_WEBHOOKSTool to list all webhooks for Websets. Use when you need to view existing webhooks and paginate through results.

Input Parameters

integer
Number of results to return per page.
string
Pagination cursor returned by a previous call. Must be at least 1 character if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_WEBSET_ITEMSList one page of a Webset’s items, optionally filtered by source ID. Pass nextCursor as cursor when hasMore is true. Does not automatically paginate.

Input Parameters

integer
Number of items to return, from 1 to 100; defaults to 20.
string
Pagination cursor from the previous response.
string
required
ID or externalId of the Webset.
string
Filter items by source ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_WEBSETSList one page of Websets, optionally filtered by ID, external ID, or title. When hasMore is true, pass nextCursor as cursor to retrieve the next page. This action does not automatically paginate.

Input Parameters

number
Number of Websets to return, from 1 to 100 (default 25).
string
Pagination cursor from the previous response’s nextCursor.
string
Filter Websets by ID, external ID, or title.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_WEBSETS_MONITOR_RUNSList one page of runs for a Websets monitor, including status and timestamps. Uses /websets/v0/monitors/{monitor}/runs, not Search API monitors. Returns hasMore and nextCursor without automatic pagination; the provider documents no pagination request parameters for this operation.

Input Parameters

string
required
ID of the Websets monitor to list runs for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_LIST_WEBSETS_MONITORSList one page of Websets monitors, optionally filtered by Webset ID. Uses /websets/v0/monitors, not the Search API’s /monitors endpoint. Pass nextCursor as cursor when hasMore is true; no automatic pagination.

Input Parameters

integer
Number of monitors to return (1-200, default 25).
string
Pagination cursor from the previous nextCursor.
string
Filter monitors by the ID of their Webset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_PREVIEW_WEBSETPreview how Exa interprets a search before creating a Webset. Returns the detected entity, criteria, and suggested enrichments without creating a Webset. Set search_preview to also search for up to ten preview items.

Input Parameters

object
required
Search to interpret.
boolean
Whether to search for preview items; sent as the search query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_SEARCHSearch the web for ranked results with optional per-result text, highlights, or summaries. Managed-key calls allow only auto search, up to 10 results, and no contents; domain filters are mutually exclusive, and company and people searches drop date and domain filters and report their removal.Instant: Supported on the latest version.Instant pricing: $0.007 per search

Input Parameters

string ("auto" | "fast" | "instant" | "deep-lite" | "deep" | "deep-reasoning")
Types of search available in Exa.
string
required
The search query string.
string ("company" | "people" | "research paper" | "news" | "personal site" | "financial report")
Data categories for focused search in Exa.
object
Options for per-result content retrieval, saving a separate /contents round-trip.
string
Enterprise-only compliance mode. Currently only ‘hipaa’.
boolean
Enable content moderation to filter unsafe content.
integer
Desired number of search results. Must be between 1 and 100 (inclusive). Defaults to 10. No pagination is available; larger values increase latency without guaranteeing better coverage. On Composio Instant (managed key) the maximum is 10.
array
A list containing exactly one phrase (up to 5 words) that must NOT be present in the webpage text. Only one phrase is allowed per request. Example: [‘outdated information’] (correct) vs [‘outdated’, ‘wrong’] (incorrect - API will reject multiple phrases).
array
A list containing exactly one phrase (up to 5 words) that must be present in the webpage text. Only one phrase is allowed per request. Example: [‘machine learning applications’] (correct) vs [‘machine’, ‘learning’] (incorrect - API will reject multiple phrases).
object
Flexible model for JSON schema objects.
string
Instructions guiding synthesized output / search planning for deep variants.
string
Two-letter ISO country code of the user (e.g., ‘US’).
array
MUTUALLY EXCLUSIVE WITH includeDomains - provide ONLY ONE of includeDomains or excludeDomains, never both. A list of domain names to specifically exclude from the search results (max 1200). Must be valid domain names containing at least one dot (e.g., ‘example.com’, ‘www.example.com’ are valid). Supports subdomain wildcards (e.g., ‘*.amazon.com’) and path filtering (e.g., ‘example.com/path’). Must be without protocol (e.g., ‘example.com’ not ‘https://example.com’) and without angle brackets.
array
MUTUALLY EXCLUSIVE WITH excludeDomains - provide ONLY ONE of includeDomains or excludeDomains, never both. A list of domain names to specifically include in the search results (max 1200). Must be valid domain names containing at least one dot (e.g., ‘example.com’, ‘www.example.com’ are valid). Supports subdomain wildcards (e.g., ‘*.substack.com’) and path filtering (e.g., ‘example.com/blog’). Must be without protocol (e.g., ‘example.com’ not ‘https://example.com’) and without angle brackets.
string
Filters results to include only those published before this ISO 8601 date. NOTE: This filter is NOT supported when category=‘company’ and will be ignored.
array
Extra query variations for deep-search variants only.
string
Filters results to include only those published after this ISO 8601 date. NOTE: This filter is NOT supported when category=‘company’ and will be ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_STOP_AGENT_RUNComplete a running ultra-effort Agent run early and return results gathered so far. Usage accrued before stopping is billed. Only ultra-effort runs support stopping; an already-terminal run is returned unchanged.

Input Parameters

string
required
Agent run ID returned by Create Agent Run. New IDs use the agent_run_ prefix. Only letters, digits, underscores, and hyphens are allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_TRIGGER_SEARCH_MONITORTrigger an immediate Search API monitor run regardless of its schedule. Works for active or paused monitors. Returns whether triggering succeeded, not the run or its results. Not a Websets monitor.

Input Parameters

string
required
Search API monitor ID, not a Websets monitor ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_UPDATE_API_KEYUpdate an API key’s name, rate limit, or billing-period spending budget. Requires Team Management enabled for the team (contact support@exa.ai) and a service API key, not an ordinary search key. Only keys belonging to the authenticated team can be updated. Omitted fields remain unchanged; pass budgetCents=null to remove the spending budget.

Input Parameters

string
required
Identifier of the API key to update.
string
Optional new API key name.
integer
Optional new rate limit in requests per second.
integer
New budget in cents for the team’s current billing period; resets next period. Explicit null removes the budget; omission leaves it unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_UPDATE_IMPORTTool to update an import configuration by ID. Use when you need to modify an import’s title or metadata.

Input Parameters

string
required
The ID of the import to update.
string
New title for the import. Leave null if unchanged.
object
Key-value pairs to attach to the import. Leave null if unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_UPDATE_SEARCH_MONITORUpdate a Search API monitor’s settings, pause or resume it, or remove its schedule with trigger=null. Only supplied fields change; search and webhook accept partial objects. Not a Websets monitor.

Input Parameters

string
required
Identifier of the Search API monitor to update.
string
Monitor name; null clears it.
object
Partial search parameters to merge; omit unchanged fields.
string ("active" | "paused")
Set the monitor to active or paused.
object
Partial schedule update; null removes the schedule.
object
Partial webhook parameters to merge.
object
Caller metadata; null removes it.
string
Synthesis output schema, or null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_UPDATE_WEBHOOKUpdate a webhook’s destination URL, subscribed events, or metadata. Omitted fields are left unchanged. The signing secret is not returned.

Input Parameters

string
required
Identifier of the webhook to update.
string
Replacement destination URI. Omit to leave unchanged; cannot be null.
array
Replacement subscribed events. Omit to leave unchanged; cannot be null.
object
Replacement string metadata. Omit to leave unchanged; cannot be null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_UPDATE_WEBSETUpdate a Webset’s title or metadata, leaving omitted fields unchanged. Searches, imports, and enrichments are managed through their own endpoints.

Input Parameters

string
required
ID or externalId of the Webset to update.
string
New display title. Omit to leave unchanged; null is not accepted.
object
String key-value metadata to associate with the Webset, or null. Omit to leave unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_UPDATE_WEBSET_ENRICHMENTUpdate an enrichment’s task, format, options, or metadata on a Webset. Omitted fields are left unchanged. Only metadata accepts explicit null.

Input Parameters

string
required
ID of the enrichment to update.
string ("text" | "date" | "number" | "options" | "email" | "phone" | "url")
Enrichment output format. Omit to leave unchanged; cannot be null.
string
required
ID or external ID of the parent Webset.
array
Choices for an options enrichment. Omit to leave unchanged; cannot be null.
object
String key-value metadata, or null. Omit to leave unchanged.
string
New enrichment task description. Omit to leave unchanged; cannot be null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXA_UPDATE_WEBSETS_MONITORUpdate a Websets monitor’s status, schedule, search behavior, or metadata. Omitted fields remain unchanged. Uses the Websets API, not the separate Search /monitors API. Explicit null values are not accepted.

Input Parameters

string
required
ID of the Websets monitor to update.
string ("enabled" | "disabled")
Enable or disable the monitor. Omit to leave unchanged; null is not accepted.
object
Updated run schedule. Omit to leave unchanged; null is not accepted.
object
Updated search behavior. Omit to leave unchanged; null is not accepted.
object
String key-value metadata. Omit to leave unchanged; null is not accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not