Skip to main content
DELETE
No further runs start. Results found so far stay readable. A run that is already in progress finishes. To stop that run as well, cancel the search, which also removes the schedule.

Path parameters

string
required
The search’s id, returned when it was started.

Response

200 The search, with monitor set to null.
string
required
company_search or people_search.
string
required
The search’s identifier. Use it to read status and results.
string
required
queued and running are in progress. completed, failed and cancelled are terminal. completed means this run finished, not that every matching record in the world was found. A monitored search goes back to running at its next scheduled run.
string | null
required
Why a finished search stopped. null while it is in progress. Can also be null on a failed search; read error.Options: target_reached, sources_exhausted, usage_limit_reached, retrieval_limit_reached, query_needs_clarification, provider_failed, cancelled.
string | null
required
A message when status is failed. Results found before the failure stay readable.
string | null
required
The natural-language request, when the search was started with query.
integer
required
The most results this search will return.
object | null
required
How a query was read. null until the query has been interpreted, and for searches started with filters or criteria.
object[]
required
Ambiguous wording in the query and how it was read.
object
required
Counts so far. They only increase.
number
required
What this search has cost so far, in US dollars, including the 5% platform fee.
boolean
required
true after a cancel request, until the search reaches cancelled.
object | null
required
The schedule, when the search is monitored. null for a search that runs once. On a monitored search, status and stop_reason describe the most recent run, and progress and cost_usd are totals across all runs.
string
required
When the search was started.
string | null
required
When the search reached a terminal status.
string | null
required
When the search and its results stop being readable. null when no expiry is set.
string
required
The URL of this search’s status.
string
required
The URL of this search’s results.

Errors

Every error uses the same shape. See Errors.