Get Agent

Returns a single agent by its numeric id, scoped to the workspace.

Get an agent

GET/api/v2/partner/workspaces/{partner_workspace_id}/agents/{agent_id}

Path parameters

Parameter	Type	Description
partner_workspace_id	string	Opaque workspace identifier from the partner system.
agent_id	integer	Numeric id of the agent. This ID is specific to your environment.

Example request

curl "https://api.getsillage.com/api/v2/partner/workspaces/ws_123/agents/42" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Example response

{
  "data": {
    "id": 42,
    "name": "Hiring signals",
    "type": "keyword_detection",
    "enabled": true,
    "parameters": {
      "tracking_keywords": ["hiring", "expansion"]
    },
    "created_at": "2026-06-12T09:00:00.000Z",
    "updated_at": "2026-06-12T09:00:00.000Z"
  }
}

Response fields

Field	Type	Description
id	integer	Numeric id of the agent. This ID is specific to your environment.
name	string	Display name of the agent.
type	string	Agent type. See the list below.
enabled	boolean	Whether the agent is currently active.
parameters	object	Agent configuration. Its shape depends on `type`.
created_at	string	When the agent was created (ISO 8601).
updated_at	string	When the agent was last updated (ISO 8601).

The type field is one of keyword_detection, keyword_post_search, job_posting_keyword_detection, job_update, champion_tracking, competitor, partner, customer, influencer, champion, or unconfigured (an agent whose watchlist link is missing — its parameters is empty and watchlist_kind/watchlist_id are both null). See Create agent for the request shape and parameters of each.

Errors

Status	Meaning
401	The master key is missing or invalid.
402	This workspace is not on a plan that allows agents.
403	The master key is not authorized to access this resource.
404	No agent found for this `agent_id`.
422	Invalid request body or `agent_id`.
429	Rate limit exceeded.
500	An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json.