Cancel a search

POST

{id}

cancel

Cancel a search

curl --request POST \
  --url https://api.thred.dev/search/{id}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thred.dev/search/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "search_15b2a4b8-fabc-41cc-8e38-2a4763db600e",
  "query": "Where can I buy a Nintendo Switch 2 in Austin today?",
  "status": "canceling",
  "environment": "development",
  "identity": {
    "name": "AI assistant"
  },
  "call_reason": "public",
  "requested_calls": 2,
  "selected_businesses": 2,
  "attempted_calls": 1,
  "answered_calls": 0,
  "published_results": 0,
  "discovery_shortfall": 0,
  "created_at": "2026-11-12T15:00:00Z",
  "deadline_at": "2026-11-12T15:30:00Z",
  "finished_at": null,
  "terminal": false,
  "cancellation_requested": true,
  "stop_reason": "canceled",
  "error": null
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Stop remaining work for a search. No request body is required, and published results remain available. The API returns HTTP 202. Poll the search until terminal is true. Repeating cancellation is safe.

Authorizations

Authorization

string

header

required

Send Authorization: Bearer <THRED_API_KEY>. Development keys begin thr_dev_; Production keys begin thr_prod_. Each key is scoped to a workspace and environment. Keep secrets on your server.

Path Parameters

string

required

Search ID returned by POST /search.

Pattern: ^search_[a-z0-9-]+$

Response

Cancellation requested or terminal search returned.

string

required

Search ID returned when the request was accepted.

Pattern: ^search_[a-z0-9-]+$

Example:

"search_6c479a30-cf06-4dba-8dc9-2d2893bbc64f"

query

string

required

Example:

"Where can I buy a Nintendo Switch 2 in Austin today?"

status

enum<string>

required

Current search state. completed, failed, canceled, and expired are terminal.

Available options:

discovering,

running,

canceling,

completed,

failed,

canceled,

expired

environment

enum<string>

required

Available options:

development,

production

identity

object

required

Show child attributes

call_reason

enum<string>

required

Available options:

public,

customer

requested_calls

integer

required

The call-attempt limit supplied in the request results field.

Required range: 1 <= x <= 100

selected_businesses

integer

required

Number of selected sources.

Required range: x >= 0

attempted_calls

integer

required

Number of sources where starting a call was attempted.

Required range: x >= 0

answered_calls

integer

required

Calls answered by the destination, including automated answering systems.

Required range: x >= 0

published_results

integer

required

Number of published result entries available from the results endpoint.

Required range: x >= 0

discovery_shortfall

integer | null

required

Requested calls minus selected sources, bounded at zero. Null until source selection has finished.

Required range: x >= 0

created_at

string<date-time>

required

deadline_at

string<date-time>

required

New dialing stops after 30 minutes. Active calls are canceled; post-call processing may finish later.

finished_at

string<date-time> | null

required

When the search reached a terminal state; null while work is in progress.

terminal

boolean

required

Whether all work has settled and no more results will be published.

cancellation_requested

boolean

required

Whether cancellation was requested for this search.

stop_reason

string | null

required

Reason work was stopped early, when present; null for normal completion.

error

object | null

required

Search-level failure details, or null when no search-level error was recorded.

Show child attributes

Cancel a search

curl --request POST \
  --url https://api.thred.dev/search/{id}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thred.dev/search/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "search_15b2a4b8-fabc-41cc-8e38-2a4763db600e",
  "query": "Where can I buy a Nintendo Switch 2 in Austin today?",
  "status": "canceling",
  "environment": "development",
  "identity": {
    "name": "AI assistant"
  },
  "call_reason": "public",
  "requested_calls": 2,
  "selected_businesses": 2,
  "attempted_calls": 1,
  "answered_calls": 0,
  "published_results": 0,
  "discovery_shortfall": 0,
  "created_at": "2026-11-12T15:00:00Z",
  "deadline_at": "2026-11-12T15:30:00Z",
  "finished_at": null,
  "terminal": false,
  "cancellation_requested": true,
  "stop_reason": "canceled",
  "error": null
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Get started

Search API

Guides

Account and utilities

Cancel a search

Authorizations

Path Parameters

Response