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
Tasks

Task Get

||View as Markdown|
GET
https://core.usescout.sh/v1/tasks/:task_id
GET
/v1/tasks/:task_id
$curl https://core.usescout.sh/v1/tasks/task_id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "task_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3  "run_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4  "status": "completed",
5  "task": "Summarize recent developments in renewable energy",
6  "query": "Summarize recent developments in renewable energy",
7  "credits": 5,
8  "processor": "core",
9  "metadata": {
10    "user": "researcher_42",
11    "priority": "high"
12  },
13  "fields": [
14    "summary",
15    "key_findings",
16    "recommendations"
17  ],
18  "output_schema": {
19    "summary": "string",
20    "key_findings": "array",
21    "recommendations": "array"
22  },
23  "output": {
24    "summary": "Recent advances in solar and wind technologies have significantly improved efficiency and cost-effectiveness.",
25    "key_findings": [
26      "Solar panel efficiency increased by 15% in the last 2 years.",
27      "Offshore wind farms have expanded by 30% globally.",
28      "Battery storage solutions are becoming more affordable."
29    ],
30    "recommendations": [
31      "Invest in solar and wind infrastructure.",
32      "Support research in battery technology.",
33      "Encourage policy incentives for renewable adoption."
34    ]
35  },
36  "basis": [
37    {
38      "field": "summary",
39      "citations": [
40        {
41          "url": "https://www.energynews.com/solar-wind-advances-2024",
42          "title": "Energy News: Solar and Wind Advances 2024",
43          "excerpts": [
44            "Solar panel efficiency has improved by 15% over the past two years.",
45            "Wind energy capacity has grown significantly with new offshore projects."
46          ]
47        }
48      ],
49      "reasoning": "The cited article provides recent statistics and expert analysis supporting the summary.",
50      "confidence": "high"
51    }
52  ],
53  "usage": {
54    "tool_calls": 3,
55    "search_queries": 5,
56    "pages_fetched": 12,
57    "tokens": {
58      "input": 450,
59      "output": 320
60    },
61    "planner_calls": 1,
62    "grader_calls": 1,
63    "synth_calls": 2,
64    "scratchpad_mode": null,
65    "scratchpad_chunks_indexed": 0,
66    "scratchpad_chunks_used": 0,
67    "scratchpad_searches": 0,
68    "scratchpad_tool_turns": 0
69  },
70  "answer": "Recent developments in renewable energy show significant improvements in solar and wind technologies, with increased efficiency and expanded capacity, alongside advancements in battery storage.",
71  "sources": [
72    "https://www.energynews.com/solar-wind-advances-2024",
73    "https://www.renewableenergyworld.com/latest-updates"
74  ],
75  "read": [
76    "https://www.energynews.com/solar-wind-advances-2024"
77  ],
78  "considered": [
79    "https://www.energynews.com/solar-wind-advances-2024",
80    "https://www.renewableenergyworld.com/latest-updates",
81    "https://www.climateactiontracker.org"
82  ],
83  "error": null,
84  "createdAt": "2024-06-10T09:15:00Z",
85  "completedAt": "2024-06-10T09:17:30Z",
86  "report": "## Renewable Energy Research Report\n\nRecent advances in solar and wind energy have led to significant efficiency gains and cost reductions. Offshore wind farms have expanded globally, and battery storage technologies are becoming more affordable, enabling better integration of renewables into the grid. [1]\n\n[1]: https://www.energynews.com/solar-wind-advances-2024",
87  "findings": [
88    {
89      "subquery": "solar panel efficiency improvements",
90      "answer": "Solar panel efficiency increased by 15% in the last two years.",
91      "citations": [
92        {
93          "url": "https://www.energynews.com/solar-wind-advances-2024",
94          "title": "Energy News: Solar and Wind Advances 2024",
95          "excerpts": [
96            "Solar panel efficiency has improved by 15% over the past two years."
97          ]
98        }
99      ],
100      "confidence": "high",
101      "evidence": "Data from recent industry reports and expert interviews."
102    }
103  ],
104  "sources_detailed": [
105    {
106      "index": 1,
107      "url": "https://www.energynews.com/solar-wind-advances-2024",
108      "title": "Energy News: Solar and Wind Advances 2024",
109      "domain": "energynews.com",
110      "fetched": "2024-06-10T09:16:00Z",
111      "quality": "high",
112      "first_seen_subquery": "solar panel efficiency improvements"
113    }
114  ]
115}

Poll an async task. Returns the current run view (status, partial output, citation basis once completed).

Was this page helpful?
Previous

Task List

Next

Task Events

Built with

Authentication

AuthorizationBearer
Your API key, sent as a Bearer token.

Path parameters

task_idstringRequired

Response

Successful Response
task_idstring

Opaque task identifier (alias of run_id).

run_idstring

Opaque run identifier (alias of task_id).

statusstring
queued, running, completed, failed or cancelled.
taskstring
The objective.
querystring

The objective verbatim (alias of task).

creditsinteger
Cost accumulated by the run.
processorstringDefaults to core

Processor tier used: base | core | ultra.

metadatamap from strings to strings or null

Free-form user metadata, echoed back.

fieldslist of strings

Output field names, derived from output_schema.

output_schemamap from strings to any or null
The requested output spec, if any.
outputany

The answer once completed. For type=json, the parsed JSON object. For text/auto, the string. Null until completed.

basislist of objects

Per-field citation basis (empty until completed).

usageobject or null

Usage stats: tool_calls, search_queries, pages_fetched, tokens.

answerstringDefaults to

The agent’s answer text (empty until completed).

sourceslist of strings

Sample of source URLs the agent read (empty until done).

readlist of strings

Source URLs read in full (empty until completed).

consideredlist of strings

Source URLs considered (empty until completed).

errorstring or null
Failure reason when status is failed.
createdAtstring or null

ISO-8601 creation timestamp.

completedAtstring or null

ISO-8601 completion timestamp.

reportstring or null

Long-form markdown research report with inline [N] citations. Only present for research-tier runs.

findingslist of maps from strings to any or null

Per-sub_query findings ({subquery, answer, citations, confidence, evidence}). Research-tier only.

sources_detailedlist of maps from strings to any or null

Numbered sources list ({index, url, title, domain, fetched, quality, first_seen_subquery}). Research-tier only.

Errors

422
Unprocessable Entity Error