Exa Websets icon

Exa Websets

Create, manage, and query structured datasets from web sources using Exa Websets API

Actions28

Overview

The "Exa Websets" node integrates with the Exa Websets API to create, manage, and query structured datasets derived from web sources. Specifically, the Enrichment - Update operation allows users to modify existing enrichments associated with a webset. Enrichments are AI-powered analyses that add value or metadata to webset content.

This operation is useful when you want to adjust the parameters of an enrichment, such as changing its prompt, updating its configuration, or toggling its status between running and paused. For example, if an enrichment's analysis criteria need refinement or if you want to temporarily pause the enrichment process without deleting it, this update operation facilitates those changes.

Practical scenarios include:

  • Updating the AI prompt to refine how content is analyzed.
  • Changing configuration settings in JSON format to alter enrichment behavior.
  • Pausing or resuming enrichment processing based on workflow needs.

Properties

Name Meaning
Webset ID The unique identifier of the webset to which the enrichment belongs.
Enrichment ID The unique identifier of the enrichment to be updated.
Update Fields A collection of fields to update for the enrichment:
  Prompt Updated text prompt guiding the enrichment's AI analysis.
  Configuration Updated configuration expressed as a JSON object, defining enrichment parameters.
  Status Status of the enrichment; can be either "Paused" or "Running".

Output

The node outputs an array of JSON objects representing the result of the update operation. Each output item corresponds to an input item processed by the node.

  • The json field contains the response data from the Exa Websets API after updating the enrichment.
  • If the update is successful, the output typically includes details of the updated enrichment, reflecting the new prompt, configuration, and status.
  • In case of failure (and if "Continue On Fail" is enabled), the output will contain an error message describing what went wrong, along with the resource and operation names.

The node does not output binary data.

Dependencies

  • Requires an active connection to the Exa Websets API.
  • Needs an API key credential configured in n8n for authentication with the Exa Websets service.
  • The base URL for API requests is https://api.exa.ai.
  • Proper permissions on the API key to perform enrichment updates are necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing Webset ID or Enrichment ID will cause the API to reject the request.
    • Malformed JSON in the Configuration field may lead to parsing errors.
    • Attempting to update an enrichment that does not exist or belongs to another user/account.
    • Network connectivity issues preventing communication with the Exa Websets API.

  • Error Messages:

    • "Unknown resource": Indicates the specified resource parameter is invalid; ensure "enrichments" is selected.
    • API errors returned from the Exa Websets service will be passed through; check the error message for details.
    • JSON parsing errors if the Configuration field is not valid JSON.

  • Resolutions:

    • Verify all required IDs are correct and correspond to existing entities.
    • Validate JSON syntax before submitting the Configuration field.
    • Ensure the API key has sufficient privileges.
    • Check network connectivity and API endpoint accessibility.

Links and References

Discussion