Create a scout
heliyos_scouts_createCreates a scout and runs a preview of its query while keeping it inactive. Confirm it afterward with the update tool to activate monitoring on your watchlist, selected companies, or the entire web.
Instructions
Creates a custom scout and starts a preview run of its query. The scout stays inactive until you confirm it: when heliyos_scouts_get shows preview completed, call heliyos_scouts_update with state "confirmed" to activate it on its companies. apply_to: watchlist (every watched company, the default), selected_watchlist (only selected_company_ids, which must be watched companies) or entire_web. The scope cannot be changed later. Scout runs use credits. Calling this twice creates two scouts. Returns structuredContent {scout}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Scout name. | |
| query | Yes | What to look for, in plain language. For watchlist scopes write it about "the company"; each company's name and website are added when it runs. For entire_web, describe the event anywhere on the web. | |
| effort | No | Search depth: low, medium (default) or high. Higher effort costs more credits per run. | |
| cadence | No | How often it runs: daily, weekly (default) or monthly. | |
| apply_to | No | watchlist (default), selected_watchlist or entire_web. Fixed once created. | |
| category | Yes | A short category label, for example "Funding" or "Hiring". | |
| preview_company | No | selected_watchlist only: the company the preview runs on. | |
| preview_lookback | No | How far back the preview searches: 1_month (default), 3_months or 6_months. | |
| selected_company_ids | No | Watched company record ids the scout runs on (only with apply_to selected_watchlist). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scout | Yes |