Create a Webset

curl --request POST \
  --url https://api.exa.ai/websets/v0/websets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "import": [
    {
      "id": "<string>",
      "evaluate": true
    }
  ],
  "enrichments": [
    {
      "description": "<string>",
      "options": [
        {
          "label": "<string>"
        }
      ],
      "metadata": {}
    }
  ],
  "exclude": [
    {
      "id": "<string>"
    }
  ],
  "externalId": "<string>",
  "metadata": {}
}
'

{
  "id": "<string>",
  "object": "webset",
  "externalId": "<string>",
  "title": "<string>",
  "searches": [
    {
      "id": "<string>",
      "object": "webset_search",
      "websetId": "<string>",
      "query": "<string>",
      "entity": {
        "type": "company"
      },
      "criteria": [
        {
          "description": "<string>",
          "successRate": 50
        }
      ],
      "count": 2,
      "maxPeoplePerCompany": 2,
      "exclude": [
        {
          "id": "<string>"
        }
      ],
      "scope": [
        {
          "id": "<string>",
          "relationship": {
            "definition": "<string>",
            "limit": 5.5
          }
        }
      ],
      "progress": {
        "found": 123,
        "analyzed": 123,
        "completion": 50,
        "timeLeft": 123
      },
      "recall": {
        "expected": {
          "total": 123,
          "bounds": {
            "min": 123,
            "max": 123
          }
        },
        "reasoning": "<string>"
      },
      "canceledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "behavior": "override",
      "metadata": {}
    }
  ],
  "imports": [
    {
      "id": "<string>",
      "object": "import",
      "entity": {
        "type": "company"
      },
      "title": "<string>",
      "count": 123,
      "metadata": {},
      "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",
      "websetId": "<string>",
      "title": "<string>",
      "description": "<string>",
      "options": [
        {
          "label": "<string>"
        }
      ],
      "instructions": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "monitors": [
    {
      "id": "<string>",
      "object": "monitor",
      "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",
        "monitorId": "<string>",
        "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"
    }
  ],
  "dashboardUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "excludes": [
    {
      "id": "<string>"
    }
  ],
  "metadata": {}
}

POST

websets

curl --request POST \
  --url https://api.exa.ai/websets/v0/websets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "import": [
    {
      "id": "<string>",
      "evaluate": true
    }
  ],
  "enrichments": [
    {
      "description": "<string>",
      "options": [
        {
          "label": "<string>"
        }
      ],
      "metadata": {}
    }
  ],
  "exclude": [
    {
      "id": "<string>"
    }
  ],
  "externalId": "<string>",
  "metadata": {}
}
'

{
  "id": "<string>",
  "object": "webset",
  "externalId": "<string>",
  "title": "<string>",
  "searches": [
    {
      "id": "<string>",
      "object": "webset_search",
      "websetId": "<string>",
      "query": "<string>",
      "entity": {
        "type": "company"
      },
      "criteria": [
        {
          "description": "<string>",
          "successRate": 50
        }
      ],
      "count": 2,
      "maxPeoplePerCompany": 2,
      "exclude": [
        {
          "id": "<string>"
        }
      ],
      "scope": [
        {
          "id": "<string>",
          "relationship": {
            "definition": "<string>",
            "limit": 5.5
          }
        }
      ],
      "progress": {
        "found": 123,
        "analyzed": 123,
        "completion": 50,
        "timeLeft": 123
      },
      "recall": {
        "expected": {
          "total": 123,
          "bounds": {
            "min": 123,
            "max": 123
          }
        },
        "reasoning": "<string>"
      },
      "canceledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "behavior": "override",
      "metadata": {}
    }
  ],
  "imports": [
    {
      "id": "<string>",
      "object": "import",
      "entity": {
        "type": "company"
      },
      "title": "<string>",
      "count": 123,
      "metadata": {},
      "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",
      "websetId": "<string>",
      "title": "<string>",
      "description": "<string>",
      "options": [
        {
          "label": "<string>"
        }
      ],
      "instructions": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "monitors": [
    {
      "id": "<string>",
      "object": "monitor",
      "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",
        "monitorId": "<string>",
        "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"
    }
  ],
  "dashboardUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "excludes": [
    {
      "id": "<string>"
    }
  ],
  "metadata": {}
}

Authorizations

x-api-key

string

header

required

Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .

Body

application/json

title

string | null

Optional name that appears anywhere the Webset is displayed. Leave empty to have Exa generate one automatically.

Minimum string length: 1

Example:

"Leading climate tech startups"

object

Create initial search for the Webset.

Show child attributes

import

object[]

Import data from existing Websets and Imports into this Webset.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

Response

Webset created

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.

Show child attributes

imports

object[]

required

Imports that have been performed on the webset.

Show child attributes

enrichments

object[]

required

The Enrichments to apply to the Webset Items.

Show child attributes

monitors

object[]

required

The Monitors for the Webset.

Show child attributes

dashboardUrl

string<uri>

required

The URL to view the webset in the Exa dashboard

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.

Show child attributes

metadata

object

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

Show child attributes

⌘I

Search

Agent

Websets

Monitors

Team Management

Create a Webset

Authorizations

Body

Response