cURL
curl --request GET \
--url https://api.exa.ai/websets/v0/websets \
--header 'x-api-key: <api-key>'# pip install exa-py
from exa_py import Exa
exa = Exa("YOUR_EXA_API_KEY")
# List websets with optional pagination
websets_response = exa.websets.list(
limit=20 # Optional: max results per page
)
print(f"Found {len(websets_response.data)} websets")
for webset in websets_response.data:
print(f"- {webset.id}: {webset.status}")// npm install exa-js
import Exa from "exa-js";
const exa = new Exa("YOUR_EXA_API_KEY");
// List websets with optional pagination
const websets = await exa.websets.list({
limit: 20, // Optional: max results per page
});
console.log(`Found ${websets.data.length} websets`);
websets.data.forEach((webset) => {
console.log(`- ${webset.id}: ${webset.status}`);
});{
"data": [
{
"id": "<string>",
"object": "webset",
"externalId": "<string>",
"title": "<string>",
"searches": [
{
"id": "<string>",
"object": "webset_search",
"websetId": "<string>",
"query": "<string>",
"entity": {
"type": "company"
},
"criteria": [
{
"description": "<string>",
"successRate": 50
}
],
"count": 2,
"maxPeoplePerCompany": 2,
"exclude": [
{
"id": "<string>"
}
],
"scope": [
{
"id": "<string>",
"relationship": {
"definition": "<string>",
"limit": 5.5
}
}
],
"progress": {
"found": 123,
"analyzed": 123,
"completion": 50,
"timeLeft": 123
},
"recall": {
"expected": {
"total": 123,
"bounds": {
"min": 123,
"max": 123
}
},
"reasoning": "<string>"
},
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"behavior": "override",
"metadata": {}
}
],
"imports": [
{
"id": "<string>",
"object": "import",
"entity": {
"type": "company"
},
"title": "<string>",
"count": 123,
"metadata": {},
"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",
"websetId": "<string>",
"title": "<string>",
"description": "<string>",
"options": [
{
"label": "<string>"
}
],
"instructions": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"monitors": [
{
"id": "<string>",
"object": "monitor",
"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",
"monitorId": "<string>",
"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"
}
],
"dashboardUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"excludes": [
{
"id": "<string>"
}
],
"metadata": {}
}
],
"hasMore": true,
"nextCursor": "<string>"
}Websets
List all Websets
Returns a list of Websets.
You can paginate through the results using the cursor parameter.
You can filter results using the search parameter to find Websets by ID, external ID, or title.
GET
/
v0
/
websets
cURL
curl --request GET \
--url https://api.exa.ai/websets/v0/websets \
--header 'x-api-key: <api-key>'# pip install exa-py
from exa_py import Exa
exa = Exa("YOUR_EXA_API_KEY")
# List websets with optional pagination
websets_response = exa.websets.list(
limit=20 # Optional: max results per page
)
print(f"Found {len(websets_response.data)} websets")
for webset in websets_response.data:
print(f"- {webset.id}: {webset.status}")// npm install exa-js
import Exa from "exa-js";
const exa = new Exa("YOUR_EXA_API_KEY");
// List websets with optional pagination
const websets = await exa.websets.list({
limit: 20, // Optional: max results per page
});
console.log(`Found ${websets.data.length} websets`);
websets.data.forEach((webset) => {
console.log(`- ${webset.id}: ${webset.status}`);
});{
"data": [
{
"id": "<string>",
"object": "webset",
"externalId": "<string>",
"title": "<string>",
"searches": [
{
"id": "<string>",
"object": "webset_search",
"websetId": "<string>",
"query": "<string>",
"entity": {
"type": "company"
},
"criteria": [
{
"description": "<string>",
"successRate": 50
}
],
"count": 2,
"maxPeoplePerCompany": 2,
"exclude": [
{
"id": "<string>"
}
],
"scope": [
{
"id": "<string>",
"relationship": {
"definition": "<string>",
"limit": 5.5
}
}
],
"progress": {
"found": 123,
"analyzed": 123,
"completion": 50,
"timeLeft": 123
},
"recall": {
"expected": {
"total": 123,
"bounds": {
"min": 123,
"max": 123
}
},
"reasoning": "<string>"
},
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"behavior": "override",
"metadata": {}
}
],
"imports": [
{
"id": "<string>",
"object": "import",
"entity": {
"type": "company"
},
"title": "<string>",
"count": 123,
"metadata": {},
"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",
"websetId": "<string>",
"title": "<string>",
"description": "<string>",
"options": [
{
"label": "<string>"
}
],
"instructions": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"monitors": [
{
"id": "<string>",
"object": "monitor",
"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",
"monitorId": "<string>",
"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"
}
],
"dashboardUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"excludes": [
{
"id": "<string>"
}
],
"metadata": {}
}
],
"hasMore": true,
"nextCursor": "<string>"
}Authorizations
apiKeybearer
Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .
Query Parameters
The cursor to paginate through the results
Minimum string length:
1The number of Websets to return
Required range:
1 <= x <= 100Search term to filter Websets by ID, external ID, or title
Required string length:
2 - 50⌘I