Get Agent

Read a single agent configured for your workspace.

Returns a single agent by its id, with its current configuration. Returns 404 when the agent does not exist.

Get agent

GET/api/v2/agents/{agent_id}

Path parameters

ParameterTypeDescription
agent_idintegerIdentifier of the agent.

Example request

curl "https://api.getsillage.com/api/v2/agents/42" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"
const response = await fetch('https://api.getsillage.com/api/v2/agents/42', {
  headers: {
    Authorization: `Bearer ${process.env.SILLAGE_API_KEY}`,
  },
})

const result = await response.json()
import { request } from 'node:https'

const req = request(
  new URL('https://api.getsillage.com/api/v2/agents/42'),
  {
    headers: {
      Authorization: `Bearer ${process.env.SILLAGE_API_KEY}`,
    },
  },
  (res) => {
    let data = ''
    res.on('data', (chunk) => {
      data += chunk
    })
    res.on('end', () => {
      console.log(JSON.parse(data))
    })
  },
)

req.end()
import os
import requests

response = requests.get(
    "https://api.getsillage.com/api/v2/agents/42",
    headers={"Authorization": f"Bearer {os.environ['SILLAGE_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
result = response.json()

Example response

{
  "data": {
    "id": 42,
    "name": "LinkedIn keyword monitor",
    "type": "keyword_detection",
    "enabled": false,
    "parameters": {
      "tracking_keywords": ["fundraising", "series a", "hiring sales"],
      "start_date": "2026-01-01"
    },
    "watchlist_kind": "company",
    "watchlist_id": 128,
    "created_at": "2026-06-18T10:00:00.000Z",
    "updated_at": "2026-06-18T10:00:00.000Z"
  }
}

Response fields

FieldTypeDescription
data.idintegerIdentifier of the agent.
data.namestringDisplay name of the agent.
data.typestringAgent type. One of: keyword_detection, job_posting_keyword_detection, competitor_activity, job_update, content_engagement, champion_tracking, influencer_engagement, job_posting, a semantic watchlist type (competitor, partner, customer, influencer, champion), or unconfigured (agent with no watchlist — not yet set up, or its watchlist was unbound; empty parameters, null watchlist fields).
data.enabledbooleanWhether the agent is currently active.
data.parametersobjectType-dependent parameters. See the parameters shape table below.
data.watchlist_kindstringKind (company/profile) of the bound watchlist, or null when the agent is unbound.
data.watchlist_idintegerId of the bound watchlist, or null when the agent is unbound.
data.created_atstringISO 8601 creation timestamp.
data.updated_atstringISO 8601 last-update timestamp.

Parameters shape by type

The parameters object fields depend on the agent type. All fields are optional in the response (legacy rows may be sparse).

keyword_detection

FieldTypeDescription
tracking_keywordsarray<string>Keywords Sillage monitors on LinkedIn.
start_datestringISO 8601 date — only posts published after this date are scraped.

job_posting_keyword_detection

FieldTypeDescription
tracking_keywordsarray<string>Keywords Sillage monitors in your tracked companies' job postings.

job_update

FieldTypeDescription
job_titlesarray<string>Job titles that trigger detection.
seniority_levelsarray<string>Seniority levels to filter on.
company_domains_to_scrapearray<string>Target company domains.
target_personaarray<string>Target persona labels.
target_persona_locationsarray<string>Geographic filters for target personas.
interested_byobject{ prospects: boolean, customers: boolean } filters.
keywords_for_social_detectionarray<string>Keywords used for social post matching.
author_rolesarray<string>Author role filters.
author_industriesarray<string>Author industry filters.
target_linkedin_profilesarray<string>Specific LinkedIn profile URLs to track.

job_posting

FieldTypeDescription
job_titlesarray<string>Job titles to watch for in postings.
search_stringsarray<string>Free-text search strings for job posting content.
job_locationsarray<string>Geographic filters for job postings.
published_atstringISO 8601 date — only postings published after this date.
target_top_accounts_onlybooleanRestrict to top-account companies only.

competitor_activity, content_engagement, champion_tracking

These types share the common targeting parameter set:

FieldTypeDescription
company_domains_to_scrapearray<string>Target company domains.
target_personaarray<string>Target persona labels.
target_persona_locationsarray<string>Geographic filters for target personas.
interested_byobject{ prospects: boolean, customers: boolean } filters.
keywords_for_social_detectionarray<string>Keywords used for social post matching.
author_rolesarray<string>Author role filters.
author_industriesarray<string>Author industry filters.
target_linkedin_profilesarray<string>Specific LinkedIn profile URLs to track.

influencer_engagement

Same common targeting fields as above, plus:

FieldTypeDescription
influencer_keywordsarray<string>Keywords that identify influencer content.

Errors

StatusDescription
401The API key is missing or invalid.
404The agent does not exist.
422Invalid agent_id — must be a positive integer.
429Too many requests.

On this page