EXexa
Enrichments

Cancel a running Enrichment

Changed on

All running enrichments will be canceled. You can not resume an Enrichment after it has been canceled.

post/v0/websets/{webset}/enrichments/{id}/cancel

Request

  • Base URL
    https://api.exa.ai/websets
  • URL
    https://api.exa.ai/websets/v0/websets/{webset}/enrichments/{id}/cancel
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

websetstring required

The id or externalId of the Webset

idstring required

The id of the Enrichment

Response

Enrichment cancelled

idstring required

The unique identifier for the enrichment

object'webset_enrichment' required

The type of object

status'pending' | 'canceled' | 'completed' required

The status of the enrichment

websetIdstring required

The unique identifier for the Webset this enrichment belongs to.

titlestring nullable required

The title of the enrichment.

This will be automatically generated based on the description and format.

descriptionstring required

The description of the enrichment task provided during the creation of the enrichment.

format'text' | 'date' | 'number' | 'options' | 'email' | 'phone' | 'url' required
instructionsstring nullable required

The instructions for the enrichment Agent.

This will be automatically generated based on the description and format.

metadataobject

The metadata of the enrichment

createdAtstring date-time required

The date and time the enrichment was created

updatedAtstring date-time required

The date and time the enrichment was updated

Changes