For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Overview
    • API reference
  • Search
    • POSTSearch
    • GETSearch Run List
    • GETSearch Run Get
    • GETSearch Run Events
    • POSTSearch Run Cancel
  • Extract
    • GETExtract a URL
    • POSTExtract
  • Monitors
    • GETList monitors
    • POSTCreate monitor
    • GETRetrieve monitor
    • DELDelete monitor
    • PATCHUpdate monitor
    • GETList monitor events
    • POSTMonitor Pause
    • POSTMonitor Resume
    • POSTRun monitor
  • Tasks
    • POSTTask
    • POSTCreate task run
    • GETRetrieve task run
    • GETStream task run events
    • GETTask List
    • GETTask Get
    • GETTask Events
    • POSTTask Cancel
  • Chat
    • POSTChat completion
  • Find All
    • POSTFindAll
    • GETFindall Run List
    • POSTCreate FindAll run
    • GETRetrieve FindAll run
    • GETStream FindAll run events
    • POSTCancel FindAll run
    • POSTExtend FindAll run
    • POSTEnrich FindAll run
LogoLogo
Search

Search Run Cancel

||View as Markdown|
POST
https://core.usescout.sh/v1/searches/:search_id/cancel
POST
/v1/searches/:search_id/cancel
$curl -X POST https://core.usescout.sh/v1/searches/search_id/cancel \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "search_id": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
3  "status": "cancelled",
4  "queries": [
5    "latest electric vehicle market trends"
6  ],
7  "limit": 50,
8  "depth": "deep",
9  "country": "us",
10  "language": "en",
11  "createdAt": "2024-06-10T09:15:00Z",
12  "completedAt": null,
13  "credits": 3,
14  "results": [
15    {
16      "title": "Electric Vehicle Market Growth in 2024",
17      "url": "https://example.com/ev-market-growth-2024",
18      "snippet": "The electric vehicle market is expected to grow by 20% in 2024, driven by new government policies and consumer demand."
19    }
20  ],
21  "pagesFetched": 5,
22  "pagesTarget": 10,
23  "error": null,
24  "report": "## Market Overview\nThe electric vehicle market shows strong growth potential with increasing adoption rates. [1]\n\n[1]: https://example.com/ev-market-report",
25  "findings": [
26    {
27      "subquery": "electric vehicle market growth",
28      "answer": "Projected 20% growth in 2024",
29      "citations": [
30        "https://example.com/ev-market-growth-2024"
31      ],
32      "confidence": 0.92,
33      "evidence": "Multiple industry reports confirm growth projections."
34    }
35  ],
36  "sources": [
37    {
38      "index": 1,
39      "url": "https://example.com/ev-market-growth-2024",
40      "title": "Electric Vehicle Market Growth in 2024",
41      "domain": "example.com",
42      "fetched": "2024-06-10T09:20:00Z",
43      "quality": "high",
44      "first_seen_subquery": "electric vehicle market growth"
45    }
46  ],
47  "usage": {
48    "planner_calls": 1,
49    "grader_calls": 1,
50    "synth_calls": 1,
51    "search_queries": 3,
52    "pages_fetched": 5,
53    "tokens": 1500
54  },
55  "prompt": "Research the latest trends and growth projections in the electric vehicle market.",
56  "reranked": true
57}

Cancel an async deep-search run. A run mid-flight stops at its next page checkpoint; whatever results were already gathered are kept.

Was this page helpful?
Previous

Search Run Events

Next

Extract a URL

Built with

Authentication

AuthorizationBearer
Your API key, sent as a Bearer token.

Path parameters

search_idstringRequired

Response

Successful Response
search_idstring
Opaque run identifier.
statusstring
queued, running, completed, failed or cancelled.
querieslist of strings
The queries being run.
limitinteger
Max merged results to return.
depthstringDefaults to deep

Always deep for async search.

countrystringDefaults to us

Two-letter country code.

languagestringDefaults to en
UI language code.
createdAtstring or null

ISO-8601 creation timestamp.

completedAtstring or null

ISO-8601 completion timestamp.

creditsintegerDefaults to 0

Credits accrued (one per query, on completion).

resultslist of maps from strings to any

Merged, de-duplicated results. Empty until completed.

pagesFetchedintegerDefaults to 0
SERP pages fetched across all queries so far.
pagesTargetintegerDefaults to 1
Target total SERP pages across all queries.
errorstring or null
Failure reason when status is failed.
reportstring or null

Markdown research report with inline [N] citations.

findingslist of maps from strings to any or null

Per-sub_query findings (subquery, answer, citations, confidence, evidence).

sourceslist of maps from strings to any or null

Numbered sources list (index, url, title, domain, fetched, quality, first_seen_subquery).

usagemap from strings to any or null

Research-engine usage stats (planner_calls, grader_calls, synth_calls, search_queries, pages_fetched, tokens).

promptstring or null

The research question, when the engine was invoked with depth=‘deep’ + research-mode controls.

rerankedbooleanDefaults to false

True iff results were re-ranked against objective by a fast LLM pass for this run.

Errors

422
Unprocessable Entity Error