curl --request POST \
--url https://api.exa.ai/websets/v0/websets/{webset}/searches \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"count": 2,
"query": "Marketing agencies based in the US, that focus on consumer products. Get brands worked with and city",
"entity": {
"type": "company"
},
"criteria": [
{
"description": "<string>"
}
],
"exclude": [
{
"source": "import",
"id": "<string>"
}
],
"scope": [
{
"source": "import",
"id": "<string>",
"relationship": {
"definition": "<string>",
"limit": 5.5
}
}
],
"recall": true,
"behavior": "override",
"metadata": {}
}'
{
"id": "<string>",
"object": "webset_search",
"status": "created",
"websetId": "<string>",
"query": "<string>",
"entity": {
"type": "company"
},
"criteria": [
{
"description": "<string>",
"successRate": 50
}
],
"count": 2,
"behavior": "override",
"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>"
},
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"canceledReason": "webset_deleted",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
Creates a new Search for the Webset.
The default behavior is to reuse the previous Search results and evaluate them against the new criteria.
curl --request POST \
--url https://api.exa.ai/websets/v0/websets/{webset}/searches \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"count": 2,
"query": "Marketing agencies based in the US, that focus on consumer products. Get brands worked with and city",
"entity": {
"type": "company"
},
"criteria": [
{
"description": "<string>"
}
],
"exclude": [
{
"source": "import",
"id": "<string>"
}
],
"scope": [
{
"source": "import",
"id": "<string>",
"relationship": {
"definition": "<string>",
"limit": 5.5
}
}
],
"recall": true,
"behavior": "override",
"metadata": {}
}'
{
"id": "<string>",
"object": "webset_search",
"status": "created",
"websetId": "<string>",
"query": "<string>",
"entity": {
"type": "company"
},
"criteria": [
{
"description": "<string>",
"successRate": 50
}
],
"count": 2,
"behavior": "override",
"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>"
},
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"canceledReason": "webset_deleted",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
Your Exa API key
The id of the Webset
Webset Search created
The response is of type object
.