Scouts and signals

Write and destructive tools change your workspace. Clients that support it ask before they run.

​

List scouts

heliyos_scouts_list · Read · Idempotent Lists the workspace’s scouts: the built-in (default) and custom monitors that look for events such as funding, hiring or leadership changes on watched companies or across the web. Shows each scout’s id, whether it is active, its cadence, and how many signals it found (new of total). Returns every scout (there are only a few, so there is no paging). Use heliyos_scouts_get for one scout’s query and recent signals, heliyos_signals_list for what scouts found. Returns structuredContent {scouts:[{id, name, type, is_active, …}]}.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with scouts.

​

API endpoints

• List workspace Scouts · GET /v1/platform/global-scouts

​

Get a scout

heliyos_scouts_get · Read · Idempotent Fetches one scout by id: what it looks for (its query), cadence, effort, scope, whether it is active, its preview state (custom scouts) and its signal counts. “detailed” adds the 5 most recent signals with their ids and the full query. Returns structuredContent {scout, recent_signals?}.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with scout, recent_signals.

​

API endpoints

• Get a workspace Scout · GET /v1/platform/global-scouts/{id}
• List workspace Scout signals · GET /v1/platform/global-scouts/{id}/signals

​

Create a scout

heliyos_scouts_create · Write 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}.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with scout.

​

API endpoints

• Create a custom Scout · POST /v1/platform/global-scouts

​

Update a scout

heliyos_scouts_update · Write · Idempotent Changes a scout’s name, category, query, cadence, effort or selected companies, and/or its state; what you leave out is kept. Changes apply to every company the scout runs on. state: “paused” stops it on every company, “active” resumes it, “confirmed” activates a new custom scout after its preview completed. The scope (apply_to) cannot be changed. To delete a custom scout use heliyos_scouts_delete. Returns structuredContent {scout}.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with scout.

​

API endpoints

• Update a custom Scout · PATCH /v1/platform/global-scouts/{id}
• Set a workspace Scout state · POST /v1/platform/global-scouts/{id}/state

​

Delete a scout

heliyos_scouts_delete · Destructive · Idempotent Permanently deletes one custom scout and stops it on every company it runs on. Built-in (default) scouts cannot be deleted; pause them with heliyos_scouts_update state “paused”. Signals it already found are kept. This cannot be undone: confirm with the user first. Returns structuredContent {scout_id, deleted, deleted_company_scouts}.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with scout_id, deleted, deleted_company_scouts.

​

API endpoints

• Delete a custom Scout · DELETE /v1/platform/global-scouts/{id}

​

List a company’s scouts

heliyos_companies_scouts_list · Read · Idempotent Lists the scouts running on one company: each company scout’s own id, its global scout id (scout_id, for heliyos_scouts_get), status (active, paused or failed), cadence and last run. A company has only a few, so there is no paging. Returns structuredContent {company_id, scouts:[{id, scout_id, name, status, …}]}.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with company_id, scouts.

​

API endpoints

• List company Scouts · GET /v1/platform/companies/{id}/scouts

​

Add scouts to a company

heliyos_companies_scouts_add · Write Starts the given scouts on one company. Each scout_id must be an active global scout with apply_to watchlist (see heliyos_scouts_list). Setup runs in the background; check it with heliyos_companies_scouts_list. A scout already running on the company is not added twice. Scout runs use credits. Returns structuredContent {company_id, scout_ids, status}.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with company_id, scout_ids, status.

​

API endpoints

• Add Scouts to a company · POST /v1/platform/companies/{id}/scouts

​

Remove a company’s scouts

heliyos_companies_scouts_remove · Destructive · Idempotent Stops and removes EVERY scout running on one company (there is no per-scout removal). Signals already found are kept, and the company stays watched. This cannot be undone: confirm with the user first. Returns structuredContent {company_id, removed (company scout ids), failed}.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with company_id, removed, failed.

​

API endpoints

• Remove company Scouts · DELETE /v1/platform/companies/{id}/scouts

​

List signals

heliyos_signals_list · Read · Idempotent Lists signals (events scouts found, such as a funding round or a leadership change), newest first. Filter by company_id, by scout_id (a global scout from heliyos_scouts_list) and by status (new = unread). Each signal shows its id, date, company and a summary; detailed adds source URLs. Mark them read with heliyos_signals_mark_read. Returns structuredContent {signals:[{id, status, detected_at, company_id, company_name, summary}], next_cursor}.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with signals, next_cursor.

​

API endpoints

• List workspace Scout signals · GET /v1/platform/global-scouts/{id}/signals
• List signals · GET /v1/platform/signals

​

Mark signals read

heliyos_signals_mark_read · Write · Idempotent Marks signals read: either the given signal_ids (1 to 20) or every new signal about one company (company_id). Pass exactly one of the two. Marking a read signal again changes nothing. Returns structuredContent {marked, failed} for signal_ids, or {company_id, marked_count} for a company.

​

Inputs

​

Returns

A readable text summary, plus structuredContent with marked, failed, company_id, marked_count.

​

API endpoints

• Mark signals read in bulk · POST /v1/platform/signals/bulk-read
• Mark a signal read · POST /v1/platform/signals/{id}/read