Skip to main content
Describe what you want to track in plain English and OutX will generate optimized keywords, required/excluded modifiers, and intent labels automatically. The watchlist is created immediately and keyword generation runs in the background.

Request Body

prompt
string
required
A natural-language description of what you want to track. For example:
  • "AI-native CRM tools and competitors like Salesforce, HubSpot"
  • "People looking for remote software engineering jobs"
  • "Track mentions of our product Acme and common complaints"
You can include URLs — OutX will fetch page metadata to improve keyword quality.
name
string
Optional watchlist name. If omitted, a name is auto-generated from the prompt.
fetchFreqInHours
number
default:"12"
How often to fetch new posts (in hours). Allowed values: 1, 3, 6, 12, 24, 48, 72.
curl -X POST \
  "https://api.outx.ai/api-keyword-watchlist-prompt" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "prompt": "Track discussions about AI-native CRM tools, including competitors like Salesforce and HubSpot",
    "name": "AI CRM Watchlist",
    "fetchFreqInHours": 12
  }'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "AI CRM Watchlist",
  "slug": "ai-crm-watchlist-abc123",
  "type": "keyword",
  "fetchFreqInHours": 12,
  "prompt": "Track discussions about AI-native CRM tools, including competitors like Salesforce and HubSpot",
  "created": true,
  "message": "Watchlist created. Keywords and labels are being generated in the background and will be available shortly."
}

Response Fields

id
string
Unique identifier for the created watchlist.
name
string
Watchlist name (provided or auto-generated).
slug
string
URL-friendly slug for the watchlist.
type
string
Always "keyword" for this endpoint.
fetchFreqInHours
number
Fetch frequency in hours.
prompt
string
The prompt used to generate keywords.
created
boolean
true when the watchlist was created successfully.
message
string
Status message indicating background processing.

How it works

  1. You send a prompt describing what you want to track.
  2. OutX creates the watchlist immediately and returns the response.
  3. In the background, AI generates optimized keywords (with required/excluded modifiers) and intent labels.
  4. Keywords and labels appear on the watchlist within a few seconds.
  5. Posts start matching and appearing in your feed as the background tasks complete.

Error Responses

Status CodeError MessageDescription
400prompt is required and must be a non-empty stringMissing or empty prompt
400Invalid fetchFreqInHoursValue not in the allowed set
401Missing API Key / Invalid API KeyAPI key issue
402Your plan includes up to N watchlists…Watchlist limit reached
403Plugin installation requiredNo active Chrome extension