Skip to main content
POST
/
v0
/
websets
curl --request POST \
  --url https://api.exa.ai/websets/v0/websets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "search": {
    "query": "<string>",
    "count": 10,
    "entity": {
      "type": "company"
    },
    "criteria": [
      {
        "description": "<string>"
      }
    ],
    "recall": true,
    "exclude": [
      {
        "source": "import",
        "id": "<string>"
      }
    ],
    "scope": [
      {
        "source": "import",
        "id": "<string>",
        "relationship": {
          "definition": "<string>",
          "limit": 5.5
        }
      }
    ]
  },
  "import": [
    {
      "source": "import",
      "id": "<string>"
    }
  ],
  "enrichments": [
    {
      "description": "<string>",
      "format": "text",
      "options": [
        {
          "label": "<string>"
        }
      ],
      "metadata": {}
    }
  ],
  "exclude": [
    {
      "source": "import",
      "id": "<string>"
    }
  ],
  "externalId": "<string>",
  "metadata": {},
  "title": "<string>"
}
'
{
  "id": "<string>",
  "object": "webset",
  "status": "idle",
  "externalId": "<string>",
  "title": "<string>",
  "searches": [
    {
      "id": "<string>",
      "object": "webset_search",
      "status": "created",
      "websetId": "<string>",
      "query": "<string>",
      "entity": {
        "type": "company"
      },
      "criteria": [
        {
          "description": "<string>",
          "successRate": 50
        }
      ],
      "count": 2,
      "exclude": [
        {
          "source": "import",
          "id": "<string>"
        }
      ],
      "scope": [
        {
          "source": "import",
          "id": "<string>",
          "relationship": {
            "definition": "<string>",
            "limit": 5.5
          }
        }
      ],
      "progress": {
        "found": 123,
        "analyzed": 123,
        "completion": 50,
        "timeLeft": 123
      },
      "recall": {
        "expected": {
          "total": 123,
          "confidence": "high",
          "bounds": {
            "min": 123,
            "max": 123
          }
        },
        "reasoning": "<string>"
      },
      "canceledAt": "2023-11-07T05:31:56Z",
      "canceledReason": "webset_deleted",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "behavior": "override",
      "metadata": {}
    }
  ],
  "imports": [
    {
      "id": "<string>",
      "object": "import",
      "status": "pending",
      "format": "csv",
      "entity": {
        "type": "company"
      },
      "title": "<string>",
      "count": 123,
      "metadata": {},
      "failedReason": "invalid_format",
      "failedAt": "2023-11-07T05:31:56Z",
      "failedMessage": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "enrichments": [
    {
      "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": {}
    }
  ],
  "monitors": [
    {
      "id": "<string>",
      "object": "monitor",
      "status": "enabled",
      "websetId": "<string>",
      "cadence": {
        "cron": "<string>",
        "timezone": "Etc/UTC"
      },
      "behavior": {
        "type": "search",
        "config": {
          "count": 123,
          "query": "<string>",
          "criteria": [
            {
              "description": "<string>"
            }
          ],
          "entity": {
            "type": "company"
          },
          "behavior": "append"
        }
      },
      "lastRun": {
        "id": "<string>",
        "object": "monitor_run",
        "status": "created",
        "monitorId": "<string>",
        "type": "search",
        "completedAt": "2023-11-07T05:31:56Z",
        "failedAt": "2023-11-07T05:31:56Z",
        "failedReason": "<string>",
        "canceledAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "nextRunAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "excludes": [
    {
      "source": "import",
      "id": "<string>"
    }
  ],
  "metadata": {}
}

Authorizations

​
x-api-key
string
header
required

Your Exa API key

Body

application/json
​
search
object

Create initial search for the Webset.

​
import
object[]

Attach/load data from existing Imports or Websets into this Webset. For CSV Imports, this schedules ingestion and creates a staging pool of items (ImportItems do not automatically appear as Webset Items; searches create Webset Items). This does not filter searches. To filter a search to only look within an Import or Webset, use search.scope instead.

​
enrichments
CreateEnrichmentParameters · object[]

Add enrichments to extract additional data from found items.

Enrichments automatically search for and extract specific information (like contact details, funding data, employee counts, etc.) from each item added to your Webset.

​
exclude
object[]

Global exclusion sources (existing imports or websets) that apply to all operations within this Webset. Any results found within these sources will be omitted across all search and import operations.

​
externalId
string

The external identifier for the webset.

You can use this to reference the Webset by your own internal identifiers.

Maximum string length: 300
​
metadata
object

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

​
title
string | null

Optional name that appears anywhere the Webset is displayed. Leave empty to have Exa generate one automatically based on the search query or import content.

Minimum string length: 1
Example:

"Leading climate tech startups"

Response

Webset created

​
id
string
required

The unique identifier for the webset

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

The status of the webset

Available options:
idle,
pending,
running,
paused
​
externalId
string | null
required

The external identifier for the webset

​
title
string | null
required

The title of the webset

​
searches
object[]
required

The searches that have been performed on the webset.

​
imports
object[]
required

Imports that have been performed on the webset.

​
enrichments
object[]
required

The Enrichments to apply to the Webset Items.

​
monitors
object[]
required

The Monitors for the Webset.

​
createdAt
string<date-time>
required

The date and time the webset was created

​
updatedAt
string<date-time>
required

The date and time the webset was updated

​
excludes
object[]

The Excludes sources (existing imports or websets) that apply to all operations within this Webset. Any results found within these sources will be omitted across all search and import operations.

​
metadata
object

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