Follow a long-running job
get_jobCheck on a crawl, run, batch, web search or agent run a tool handed back as a job, and return its result once finished. Call it when a tool answered with status 'running' and a job; repeating that tool is not needed. To stop a crawl, run, batch or agent run use cancel_job. For a project's stored pages use list_pages. Inputs: kind, id and project_id come from the 'job' object; a crawl_site crawl_id is a crawl's id. For a crawl, url reads one page in full, even mid-crawl, and cursor from the last answer reads the next window. Behaviour: it answers at once and never waits, so call it again every 10 to 30 seconds while the status is 'running', or every 30 to 60 for an agent run. A finished crawl answers as crawl_site does (up to 50 pages excerpted per window), a batch as scrape_urls, a search as search_web, an agent run as run_agent, a run with its record. A scraping search whose pages are still landing answers with its results and the job. A crawl expires a day after it started unless kept, then answers 404; an agent run is kept 7 days, then answers with status 'expired'. Read-only and free: it reads stored data and never fetches.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"kind": "<kind>",
"id": "<id>"
},
"name": "get_job"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The job's id. | |
| url | No | Crawls only: one page's URL from the crawl's index. | |
| kind | Yes | 'crawl' (crawl_site), 'run' (start_run), 'batch' (scrape_urls), 'extract' (scrape_urls with full=true), 'search' (search_web) or 'agent' (run_agent or continue_agent). | |
| cursor | No | Crawls only: the cursor the previous answer returned. | |
| project_id | No | A run's project id; required for a run, ignored otherwise. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | A run, a search or an agent run: its id. | |
| job | No | While running: {kind, id, project_id} to call again with. | |
| code | No | Only on a failure: a machine-readable reason, e.g. read_only, validation, plan_limit or not_found. | |
| data | No | A finished agent run: its answer, JSON matching the schema or {text}; {partial} at credit_limit. | |
| note | No | What to do next. | |
| error | No | Only when the call failed: what went wrong, in words an assistant can act on. | |
| index | No | A finished crawl or batch: every page as {url, title, words, status}. | |
| pages | No | A finished crawl or batch: pages with excerpts. | |
| steps | No | An agent run: the steps it has taken. | |
| budget | No | An agent run: the most it may spend. | |
| counts | No | Pages by outcome so far. | |
| cursor | No | A crawl with more pages: pass it back for the next window. | |
| detail | No | Only on a failure: the API's own wording, when the error was rephrased. | |
| notice | No | Only when a limit, not the site, held pages back: one line saying what they needed and why (the plan, the stealth trial or the credits left). Tell the person; it comes first in the answer. | |
| status | No | 'running' while it goes on; otherwise the finished job's status; 'expired' for an agent run past its keep date. On an error, the HTTP status code. | |
| notices | No | With `notice`: one per reason, {reason, pages, needs, examples, unlockedBy, upgradeUrl}, `engine` on a search's and `outlook` {tier, likely, why} on a page's; unlockedBy is the plan that reads them, null for credits or a cap the workspace set itself. | |
| results | No | A search: the ranked results, as search_web returns them, with page excerpts when it scraped. | |
| sources | No | A finished agent run: the pages its answer rests on, each {url, title, pageId}. | |
| crawl_id | No | A crawl: its id. | |
| markdown | No | With url: that page's markdown, capped at 12,000 characters. | |
| stopReason | No | A finished agent run: why it stopped early, e.g. credit_limit, step_limit or cancelled; empty when it finished on its own. | |
| creditsUsed | No | An agent run: credits spent so far, pages and model tokens. | |
| fieldSources | No | A finished agent run: where each value of data came from, its path (e.g. 'plans[0].price') to {url, pageId}; left out first when the answer is too long. |