Skip to main content
GET
/
v0
/
events
/
{id}
cURL
curl --request GET \
  --url https://api.exa.ai/websets/v0/events/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "object": "event",
  "type": "webset.created",
  "data": {
    "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,
        "maxPeoplePerCompany": 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": {}
  },
  "createdAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://exa.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Your Exa API key

Path Parameters

id
string
required

The id of the event

Response

id
string
required

The unique identifier for the event

object
string
default:event
required
Allowed value: "event"
type
string
default:webset.created
required
Allowed value: "webset.created"
data
object
required
createdAt
string<date-time>
required

The date and time the event was created