Get a Webset
curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.exa.ai/websets/v0/websets/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.exa.ai/websets/v0/websets/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"object": "webset",
"status": "idle",
"externalId": "<string>",
"title": "<string>",
"searches": [
{
"id": "<string>",
"object": "webset_search",
"websetId": "<string>",
"status": "created",
"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": {
"config": {
"count": 123,
"query": "<string>",
"criteria": [
{
"description": "<string>"
}
],
"entity": {
"type": "company"
},
"behavior": "append"
},
"type": "search"
},
"lastRun": {
"id": "<string>",
"object": "monitor_run",
"monitorId": "<string>",
"status": "created",
"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",
"type": "search"
},
"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": [
{
"source": "import",
"id": "<string>"
}
],
"metadata": {},
"items": [
{
"id": "<string>",
"object": "webset_item",
"source": "search",
"sourceId": "<string>",
"websetId": "<string>",
"properties": {
"url": "<string>",
"description": "<string>",
"person": {
"name": "<string>",
"location": "<string>",
"position": "<string>",
"company": {
"name": "<string>",
"location": "<string>"
},
"pictureUrl": "<string>",
"workHistory": [
{
"title": "<string>",
"location": "<string>",
"dates": {
"from": "<string>",
"to": "<string>"
},
"company": {
"id": "<string>",
"name": "<string>",
"linkedinUrl": "<string>"
}
}
],
"educationHistory": [
{
"degree": "<string>",
"dates": {
"from": "<string>",
"to": "<string>"
},
"institution": {
"id": "<string>",
"name": "<string>",
"linkedinUrl": "<string>"
}
}
]
},
"type": "person"
},
"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",
"sourceEntityId": "<string>",
"scopeId": "<string>"
}
]
}Websets
Get a webset
Returns a Webset by id or externalId, including its status, searches, imports, enrichments, and monitors.
Pass expand=items to include up to the first 100 items in the response.
Get a Webset
curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.exa.ai/websets/v0/websets/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.exa.ai/websets/v0/websets/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"object": "webset",
"status": "idle",
"externalId": "<string>",
"title": "<string>",
"searches": [
{
"id": "<string>",
"object": "webset_search",
"websetId": "<string>",
"status": "created",
"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": {
"config": {
"count": 123,
"query": "<string>",
"criteria": [
{
"description": "<string>"
}
],
"entity": {
"type": "company"
},
"behavior": "append"
},
"type": "search"
},
"lastRun": {
"id": "<string>",
"object": "monitor_run",
"monitorId": "<string>",
"status": "created",
"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",
"type": "search"
},
"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": [
{
"source": "import",
"id": "<string>"
}
],
"metadata": {},
"items": [
{
"id": "<string>",
"object": "webset_item",
"source": "search",
"sourceId": "<string>",
"websetId": "<string>",
"properties": {
"url": "<string>",
"description": "<string>",
"person": {
"name": "<string>",
"location": "<string>",
"position": "<string>",
"company": {
"name": "<string>",
"location": "<string>"
},
"pictureUrl": "<string>",
"workHistory": [
{
"title": "<string>",
"location": "<string>",
"dates": {
"from": "<string>",
"to": "<string>"
},
"company": {
"id": "<string>",
"name": "<string>",
"linkedinUrl": "<string>"
}
}
],
"educationHistory": [
{
"degree": "<string>",
"dates": {
"from": "<string>",
"to": "<string>"
},
"institution": {
"id": "<string>",
"name": "<string>",
"linkedinUrl": "<string>"
}
}
]
},
"type": "person"
},
"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",
"sourceEntityId": "<string>",
"scopeId": "<string>"
}
]
}Authorizations
apiKeybearer
Query Parameters
Response
Webset