Skip to main content
PATCH
/
v0
/
websets
/
{webset}
/
enrichments
/
{id}
cURL
curl --request PATCH \
  --url https://api.exa.ai/websets/v0/websets/{webset}/enrichments/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "<string>",
  "format": "text",
  "options": [
    {
      "label": "<string>"
    }
  ],
  "metadata": {}
}
'

Authorizations

​
x-api-key
string
header
required

Your Exa API key

Path Parameters

​
webset
string
required
​
id
string
required

Body

application/json
​
description
string

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

Required string length: 1 - 5000
​
format
enum<string>

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.

Available options:
text,
date,
number,
options,
email,
phone,
url
​
options
object[]

When the format is options, the different options for the enrichment agent to choose from.

Required array length: 1 - 150 elements
​
metadata
object

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

Response

200 - undefined