Sign in
Enrichments

Create an Enrichment

Create an Enrichment for a Webset.

post/v0/websets/{webset}/enrichments

Path parameters

websetstring required

The id or externalId of the Webset

Request body

descriptionstring required

Provide a description of the enrichment task you want to perform to each Webset Item.

format'text' | 'date' | 'number' | 'options' | 'email' | 'phone' | 'url'

Format of the enrichment response.

We automatically select the best format based on the description. If you want to explicitly specify the format, you can do so here.

metadataobject

Set of key-value pairs you want to associate with this object.

Response

Enrichment created

idstring required

The unique identifier for the enrichment

object'webset_enrichment' required
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