Skip to main content
POST
/
v0
/
websets
/
{webset}
/
enrichments
cURL
curl --request POST \
  --url https://api.exa.ai/websets/v0/websets/{webset}/enrichments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "<string>",
  "format": "text",
  "options": [
    {
      "label": "<string>"
    }
  ],
  "metadata": {}
}
'
{
  "id": "<string>",
  "object": "webset_enrichment",
  "status": "pending",
  "websetId": "<string>",
  "title": "<string>",
  "description": "<string>",
  "format": "text",
  "options": [
    {
      "label": "<string>"
    }
  ],
  "instructions": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

​
x-api-key
string
header
required

Your Exa API key

Path Parameters

​
webset
string
required

The id or externalId of the Webset

Body

application/json
​
description
string
required

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 - application/json

Enrichment created

​
id
string
required

The unique identifier for the enrichment

​
object
string
default:webset_enrichment
required
Allowed value: "webset_enrichment"
​
status
enum<string>
required

The status of the enrichment

Available options:
pending,
canceled,
completed
​
websetId
string
required

The unique identifier for the Webset this enrichment belongs to.

​
title
string | null
required

The title of the enrichment.

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

​
description
string
required

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

​
format
enum<string> | null
required

The format of the enrichment response.

Available options:
text,
date,
number,
options,
email,
phone,
url
​
options
WebsetEnrichmentOptions · object[] | null
required

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

​
instructions
string | null
required

The instructions for the enrichment Agent.

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

​
createdAt
string<date-time>
required

The date and time the enrichment was created

​
updatedAt
string<date-time>
required

The date and time the enrichment was updated

​
metadata
object

The metadata of the enrichment