API
- Overview
- Get started
- How It Works
- Core
- Websets
- Items
- Searches
- Enrichments
- Imports
- Monitors
- Webhooks
- Events
Websets
Get a Webset
GET
/
v0
/
websets
/
{id}
Copy
Ask AI
curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{id} \
--header 'x-api-key: <api-key>'
Copy
Ask AI
{
"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,
"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",
"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",
"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"
}
]
}
Authorizations
Your Exa API key
Path Parameters
The id or externalId of the Webset.
Query Parameters
Expand the response with the specified resources
Show child attributes
Show child attributes
Response
200
application/json
Webset
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{id} \
--header 'x-api-key: <api-key>'
Copy
Ask AI
{
"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,
"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",
"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",
"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"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.