Guides
API reference
MCP server
Changelogcurl --request POST \
--url https://api-prod.heliyos.ai/v1/platform/global-scouts/{id}/state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"state": "confirmed"
}
'{
"meta": {
"message": "Global scout activated successfully"
},
"data": {
"success": true,
"scout": {
"_id": "6731c0a2b4e5f60718293a4b",
"name": "Hiring for data roles",
"type": "custom",
"applyTo": "watchlist",
"cadence": "weekly",
"effort": "medium",
"isActive": true,
"previewStatus": "completed"
},
"activated_count": 8
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Scouts
Set a workspace Scout state
Activates, pauses, confirms or discards a workspace Scout. state decides what happens:
state | Works on | What it does | data |
|---|---|---|---|
active | Any Scout | Sets isActive: true, resumes its paused company Scouts and starts it on its scope again. | { success, scout, activated_count } |
paused | Any Scout | Sets isActive: false, pauses every company Scout and stops their monitors. Signals are kept. | { success, scout, deactivated_count, monitors_deleted } |
confirmed | A custom Scout whose previewStatus is completed | Activates it and starts it on its scope: every watched company, the selected companies, or the web. | The Scout |
cancelled | A custom Scout with isActive: false | Deletes the Scout permanently. On any other Scout it changes nothing. | { success: true } |
meta.message depends on state: Global scout activated successfully, Global scout deactivated successfully,
Scout confirmed and activated successfully or Scout preview cancelled successfully.
Once active, a custom Scout’s runs cost credits by effort.
POST
/
v1
/
platform
/
global-scouts
/
{id}
/
state
curl --request POST \
--url https://api-prod.heliyos.ai/v1/platform/global-scouts/{id}/state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"state": "confirmed"
}
'{
"meta": {
"message": "Global scout activated successfully"
},
"data": {
"success": true,
"scout": {
"_id": "6731c0a2b4e5f60718293a4b",
"name": "Hiring for data roles",
"type": "custom",
"applyTo": "watchlist",
"cadence": "weekly",
"effort": "medium",
"isActive": true,
"previewStatus": "completed"
},
"activated_count": 8
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}cancelled deletes any inactive custom Scout, including one you paused, and only the workspace Scout
itself: its company Scouts are left behind. To remove a custom Scout that has run, use
Delete a custom Scout (DELETE /v1/platform/global-scouts/{id}) instead. active also activates a custom Scout
whose preview has not completed; use confirmed for new Scouts.In the Heliyos MCP server:
heliyos_scouts_update.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Path Parameters
The workspace Scout's id.
Pattern:
^[0-9a-fA-F]{24}$Body
application/json
active, paused, confirmed or cancelled. See the table above.
Available options:
active, paused, confirmed, cancelled Example:
"confirmed"
Was this page helpful?