curl --request POST \
--url https://api-prod.heliyos.ai/v1/platform/companies/{id}/scouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"defaultScoutIds": [
"6731c0a2b4e5f60718293a4b",
"6731c0a2b4e5f60718293a4c"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({defaultScoutIds: ['6731c0a2b4e5f60718293a4b', '6731c0a2b4e5f60718293a4c']})
};
fetch('https://api-prod.heliyos.ai/v1/platform/companies/{id}/scouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/companies/{id}/scouts"
payload = { "defaultScoutIds": ["6731c0a2b4e5f60718293a4b", "6731c0a2b4e5f60718293a4c"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"meta": {
"message": "Scouts creation initiated successfully"
},
"data": {
"message": "Scout creation triggered successfully",
"status": "processing",
"total_scouts": 2
}
}{
"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>"
}
}Add Scouts to a company
Starts the given workspace Scouts on one company. Watching a company already starts every active
watchlist Scout on it; use this to add Scouts to a company that is missing some.
Setup runs in the background: the response says it started, and the company Scouts appear in
List a company’s Scouts (GET /v1/platform/companies/{id}/scouts) once created. A Scout already set up on the
company is not added twice. Custom Scouts cost credits on each run by effort.
curl --request POST \
--url https://api-prod.heliyos.ai/v1/platform/companies/{id}/scouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"defaultScoutIds": [
"6731c0a2b4e5f60718293a4b",
"6731c0a2b4e5f60718293a4c"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({defaultScoutIds: ['6731c0a2b4e5f60718293a4b', '6731c0a2b4e5f60718293a4c']})
};
fetch('https://api-prod.heliyos.ai/v1/platform/companies/{id}/scouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/companies/{id}/scouts"
payload = { "defaultScoutIds": ["6731c0a2b4e5f60718293a4b", "6731c0a2b4e5f60718293a4c"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"meta": {
"message": "Scouts creation initiated successfully"
},
"data": {
"message": "Scout creation triggered successfully",
"status": "processing",
"total_scouts": 2
}
}{
"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>"
}
}heliyos_companies_scouts_add.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 company record's id.
^[0-9a-fA-F]{24}$Body
1 to 50 workspace Scout ids. Each must be an active Scout with scope watchlist, built in or custom.
1 - 50 elementsA 24-character hexadecimal id.
^[0-9a-fA-F]{24}$Optional company field values used to build each Scout's query (company_name or name, and
website or company_website). When omitted or empty, the record's own values are used. Most
callers omit it.
Was this page helpful?

