curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{id} \
--header 'x-api-key: <api-key>'{
"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,
"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": {},
"items": [
{
"id": "<string>",
"object": "webset_item",
"source": "search",
"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>",
"satisfied": "yes",
"references": []
}
],
"enrichments": [
{
"object": "enrichment_result",
"status": "pending",
"format": "text",
"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"
}
]
}curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{id} \
--header 'x-api-key: <api-key>'{
"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,
"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": {},
"items": [
{
"id": "<string>",
"object": "webset_item",
"source": "search",
"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>",
"satisfied": "yes",
"references": []
}
],
"enrichments": [
{
"object": "enrichment_result",
"status": "pending",
"format": "text",
"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"
}
]
}Your Exa API key
The id or externalId of the Webset.
Expand the response with the specified resources
items Webset
The unique identifier for the webset
"webset"The status of the webset
idle, pending, running, paused The external identifier for the webset
The title of the webset
The searches that have been performed on the webset.
Show child attributes
Imports that have been performed on the webset.
Show child attributes
The Enrichments to apply to the Webset Items.
Show child attributes
The Monitors for the Webset.
Show child attributes
The date and time the webset was created
The date and time the webset was updated
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
Set of key-value pairs you want to associate with this object.
Show child attributes
When expand query parameter contains items, this will contain the items in the webset
Show child attributes