Start a scan
start_scanRun a scan: every active prompt (or the ones chosen) is asked of every connected assistant with web search on, and the answers are stored and analysed. Spends the workspace balance, so call estimate_scan first; budgetUsd stops the run once its price passes that amount. Needs an admin token. Returns the scan with its id; follow it with get_live_scan.
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": {
"projectId": "<projectId>"
},
"name": "start_scan"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | A name to tell this scan apart in list_scans. | |
| queue | No | Wait for the worker instead of running at once: the answers arrive within hours and cost less (the queue price). Scheduled scans always do. | |
| models | No | Assistant key => model, e.g. {"openai":"gpt-5.4-mini"}. "chatgpt-app" and "gemini-app" take the answer as the app shows it. | |
| sample | No | Scan only N prompts, drawn at random. | |
| repeats | No | How many times to ask each question of each assistant (1–5). One answer is one draw; several show the spread, and the price follows. | |
| category | No | Scan one category only — the cheapest useful scan. | |
| budgetUsd | No | Stop the scan once its price passes this many US dollars. | |
| projectId | Yes | The project id, from list_projects. | |
| promptIds | No | A hand-picked set. Empty = every active prompt. | |
| providers | No | Which assistants to ask (google_aio = Google AI Overviews, google_ai_mode = Google AI Mode). Empty = every connected one the site allows; the workspace owner chooses those per site. |