GET
/
v0
/
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>",
      "title": "<string>",
      "searches": [
        {
          "id": "<string>",
          "object": "webset_search",
          "status": "created",
          "query": "<string>",
          "entity": {
            "type": "company"
          },
          "criteria": [
            {
              "description": "<string>",
              "successRate": 50
            }
          ],
          "count": 2,
          "behavior": "override",
          "exclude": [
            {
              "source": "import",
              "id": "<string>"
            }
          ],
          "progress": {
            "found": 123,
            "analyzed": 123,
            "completion": 50,
            "timeLeft": 123
          },
          "recall": {
            "expected": {
              "total": 123,
              "confidence": "high",
              "bounds": {
                "min": 123,
                "max": 123
              }
            },
            "reasoning": "<string>"
          },
          "metadata": {},
          "canceledAt": "2023-11-07T05:31:56Z",
          "canceledReason": "webset_deleted",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "imports": [
        {
          "id": "<string>",
          "object": "import",
          "status": "pending",
          "format": "csv",
          "entity": {
            "type": "<string>"
          },
          "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>",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "monitors": [
        {
          "id": "<string>",
          "object": "monitor",
          "status": "enabled",
          "websetId": "<string>",
          "cadence": {
            "cron": "<string>",
            "timezone": "Etc/UTC"
          },
          "behavior": {
            "type": "search",
            "config": {
              "query": "<string>",
              "criteria": [
                {
                  "description": "<string>"
                }
              ],
              "entity": {
                "type": "<string>"
              },
              "count": 123,
              "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"
        }
      ],
      "streams": [
        "<any>"
      ],
      "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

The response is of type object.

GET
/
v0
/
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>",
      "title": "<string>",
      "searches": [
        {
          "id": "<string>",
          "object": "webset_search",
          "status": "created",
          "query": "<string>",
          "entity": {
            "type": "company"
          },
          "criteria": [
            {
              "description": "<string>",
              "successRate": 50
            }
          ],
          "count": 2,
          "behavior": "override",
          "exclude": [
            {
              "source": "import",
              "id": "<string>"
            }
          ],
          "progress": {
            "found": 123,
            "analyzed": 123,
            "completion": 50,
            "timeLeft": 123
          },
          "recall": {
            "expected": {
              "total": 123,
              "confidence": "high",
              "bounds": {
                "min": 123,
                "max": 123
              }
            },
            "reasoning": "<string>"
          },
          "metadata": {},
          "canceledAt": "2023-11-07T05:31:56Z",
          "canceledReason": "webset_deleted",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "imports": [
        {
          "id": "<string>",
          "object": "import",
          "status": "pending",
          "format": "csv",
          "entity": {
            "type": "<string>"
          },
          "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>",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "monitors": [
        {
          "id": "<string>",
          "object": "monitor",
          "status": "enabled",
          "websetId": "<string>",
          "cadence": {
            "cron": "<string>",
            "timezone": "Etc/UTC"
          },
          "behavior": {
            "type": "search",
            "config": {
              "query": "<string>",
              "criteria": [
                {
                  "description": "<string>"
                }
              ],
              "entity": {
                "type": "<string>"
              },
              "count": 123,
              "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"
        }
      ],
      "streams": [
        "<any>"
      ],
      "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

The response is of type object.