Dashboard
API
- Overview
- Get started
- How It Works
- Core
- Websets
- Items
- Searches
- Enrichments
- Imports
- Monitors
- Webhooks
- Events
Websets
Create a Webset
Creates a new Webset with optional search, import, and enrichment configurations. The Webset will automatically begin processing once created.
You can specify an externalId
to reference the Webset with your own identifiers for easier integration.
POST
/
v0
/
websets
Copy
Ask AI
curl --request POST \
--url https://api.exa.ai/websets/v0/websets \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"search": {
"query": "Marketing agencies based in the US, that focus on consumer products.",
"count": 10
}
}'
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,
"completion": 50
},
"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>",
"teamId": "<string>",
"title": "<string>",
"status": "created",
"uri": "<string>",
"format": "csv",
"metadata": {},
"websetId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"count": 123,
"entity": {
"type": "company",
"description": "A homepage of a company"
}
}
],
"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"
}
Authorizations
Your Exa API key
Body
application/json
Response
201
application/json
Webset created
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://api.exa.ai/websets/v0/websets \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"search": {
"query": "Marketing agencies based in the US, that focus on consumer products.",
"count": 10
}
}'
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,
"completion": 50
},
"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>",
"teamId": "<string>",
"title": "<string>",
"status": "created",
"uri": "<string>",
"format": "csv",
"metadata": {},
"websetId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"count": 123,
"entity": {
"type": "company",
"description": "A homepage of a company"
}
}
],
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.