Skip to Content

Exa API

Exa API icon
Arcade Starter

Tools that enable LLMs to interact directly with the Exa.ai Search API.

Author:Arcade
Version:2.0.0
Auth:No authentication required
45tools
45require secrets
PyPI VersionPython VersionsWheel StatusDownloadsLicense

ExaApi provides a toolkit that enables LLMs to interact directly with the Exa.ai Search API, facilitating advanced data handling and search operations.

Capabilities

  • Create, update, and delete various components such as Websets and enrichments.
  • Execute and manage search processes with options to cancel ongoing operations.
  • Set up automatic monitoring and notifications to keep data current.
  • Retrieve detailed information about websets, enrichments, and research requests.
  • Perform direct searches and fetch relevant content or summaries.

Secrets

  • API key: EXA_API_KEY, used for authentication and API access.

Available tools(45)

45 of 45
Tool nameDescriptionSecrets
Cancel a running enrichment process. Use this tool to cancel any currently running enrichment process. Once canceled, the process cannot be resumed.
1
Cancels a currently running search operation. This tool cancels an ongoing search by using the specified webset and search ID. Useful when you need to stop a search that is still in progress.
1
Cancel all operations on a specified Webset. Use this tool to stop any ongoing enrichment or search processes on a Webset, marking it as 'idle'.
1
Create a new import for data upload and enhancement. Use this tool to initialize a new import process to upload data into Websets. This import can then be used to enrich, search, or exclude data using Websets' features. It provides an upload URL and a deadline for uploading the data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Automatically create and schedule a monitor for Websets. This tool creates a new Monitor to keep Websets updated with fresh data. It automatically executes search and refresh operations based on defined schedules to ensure the content is current. You can configure cron expressions and timezones for precise control.
1
Create a new research request through Exa API. This tool initiates a new research request by calling the specified endpoint of the Exa API. It should be used when there is a need to start or submit a new research inquiry.
1
Create webhooks for event notifications from Exa. Use this tool to set up webhooks that notify you of specific events in your Websets. Choose event types and specify the URL to receive notifications. Begins receiving notifications instantly and provides a secret key for signature verification.
1
Create a new Webset with optional configurations. This tool allows you to create a new Webset with optional search, import, and enrichment configurations. Specify an `externalId` for easier integration. The Webset begins processing automatically upon creation.
1
Create an enrichment for a specified webset. This tool is used to create an enrichment for a specified webset. It's suitable for when you need to enhance a webset with additional data.
1
Create a new search for a specified webset. This tool is used to create a new search within a specified webset, reusing previous search results and evaluating them against new criteria. Useful for updating or refining search parameters.
1
Delete an enrichment and cancel running processes. Use this tool to delete an enrichment, cancel any running processes, and remove all generated enrichment results.
1
Delete an import by its ID. Use this tool to delete an import record when you have the import ID.
1
Deletes a specified monitor using its ID. Use this tool to delete a monitor by providing its ID. It should be called when you need to remove a monitor from the system.
1
Deletes a Webset and its associated items. Use this tool to permanently delete a Webset and all its associated items. Once deleted, it cannot be recovered.
1
Delete an item from a webset and cancel its enrichment process. Use this tool to remove an item from the specified webset. This will also cancel any ongoing enrichment process associated with the item.
1
Find similar links to a given link. This tool finds links similar to the provided link and can optionally retrieve their contents. It should be called when a user needs to discover related web pages or resources. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Retrieve direct answers or detailed summaries with citations. Use this tool to perform a search based on a query. It generates either a direct answer or a detailed summary with citations, depending on the nature of the query.
1
Retrieve details about specific content. Use this tool to retrieve detailed information about specific content from the EXA service. It should be called when content details are needed for further processing or display. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Retrieve detailed information about a specific enrichment. Use this tool to get detailed information about a specific enrichment in a webset by providing the webset and enrichment IDs.
1
Retrieve details of an event using its ID. Use this tool to obtain information about a specific event by providing its unique identifier.
1
Retrieve research information using a specific ID. Use this tool to obtain detailed research information by providing a specific research ID. Supports real-time updates with streaming.
1
Retrieve a search by its ID. Use this tool to get detailed information about a specific search by providing its ID.
1
Retrieve details of a specific import. Use this tool to get detailed information about a particular import by providing its ID.
1
Retrieve details of a specific monitor using its ID. This tool is used to obtain information about a particular monitor by providing its unique ID. Call this tool when you need to get specific details about a monitor.
1
Retrieve details of a specific monitor run. This tool retrieves details of a specific monitor run by using the monitor ID and run ID. It should be called when you need to access information about a particular monitor run.
1
Page 1 of 2(25 of 45)

Selected tools

No tools selected.

Click "Show all tools" to add tools.

Requirements

Select tools to see requirements

#

ExaApi.CancelEnrichmentProcess

Cancel a running enrichment process. Use this tool to cancel any currently running enrichment process. Once canceled, the process cannot be resumed.

Parameters

ParameterTypeReq.Description
enrichment_idstringRequiredThe unique identifier of the enrichment process to be canceled.
webset_idstringRequiredThe ID or external ID of the Webset to identify which enrichment process to cancel.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-enrichments-cancel'.
#

ExaApi.CancelRunningSearch

Cancels a currently running search operation. This tool cancels an ongoing search by using the specified webset and search ID. Useful when you need to stop a search that is still in progress.

Parameters

ParameterTypeReq.Description
search_idstringRequiredThe ID of the search to cancel. Provide the unique string identifier for the targeted search operation.
webset_idstringRequiredThe ID of the Webset where the search is executing. Use this to specify the Webset to be canceled.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-searches-cancel'.
#

ExaApi.CancelWebsetOperations

Cancel all operations on a specified Webset. Use this tool to stop any ongoing enrichment or search processes on a Webset, marking it as 'idle'.

Parameters

ParameterTypeReq.Description
webset_identifierstringRequiredThe ID or external ID of the Webset to cancel operations on.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-cancel'.
#

ExaApi.CreateDataImport

Create a new import for data upload and enhancement. Use this tool to initialize a new import process to upload data into Websets. This import can then be used to enrich, search, or exclude data using Websets' features. It provides an upload URL and a deadline for uploading the data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'imports-create'.
#

ExaApi.CreateMonitorForWebsets

Automatically create and schedule a monitor for Websets. This tool creates a new Monitor to keep Websets updated with fresh data. It automatically executes search and refresh operations based on defined schedules to ensure the content is current. You can configure cron expressions and timezones for precise control.

Parameters

No parameters required.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'monitors-create'.
#

ExaApi.CreateResearchRequest

Create a new research request through Exa API. This tool initiates a new research request by calling the specified endpoint of the Exa API. It should be used when there is a need to start or submit a new research inquiry.

Parameters

No parameters required.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'ResearchController_createResearch'.
#

ExaApi.CreateWebhookForNotifications

Create webhooks for event notifications from Exa. Use this tool to set up webhooks that notify you of specific events in your Websets. Choose event types and specify the URL to receive notifications. Begins receiving notifications instantly and provides a secret key for signature verification.

Parameters

No parameters required.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'webhooks-create'.
#

ExaApi.CreateWebset

Create a new Webset with optional configurations. This tool allows you to create a new Webset with optional search, import, and enrichment configurations. Specify an `externalId` for easier integration. The Webset begins processing automatically upon creation.

Parameters

No parameters required.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-create'.
#

ExaApi.CreateWebsetEnrichment

Create an enrichment for a specified webset. This tool is used to create an enrichment for a specified webset. It's suitable for when you need to enhance a webset with additional data.

Parameters

ParameterTypeReq.Description
webset_identifierstringRequiredThe ID or external ID of the webset for which the enrichment is to be created.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-enrichments-create'.
#

ExaApi.CreateWebsetSearch

Create a new search for a specified webset. This tool is used to create a new search within a specified webset, reusing previous search results and evaluating them against new criteria. Useful for updating or refining search parameters.

Parameters

ParameterTypeReq.Description
webset_idstringRequiredThe unique identifier for the Webset to create a search within.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-searches-create'.
#

ExaApi.DeleteEnrichment

Delete an enrichment and cancel running processes. Use this tool to delete an enrichment, cancel any running processes, and remove all generated enrichment results.

Parameters

ParameterTypeReq.Description
enrichment_idstringRequiredThe unique identifier of the enrichment to be deleted.
webset_idstringRequiredThe ID or external ID of the Webset to identify which enrichment to delete.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-enrichments-delete'.
#

ExaApi.DeleteImport

Delete an import by its ID. Use this tool to delete an import record when you have the import ID.

Parameters

ParameterTypeReq.Description
import_idstringRequiredThe unique identifier of the import to be deleted.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'imports-delete'.
#

ExaApi.DeleteMonitor

Deletes a specified monitor using its ID. Use this tool to delete a monitor by providing its ID. It should be called when you need to remove a monitor from the system.

Parameters

ParameterTypeReq.Description
monitor_idstringRequiredThe unique identifier for the monitor to be deleted.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'monitors-delete'.
#

ExaApi.DeleteWebset

Deletes a Webset and its associated items. Use this tool to permanently delete a Webset and all its associated items. Once deleted, it cannot be recovered.

Parameters

ParameterTypeReq.Description
webset_identifierstringRequiredThe unique identifier or external ID of the Webset to delete.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-delete'.
#

ExaApi.DeleteWebsetItem

Delete an item from a webset and cancel its enrichment process. Use this tool to remove an item from the specified webset. This will also cancel any ongoing enrichment process associated with the item.

Parameters

ParameterTypeReq.Description
webset_identifierstringRequiredThe ID or external ID of the Webset from which the item will be deleted.
webset_item_idstringRequiredThe unique identifier of the item to be deleted from the webset.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-items-delete'.
#

ExaApi.GenerateAnswerSummary

Retrieve direct answers or detailed summaries with citations. Use this tool to perform a search based on a query. It generates either a direct answer or a detailed summary with citations, depending on the nature of the query.

Parameters

ParameterTypeReq.Description
search_querystringRequiredThe question or query to be answered or summarized.
enable_streaming_responsebooleanOptionalReturn the response as a server-sent events (SSE) stream if set to true.
include_full_textbooleanOptionalIf true, the response includes full text content in the search results.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'answer'.
#

ExaApi.GetContentDetails

Retrieve details about specific content. Use this tool to retrieve detailed information about specific content from the EXA service. It should be called when content details are needed for further processing or display. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'getContents'.
#

ExaApi.GetEnrichmentDetails

Retrieve detailed information about a specific enrichment. Use this tool to get detailed information about a specific enrichment in a webset by providing the webset and enrichment IDs.

Parameters

ParameterTypeReq.Description
enrichment_idstringRequiredThe unique identifier for the specific enrichment you want to retrieve within the webset.
webset_identifierstringRequiredThe ID or external ID of the webset to retrieve enrichment details for.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-enrichments-get'.
#

ExaApi.GetEventById

Retrieve details of an event using its ID. Use this tool to obtain information about a specific event by providing its unique identifier.

Parameters

ParameterTypeReq.Description
event_idstringRequiredThe unique identifier of the event to retrieve details for.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'events-get'.
#

ExaApi.GetResearchById

Retrieve research information using a specific ID. Use this tool to obtain detailed research information by providing a specific research ID. Supports real-time updates with streaming.

Parameters

ParameterTypeReq.Description
enable_streamingstringRequiredSet to 'true' to receive real-time streaming updates of the research information.
event_filterstringRequiredSpecify the events to filter for in the research retrieval. Accepts a comma-separated list of event types.
research_idstringRequiredA string representing the unique identifier of the research to be retrieved.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'ResearchController_getResearch'.
#

ExaApi.GetSearchById

Retrieve a search by its ID. Use this tool to get detailed information about a specific search by providing its ID.

Parameters

ParameterTypeReq.Description
search_idstringRequiredThe ID of the search to retrieve details for.
webset_idstringRequiredThe ID of the Webset to retrieve the specific search.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-searches-get'.
#

ExaApi.GetSpecificImport

Retrieve details of a specific import. Use this tool to get detailed information about a particular import by providing its ID.

Parameters

ParameterTypeReq.Description
import_idstringRequiredThe unique identifier for the specific import to retrieve details about.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'imports-get'.
#

ExaApi.GetSpecificMonitor

Retrieve details of a specific monitor using its ID. This tool is used to obtain information about a particular monitor by providing its unique ID. Call this tool when you need to get specific details about a monitor.

Parameters

ParameterTypeReq.Description
monitor_idstringRequiredThe unique identifier of the monitor to retrieve details for.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'monitors-get'.
#

ExaApi.GetSpecificMonitorRun

Retrieve details of a specific monitor run. This tool retrieves details of a specific monitor run by using the monitor ID and run ID. It should be called when you need to access information about a particular monitor run.

Parameters

ParameterTypeReq.Description
monitor_idstringRequiredThe unique identifier of the monitor to retrieve the run for.
run_idstringRequiredThe unique identifier of the specific run to retrieve details for.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'monitors-runs-get'.
#

ExaApi.GetWebhookInfo

Retrieve details of a webhook using its ID. This tool is used to get details about a specific webhook by providing its ID. It should be called when you need to access information about a particular webhook. The secret associated with the webhook is not included for security reasons.

Parameters

ParameterTypeReq.Description
webhook_idstringRequiredThe unique identifier for the webhook you want details about.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'webhooks-get'.
#

ExaApi.GetWebhooksList

Retrieve a paginated list of all webhooks in your account. Use this tool to get all the webhooks associated with your account, with options to paginate through results using limit and cursor parameters.

Parameters

ParameterTypeReq.Description
pagination_cursorstringOptionalThe cursor used to navigate through pages of results for webhooks.
results_per_pagenumberOptionalThe number of webhooks to return per page, up to a maximum of 200.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'webhooks-list'.
#

ExaApi.GetWebsetDetails

Retrieve detailed information about a specific webset. This tool is used to obtain the details of a specific webset using its unique identifier. Call this when you need information related to a particular webset.

Parameters

ParameterTypeReq.Description
webset_identifierstringRequiredThe unique identifier or external ID for the Webset to retrieve.
resources_to_expandarray<string>OptionalA list of resources to include in the response for additional details.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-get'.
#

ExaApi.GetWebsetItem

Retrieve a specific Webset Item by ID. This tool is used to retrieve information about a specific Webset Item using its ID. It should be called when you need detailed information about a particular item associated with a Webset.

Parameters

ParameterTypeReq.Description
webset_identifierstringRequiredThe ID or external ID of the Webset to identify the desired Webset from which the item is to be retrieved.
webset_item_idstringRequiredThe unique identifier of the Webset item to retrieve.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-items-get'.
#

ExaApi.ListImports

Retrieve all import entries for the Webset. Use this tool to get a comprehensive list of all imports associated with the Webset, useful for tracking or auditing purposes.

Parameters

ParameterTypeReq.Description
pagination_cursorstringOptionalString used for paginating through results. Pass it to retrieve the next set of results.
results_limitnumberOptionalSpecify the maximum number of import results to return.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'imports-list'.
#

ExaApi.ListMonitorRuns

Lists all runs for a given monitor. Use this tool to retrieve a list of all runs associated with a specific monitor. It's helpful for tracking and analyzing past monitor activities.

Parameters

ParameterTypeReq.Description
monitor_idstringRequiredThe ID of the monitor to list all associated runs.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'monitors-runs-list'.
#

ExaApi.ListResearchRequests

Retrieve a paginated list of research requests. Use this tool to obtain a paginated list of all research requests. Ideal for reviewing or analyzing current research queries.

Parameters

ParameterTypeReq.Description
pagination_cursorstringOptionalA string representing the position in the paginated results to continue retrieving data from.
results_limitnumberOptionalSpecifies the number of research requests to return in the response. Helps manage pagination effectively.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'ResearchController_listResearch'.
#

ExaApi.ListSystemEvents

Retrieve a list of all system events. Call this tool to get a detailed list of events that have occurred within the system. Useful for auditing, monitoring, or reviewing activities. Supports pagination through a cursor parameter.

Parameters

ParameterTypeReq.Description
created_afterstringOptionalFilter events created after or at this timestamp. Use a valid ISO 8601 datetime string in UTC.
event_types_filterarray<string>OptionalFilter events by specifying an array of event type names.
filter_created_beforestringOptionalFilter events created before or at this timestamp (inclusive). Provide a valid ISO 8601 datetime string in UTC.
pagination_cursorstringOptionalCursor for paginating through event results. Use it to navigate through pages of events.
results_limitnumberOptionalSpecify the number of event results to return. This controls the size of the result set for a single request.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'events-list'.
#

ExaApi.ListWebhookAttempts

Retrieve and list all webhook attempt records. This tool retrieves all attempts made by a specific webhook, ordered in descending order. It is useful for monitoring webhook activity and diagnosing issues.

Parameters

ParameterTypeReq.Description
webhook_idstringRequiredThe unique identifier for the webhook to retrieve attempt records for.
event_type_filterstringOptionalFilter webhook attempts by specifying the type of event, such as 'webset.created' or 'monitor.run.completed'.
filter_by_successful_attemptsbooleanOptionalUse 'true' to filter for successful webhook attempts and 'false' for unsuccessful ones.
pagination_cursorstringOptionalA string used to paginate through the webhook attempt results.
results_limitnumberOptionalSpecify the maximum number of webhook attempt records to return.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'webhooks-attempts-list'.
#

ExaApi.ListWebsetItems

Retrieve a list of items from a specific webset. This tool fetches items from a designated webset, allowing pagination with the 'cursor' parameter if needed.

Parameters

ParameterTypeReq.Description
webset_identifierstringRequiredThe ID or external ID of the Webset to retrieve items from.
pagination_cursorstringOptionalA string used to paginate through the results. Pass this to retrieve the next set of items in the webset.
result_limitnumberOptionalSpecify the number of results to return. This controls the size of the page in a paginated response.
source_idstringOptionalThe unique identifier for the source from which to retrieve items.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-items-list'.
#

ExaApi.ListWebsets

Retrieve a list of available websets. Use this tool to obtain a list of websets. You can paginate through results using a cursor.

Parameters

ParameterTypeReq.Description
pagination_cursorstringOptionalA string used to paginate through the list of Websets.
websets_return_limitnumberOptionalSpecify the maximum number of Websets to return in the response.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-list'.
#

ExaApi.ListWebsiteMonitors

Fetch all monitors associated with a website. Use this tool to retrieve a comprehensive list of all monitoring services set up for a specific website. This is helpful for maintenance, auditing, or upgrading processes.

Parameters

ParameterTypeReq.Description
pagination_cursorstringOptionalThe cursor for paginating through the monitor results.
results_limitnumberOptionalSpecifies the maximum number of monitor results to return. Use for pagination.
webset_idstringOptionalThe unique identifier for the Webset to retrieve monitors for. This is required to specify which website's monitors you want to list.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'monitors-list'.
#

ExaApi.PerformSearch

Perform a search and retrieve relevant results. Use this tool to execute a search with a prompt-engineered query via Exa and obtain relevant results. Optionally, retrieve the contents of the results. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'search'.
#

ExaApi.PreviewSearchQueryAnalysis

Preview how a search query will be decomposed into a webset. Use this tool to preview the decomposition and analysis of a search query before committing to webset creation, helping users understand the detected entity type, generated search criteria, and available enrichment options.

Parameters

No parameters required.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-preview'.
#

ExaApi.RemoveWebhook

Remove a webhook from your account. Use this tool to delete a webhook. Once deleted, it stops receiving notifications immediately and cannot be restored. You'll need to create a new webhook if you wish to reinstate it. Use when you need to stop a webhook permanently.

Parameters

ParameterTypeReq.Description
webhook_idstringRequiredThe unique identifier of the webhook to remove. This is necessary for specifying which webhook to delete.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'webhooks-delete'.
#

ExaApi.UpdateImportConfiguration

Update an import configuration with specified parameters. Call this tool to modify the settings of an existing import configuration using its ID.

Parameters

ParameterTypeReq.Description
import_idstringRequiredThe unique ID of the import configuration to update.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'imports-update'.
#

ExaApi.UpdateMonitorConfiguration

Update a monitor configuration in Exa. Use this tool to update the configuration of a specified monitor in the Exa system. This is useful for modifying settings such as thresholds, alerts, and other configurations.

Parameters

ParameterTypeReq.Description
monitor_idstringRequiredThe unique identifier for the monitor to update.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'monitors-update'.
#

ExaApi.UpdateWebhookSettings

Update webhook settings such as events, URL, or metadata. This tool lets you modify a webhook's configuration instantly. Use it to add or remove event notifications, update the notification URL, or change metadata. The current status of the webhook remains unchanged during updates.

Parameters

ParameterTypeReq.Description
webhook_idstringRequiredThe unique identifier for the webhook to update.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'webhooks-update'.
#

ExaApi.UpdateWebsetEnrichment

Update an enrichment configuration for a webset. Use this tool to modify the existing enrichment configuration of a specified webset. Call this tool when you need to apply new settings or changes to an enrichment setup.

Parameters

ParameterTypeReq.Description
enrichment_configuration_idstringRequiredThe unique identifier of the enrichment configuration to be updated.
webset_identifierstringRequiredThe unique identifier or name of the webset to update. This is required to target the correct webset for enrichment modification.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-enrichments-update'.
#

ExaApi.UpdateWebsetExa

Update an existing webset on Exa platform. Use this tool to update the details of an existing webset on the Exa platform. Invoke it when modifications to a webset are needed, such as changing its properties or configurations.

Parameters

ParameterTypeReq.Description
webset_identifierstringRequiredThe unique identifier (id or externalId) of the Webset to update.

Requirements

Secrets:EXA_API_KEY

Output

Type:json— Response from the API endpoint 'websets-update'.
Last updated on