Back to Autogpt

Exa Websets Import Export

docs/integrations/block-integrations/exa/websets_import_export.md

0.6.448.1 KB
Original Source

Exa Websets Import Export

<!-- MANUAL: file_description -->

Blocks for importing and exporting data with Exa websets.

<!-- END MANUAL -->

Exa Create Import

What it is

Import CSV data to use with websets for targeted searches

How it works

<!-- MANUAL: how_it_works -->

This block creates an import from CSV data that can be used as a source for webset searches. Imports allow you to bring your own data (like company lists or contact lists) and use them for scoped or exclusion searches.

You specify the entity type and which columns contain identifiers and URLs. The import becomes available as a source that can be referenced when creating webset searches.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
titleTitle for this importstrYes
csv_dataCSV data to import (as a string)strYes
entity_typeType of entities being imported"company" | "person" | "article" | "research_paper" | "custom"No
entity_descriptionDescription for custom entity typestrNo
identifier_columnColumn index containing the identifier (0-based)intNo
url_columnColumn index containing URLs (optional)intNo
metadataMetadata to attach to the importDict[str, Any]No

Outputs

OutputDescriptionType
errorError message if the operation failedstr
import_idThe unique identifier for the created importstr
statusCurrent status of the importstr
titleTitle of the importstr
countNumber of items in the importint
entity_typeType of entities importedstr
upload_urlUpload URL for CSV data (only if csv_data not provided in request)str
upload_valid_untilExpiration time for upload URL (only if upload_url is provided)str
created_atWhen the import was createdstr

Possible use case

<!-- MANUAL: use_case -->

Customer Enrichment: Import your customer list to find similar companies or related contacts.

Exclusion Lists: Import existing leads to exclude from new prospecting searches.

Targeted Expansion: Use imported data as a starting point for relationship-based searches.

<!-- END MANUAL -->

Exa Delete Import

What it is

Delete an import

How it works

<!-- MANUAL: how_it_works -->

This block permanently deletes an import and its data. Any websets that reference this import for scoped or exclusion searches will no longer have access to it.

Use this to clean up imports that are no longer needed or contain outdated data. The deletion cannot be undone.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
import_idThe ID of the import to deletestrYes

Outputs

OutputDescriptionType
errorError message if the operation failedstr
import_idThe ID of the deleted importstr
successWhether the deletion was successfulstr

Possible use case

<!-- MANUAL: use_case -->

Data Refresh: Delete outdated imports before uploading updated versions.

Cleanup Operations: Remove imports that are no longer used in any webset searches.

Compliance: Delete imports containing data that needs to be removed for privacy compliance.

<!-- END MANUAL -->

Exa Export Webset

What it is

Export webset data in JSON, CSV, or JSON Lines format

How it works

<!-- MANUAL: how_it_works -->

This block exports all items from a webset in your chosen format. You can include full content and enrichment data in the export, and limit the number of items exported.

Supported formats include JSON for structured data, CSV for spreadsheet compatibility, and JSON Lines for streaming or large dataset processing.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the Webset to exportstrYes
formatExport format"json" | "csv" | "jsonl"No
include_contentInclude full content in exportboolNo
include_enrichmentsInclude enrichment data in exportboolNo
max_itemsMaximum number of items to exportintNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
export_dataExported data in the requested formatstr
item_countNumber of items exportedint
total_itemsTotal number of items in the websetint
truncatedWhether the export was truncated due to max_items limitbool
formatFormat of the exported datastr

Possible use case

<!-- MANUAL: use_case -->

CRM Integration: Export webset data as CSV to import into CRM or marketing automation systems.

Reporting: Generate exports for analysis in spreadsheets or business intelligence tools.

Backup: Create periodic exports of valuable webset data for archival purposes.

<!-- END MANUAL -->

Exa Get Import

What it is

Get the status and details of an import

How it works

<!-- MANUAL: how_it_works -->

This block retrieves detailed information about an import including its status, item count, and configuration. Use this to check if an import is ready to use or to troubleshoot failed imports.

The block returns upload status information if the import is pending data upload, or failure details if the import encountered errors.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
import_idThe ID of the import to retrievestrYes

Outputs

OutputDescriptionType
errorError message if the operation failedstr
import_idThe unique identifier for the importstr
statusCurrent status of the importstr
titleTitle of the importstr
formatFormat of the imported datastr
entity_typeType of entities importedstr
countNumber of items importedint
upload_urlUpload URL for CSV data (if import not yet uploaded)str
upload_valid_untilExpiration time for upload URL (if applicable)str
failed_reasonReason for failure (if applicable)str
failed_messageDetailed failure message (if applicable)str
created_atWhen the import was createdstr
updated_atWhen the import was last updatedstr
metadataMetadata attached to the importDict[str, Any]

Possible use case

<!-- MANUAL: use_case -->

Status Verification: Check import status after upload to confirm data is ready for use.

Error Investigation: Retrieve import details to understand why an import failed.

Audit Trail: Review import configuration and metadata for documentation purposes.

<!-- END MANUAL -->

Exa List Imports

What it is

List all imports with pagination support

How it works

<!-- MANUAL: how_it_works -->

This block retrieves a paginated list of all your imports. Results include basic information about each import such as title, status, and item count.

Use this to discover existing imports that can be referenced in webset searches or to manage your import library.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
limitNumber of imports to returnintNo
cursorCursor for paginationstrNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
importsList of importsList[Dict[str, Any]]
import_itemIndividual import (yielded for each import)Dict[str, Any]
has_moreWhether there are more imports to paginate throughbool
next_cursorCursor for the next page of resultsstr

Possible use case

<!-- MANUAL: use_case -->

Import Discovery: Find existing imports to reference when creating new webset searches.

Library Management: Review all imports to identify outdated data that can be cleaned up.

Source Selection: Browse available imports when setting up scoped or exclusion searches.

<!-- END MANUAL -->