POST
/
v0
/
websets
/
{webset}
/
searches
/
{id}
/
cancel
cURL
curl --request POST \
  --url https://api.exa.ai/websets/v0/websets/{webset}/searches/{id}/cancel \
  --header 'x-api-key: <api-key>'
{
  "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"
}

Authorizations

​
x-api-key
string
header
required

Your Exa API key

Path Parameters

​
webset
string
required

The id of the Webset

​
id
string
required

The id of the Search

Response

200 - application/json

Search canceled

​
id
string
required

The unique identifier for the search

​
object
string
default:webset_search
required
Allowed value: "webset_search"
​
status
enum<string>
required

The status of the search

Available options:
created,
pending,
running,
completed,
canceled
​
websetId
string
required

The unique identifier for the Webset this search belongs to

​
query
string
required

The query used to create the search.

Required string length: 1 - 5000
​
entity
object
required

The entity the search will return results for.

When no entity is provided during creation, we will automatically select the best entity based on the query.

​
criteria
object[]
required

The criteria the search will use to evaluate the results. If not provided, we will automatically generate them for you.

​
count
number
required

The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity.

Required range: x >= 1
​
exclude
object[]
required

Sources (existing imports or websets) used to omit certain results to be found during the search.

​
scope
object[]
required

The scope of the search. By default, there is no scope - thus searching the web.

If provided during creation, the search will only be performed on the sources provided.

​
progress
object
required

The progress of the search

​
recall
object | null
required

Recall metrics for the search, null if not yet computed or requested.

​
canceledAt
string<date-time> | null
required

The date and time the search was canceled

​
canceledReason
enum<string>
required

The reason the search was canceled

Available options:
webset_deleted,
webset_canceled
​
createdAt
string<date-time>
required

The date and time the search was created

​
updatedAt
string<date-time>
required

The date and time the search was updated

​
behavior
enum<string>

The behavior of the search when it is added to a Webset.

  • override: the search will replace the existing Items found in the Webset and evaluate them against the new criteria. Any Items that don't match the new criteria will be discarded.
  • append: the search will add the new Items found to the existing Webset. Any Items that don't match the new criteria will be discarded.
Available options:
override,
append
​
metadata
object

Set of key-value pairs you want to associate with this object.