Skip to main content
GET
/
v0
/
websets
/
{id}
cURL
curl --request GET \
  --url https://api.exa.ai/websets/v0/websets/{id} \
  --header 'x-api-key: <api-key>'
{
  "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>",
      "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>",
      "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>",
        "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": {},
  "items": [
    {
      "id": "<string>",
      "object": "webset_item",
      "sourceId": "<string>",
      "websetId": "<string>",
      "properties": {
        "type": "person",
        "url": "<string>",
        "description": "<string>",
        "person": {
          "name": "<string>",
          "location": "<string>",
          "position": "<string>",
          "company": {
            "name": "<string>",
            "location": "<string>"
          },
          "pictureUrl": "<string>"
        }
      },
      "evaluations": [
        {
          "criterion": "<string>",
          "reasoning": "<string>",
          "references": []
        }
      ],
      "enrichments": [
        {
          "object": "enrichment_result",
          "result": [
            "<string>"
          ],
          "reasoning": "<string>",
          "references": [
            {
              "title": "<string>",
              "snippet": "<string>",
              "url": "<string>"
            }
          ],
          "enrichmentId": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "sourceEntityId": "<string>"
    }
  ]
}

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 .

Path Parameters

​
id
string
required

The id or externalId of the Webset.

Query Parameters

​
expand
enum<string>[]

Expand the response with the specified resources

Available options:
items

Response

Webset

​
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.

​
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.

​
metadata
object

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

​
items
object[]

When expand query parameter contains items, this will contain the items in the webset