Content Research Agents

Update a content research agent

Updates mutable config. Collection scope (min_views/time_range) is system-managed and cannot be set here.

put/v1/agents/{id}

Request

  • Base URL: https://api.virlo.ai
  • URL: https://api.virlo.ai/v1/agents/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Agent UUID

Request body

namestring

Human-friendly name.

activeboolean

Whether the agent is active (recurring runs will be scheduled).

keywordsstring[]

Keywords (1-50). Hashtag tokens normalised. Replaces the whole list; autopilot keeps every keyword you set and only adds around them.

platformsstring[]

Platforms to collect from.

cadencestring

Schedule cadence (recurring agents only): "daily", "weekly", "monthly", or a cron expression (minimum daily).

exclude_keywordsstring[]

Noise terms to filter out — matched as WHOLE WORDS against captions + hashtags, so use the single word people actually type for the OTHER meaning (researching Apple the company, not the fruit? exclude recipe, fruit, orchard), not multi-word phrases like apple the fruit (which never match). Never exclude a word that is part of your own topic. Tip: suggest-keywords returns a ready exclude_keywords list you can pass straight in.

exclude_keywords_strictboolean

If true, also match exclude_keywords against the video transcript (speech), not just the caption/hashtags — use when the noise word is spoken but rarely written. Default false.

meta_ads_enabledboolean

Enable Meta ads collection.

intentstring

Research intent (plain language).

data_intelligence_enabledboolean

Enable per-video AI intelligence.

english_onlyboolean

When true, only English-language content is collected. Set false to collect any language.

autopilotboolean

Turn autopilot on (true) or off (false). Off keeps the configuration exactly as you set it.

Response

Agent updated

messagestring required

Example response

{
  "data": {
    "keywords": [
      "protein recipes",
      "meal prep"
    ],
    "platforms": [
      "tiktok",
      "youtube",
      "instagram"
    ],
    "intent_keywords": [
      "high protein recipe",
      "protein meal prep",
      "protein dessert"
    ],
    "pinned_keywords": [
      "protein recipe",
      "highprotein"
    ],
    "latest_run": {
      "keyword_breakdown": [
        {
          "keyword": "high protein recipe",
          "videos_inserted": 41,
          "videos_updated": 12,
          "tiktok_count": 27,
          "youtube_count": 12,
          "instagram_count": 2
        }
      ]
    }
  },
  "message": "Agent updated"
}

Changes

No recorded changes to this operation across all 1 revision of this API.