Exa Websets

Create a new Webset collection. Websets are collections of web entities (companies, people, papers) that can be automatically searched, verified, and enriched with custom data. IMPORTANT PARAMETER FORMATS: - searchCriteria: MUST be array of objects like [{description: "..."}] (NOT array of strings) - enrichments: Each must have description field, optional format and options - enrichment options: MUST be array of objects like [{label: "..."}] (NOT array of strings) Example call: { "name": "AI Startups", "searchQuery": "AI startups in San Francisco", "searchCriteria": [{"description": "Founded after 2020"}], "enrichments": [ {"description": "CEO name", "format": "text"}, {"description": "Company stage", "format": "options", "options": [{"label": "Seed"}, {"label": "Series A"}]} ] }

List all websets in your account. Returns a paginated list of webset collections with their current status and item counts.

Get details about a specific webset by ID or externalId. Returns full webset information including status, item count, and metadata.

Update a webset's metadata. Use this to add or update custom key-value pairs associated with the webset.

Delete a webset and all its items. This action is permanent and cannot be undone.

List all items in a webset. Returns entities (companies, people, papers) that have been discovered and verified in the collection.

Get a specific item from a webset by its ID. Returns detailed information about the item including all enrichment data.

Create a new search to find and add items to a webset. The search will discover entities matching your query and criteria. IMPORTANT PARAMETER FORMATS: - entity: MUST be an object like {type: "company"} (NOT a string) - criteria: MUST be array of objects like [{description: "..."}] (NOT array of strings) Example call: { "websetId": "webset_123", "query": "AI startups in San Francisco", "entity": {"type": "company"}, "criteria": [{"description": "Founded after 2020"}], "count": 10 }

Get details about a specific search, including its status, progress, and results found.

Cancel a running search operation. This will stop the search from finding more items.

Create a new enrichment for a webset. Enrichments automatically extract custom data from each item using AI agents (e.g., 'company revenue', 'CEO name', 'funding amount'). IMPORTANT PARAMETER FORMATS: - options (when format is "options"): MUST be array of objects like [{label: "..."}] (NOT array of strings) Example call (text format): {"websetId": "webset_123", "description": "CEO name", "format": "text"} Example call (options format): {"websetId": "webset_123", "description": "Company stage", "format": "options", "options": [{"label": "Seed"}, {"label": "Series A"}]}

Get details about a specific enrichment, including its status and progress.

Update an enrichment's metadata. You can associate custom key-value pairs with the enrichment.

Delete an enrichment from a webset. This will remove all enriched data for this enrichment from all items.

Cancel a running enrichment operation. This will stop the enrichment from processing more items.

Create a monitor to automatically update a webset on a schedule. Monitors run search operations to find new items. IMPORTANT PARAMETER FORMATS: - cron: MUST be 5-field format "minute hour day month weekday" (e.g., "0 9 * * 1") - entity: MUST be an object like {type: "company"} (NOT a string) - criteria: MUST be array of objects like [{description: "..."}] (NOT array of strings) Example call: { "websetId": "webset_123", "cron": "0 9 * * 1", "query": "New AI startups", "entity": {"type": "company"}, "criteria": [{"description": "Founded in last 30 days"}], "count": 10 }