List all Websets

GET

websets

curl --request GET \
  --url https://api.exa.ai/websets/v0/websets \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "object": "webset",
      "status": "idle",
      "externalId": "<string>",
      "searches": [
        {
          "id": "<string>",
          "object": "webset_search",
          "status": "created",
          "query": "<string>",
          "entity": {
            "type": "company"
          },
          "criteria": [
            {
              "description": "<string>",
              "successRate": 50
            }
          ],
          "count": 2,
          "progress": {
            "found": 123,
            "completion": 50
          },
          "metadata": {},
          "canceledAt": "2023-11-07T05:31:56Z",
          "canceledReason": "webset_deleted",
          "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>",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

x-api-key

string

header

required

Your Exa API key

Query Parameters

cursor

string

The cursor to paginate through the results

Minimum length: 1

limit

number

default:25

The number of Websets to return

Required range: 1 <= x <= 100

Response

200 - application/json

List of Websets

data

object[]

required

The list of websets

data.id

string

required

The unique identifier for the webset

data.object

string

default:webset

required

Allowed value: "webset"

data.status

enum<string>

required

The status of the webset

Available options:

idle,

running,

paused

data.externalId

string | null

required

The external identifier for the webset

data.searches

object[]

required

The searches that have been performed on the webset.

data.searches.id

string

required

The unique identifier for the search

data.searches.object

string

default:webset_search

required

Allowed value: "webset_search"

data.searches.status

enum<string>

required

The status of the search

Available options:

created,

running,

completed,

canceled

data.searches.query

string

required

The query used to create the search.

Required string length: 1 - 5000

data.searches.entity

object

required

The entity the search will return results for.

When no entity is provided during creation, we will automatically select the best entity based on the query.

data.searches.criteria

object[]

required

The criteria the search will use to evaluate the results. If not provided, we will automatically generate them for you.

data.searches.count

number

required

The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity.

Required range: x >= 1

data.searches.progress

object

required

The progress of the search

data.searches.canceledAt

string | null

required

The date and time the search was canceled

data.searches.canceledReason

enum<string> | null

required

The reason the search was canceled

Available options:

webset_deleted,

webset_canceled

data.searches.createdAt

string

required

The date and time the search was created

data.searches.updatedAt

string

required

The date and time the search was updated

data.searches.metadata

object

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

data.enrichments

object[]

required

The Enrichments to apply to the Webset Items.

data.createdAt

string

required

The date and time the webset was created

data.updatedAt

string

required

The date and time the webset was updated

data.metadata

object

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

hasMore

boolean

required

Whether there are more results to paginate through

nextCursor

string | null

required

The cursor to paginate through the next set of results

Cancel a running Webset Get an Item

curl --request GET \
  --url https://api.exa.ai/websets/v0/websets \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "object": "webset",
      "status": "idle",
      "externalId": "<string>",
      "searches": [
        {
          "id": "<string>",
          "object": "webset_search",
          "status": "created",
          "query": "<string>",
          "entity": {
            "type": "company"
          },
          "criteria": [
            {
              "description": "<string>",
              "successRate": 50
            }
          ],
          "count": 2,
          "progress": {
            "found": 123,
            "completion": 50
          },
          "metadata": {},
          "canceledAt": "2023-11-07T05:31:56Z",
          "canceledReason": "webset_deleted",
          "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>",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Getting Started

Dashboard

API

List all Websets

Authorizations

Query Parameters

Response