Agent

Create and manage your workspace's agents.

The agent endpoints let you set up and manage your workspace's agents. The currently available type is the keyword-detection agent, which monitors LinkedIn posts for the keywords you track and surfaces matching signals into your workspace.

A workspace can have multiple agents. An agent is created enabled (enabled: true) and starts monitoring immediately. Authenticate with your workspace API key (sk_live_...).

Endpoints

  • List agents: GET /api/v2/agents — list the workspace's agents.
  • Create agent: POST /api/v2/agents — create an agent.
  • Get agent: GET /api/v2/agents/:agent_id — read a single agent.
  • Update agent: PUT /api/v2/agents/:agent_id — update an agent.
  • Delete agent: DELETE /api/v2/agents/:agent_id — delete an agent.

Watchlists

Agents watch a reusable watchlist of companies or people. Bind one to an agent with the watchlist_kind and watchlist_id fields on Create agent or Update agent — see the Watchlists section for creating and managing lists.

On this page