Back to Autogpt

Exa Websets Items

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

0.6.449.3 KB
Original Source

Exa Websets Items

<!-- MANUAL: file_description -->

Blocks for retrieving and managing items within Exa websets.

<!-- END MANUAL -->

Exa Bulk Webset Items

What it is

Get all items from a webset in bulk (with configurable limits)

How it works

<!-- MANUAL: how_it_works -->

This block retrieves all items from a webset in a single operation, automatically handling pagination internally. You can specify a maximum number of items and choose whether to include enrichments and full content.

Use this for batch processing when you need all webset data at once rather than paginating through results manually.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the WebsetstrYes
max_itemsMaximum number of items to retrieve (1-1000). Note: Large values may take longer.intNo
include_enrichmentsInclude enrichment data for each itemboolNo
include_contentInclude full content for each itemboolNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
itemsAll items from the websetList[WebsetItemModel]
itemIndividual item (yielded for each item)WebsetItemModel
total_retrievedTotal number of items retrievedint
truncatedWhether results were truncated due to max_items limitbool

Possible use case

<!-- MANUAL: use_case -->

Batch Processing: Retrieve all webset items for bulk analysis or processing in external systems.

Data Export: Get complete webset data for integration with other tools or databases.

Full Dataset Analysis: Analyze entire webset contents when pagination isn't practical.

<!-- END MANUAL -->

Exa Delete Webset Item

What it is

Delete a specific item from a webset

How it works

<!-- MANUAL: how_it_works -->

This block permanently removes a specific item from a webset. The item and all its enrichment data are deleted and cannot be recovered.

Use this to clean up irrelevant results, remove duplicates, or curate webset contents by removing items that don't meet your quality standards.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the WebsetstrYes
item_idThe ID of the item to deletestrYes

Outputs

OutputDescriptionType
errorError message if the operation failedstr
item_idThe ID of the deleted itemstr
successWhether the deletion was successfulstr

Possible use case

<!-- MANUAL: use_case -->

Data Curation: Remove irrelevant or low-quality items to improve webset accuracy.

Duplicate Removal: Delete duplicate entries discovered during review.

Compliance: Remove items that shouldn't be included for legal or policy reasons.

<!-- END MANUAL -->

Exa Get New Items

What it is

Get items added since a cursor - enables incremental processing without reprocessing

How it works

<!-- MANUAL: how_it_works -->

This block retrieves only items added to a webset since your last check, identified by a cursor. This enables efficient incremental processing without re-fetching previously processed items.

Save the returned next_cursor for subsequent calls to implement continuous incremental processing of new webset additions.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the WebsetstrYes
since_cursorCursor from previous run - only items after this will be returned. Leave empty on first run.strNo
max_itemsMaximum number of new items to retrieveintNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
new_itemsItems added since the cursorList[WebsetItemModel]
itemIndividual item (yielded for each new item)WebsetItemModel
countNumber of new items foundint
next_cursorSave this cursor for the next run to get only newer itemsstr
has_moreWhether there are more new items beyond max_itemsbool

Possible use case

<!-- MANUAL: use_case -->

Incremental Processing: Process only new webset items in scheduled workflows without duplicating work.

Real-Time Pipelines: Build efficient pipelines that react to new data without full dataset scans.

Change Detection: Track what's new in websets for alerting or notification systems.

<!-- END MANUAL -->

Exa Get Webset Item

What it is

Get a specific item from a webset by its ID

How it works

<!-- MANUAL: how_it_works -->

This block retrieves detailed information about a specific webset item including its content, entity data, and enrichments. Use this when you need complete data for a particular item.

The block returns the full item record with all available data, timestamps, and any enrichment results that have been applied.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the WebsetstrYes
item_idThe ID of the specific item to retrievestrYes

Outputs

OutputDescriptionType
errorError message if the operation failedstr
item_idThe unique identifier for the itemstr
urlThe URL of the original sourcestr
titleThe title of the itemstr
contentThe main content of the itemstr
entity_dataEntity-specific structured dataDict[str, Any]
enrichmentsEnrichment data added to the itemDict[str, Any]
created_atWhen the item was added to the websetstr
updated_atWhen the item was last updatedstr

Possible use case

<!-- MANUAL: use_case -->

Detail View: Fetch complete item data for display in detail views or profiles.

Enrichment Review: Retrieve item with enrichments to verify data extraction quality.

Reference Lookup: Get specific items by ID for cross-referencing or validation.

<!-- END MANUAL -->

Exa List Webset Items

What it is

List items in a webset with pagination support

How it works

<!-- MANUAL: how_it_works -->

This block retrieves a paginated list of items from a webset. You control page size and can optionally wait for items if the webset is still processing.

Use pagination cursors to iterate through large websets efficiently. Each page returns items along with metadata about whether more pages exist.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the WebsetstrYes
limitNumber of items to return (1-100)intNo
cursorCursor for pagination through resultsstrNo
wait_for_itemsWait for items to be available if webset is still processingboolNo
wait_timeoutMaximum time to wait for items in secondsintNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
itemsList of webset itemsList[WebsetItemModel]
webset_idThe ID of the websetstr
itemIndividual item (yielded for each item in the list)WebsetItemModel
has_moreWhether there are more items to paginate throughbool
next_cursorCursor for the next page of resultsstr

Possible use case

<!-- MANUAL: use_case -->

Paginated Display: Build UIs that display webset items with pagination controls.

Streaming Processing: Process webset items in manageable batches to avoid memory issues.

Controlled Iteration: Step through large websets methodically for thorough analysis.

<!-- END MANUAL -->

Exa Webset Items Summary

What it is

Get a summary of webset items without retrieving all data

How it works

<!-- MANUAL: how_it_works -->

This block provides a lightweight summary of webset items including total count, entity type, available enrichment columns, and optional sample items. It's efficient for getting an overview without fetching full data.

Use this to understand webset contents at a glance, check enrichment availability, or get sample data for validation.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the WebsetstrYes
sample_sizeNumber of sample items to includeintNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
total_itemsTotal number of items in the websetint
entity_typeType of entities in the websetstr
sample_itemsSample of items from the websetList[WebsetItemModel]
enrichment_columnsList of enrichment columns availableList[str]

Possible use case

<!-- MANUAL: use_case -->

Quick Overview: Get webset statistics and samples without loading all data.

Schema Discovery: Check what enrichment columns are available before building exports.

Validation: Review sample items to verify webset quality before full processing.

<!-- END MANUAL -->