Request Body
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"
Optional watchlist name. If omitted, a name is auto-generated from the prompt.
How often to fetch new posts (in hours). Allowed values:
1, 3, 6, 12, 24, 48, 72.Response Fields
Unique identifier for the created watchlist.
Watchlist name (provided or auto-generated).
URL-friendly slug for the watchlist.
Always
"keyword" for this endpoint.Fetch frequency in hours.
The prompt used to generate keywords.
true when the watchlist was created successfully.Status message indicating background processing.
How it works
- You send a prompt describing what you want to track.
- OutX creates the watchlist immediately and returns the response.
- In the background, AI generates optimized keywords (with required/excluded modifiers) and intent labels.
- Keywords and labels appear on the watchlist within a few seconds.
- Posts start matching and appearing in your feed as the background tasks complete.
Error Responses
| Status Code | Error Message | Description |
|---|---|---|
| 400 | prompt is required and must be a non-empty string | Missing or empty prompt |
| 400 | Invalid fetchFreqInHours | Value not in the allowed set |
| 401 | Missing API Key / Invalid API Key | API key issue |
| 402 | Your plan includes up to N watchlists… | Watchlist limit reached |
| 403 | Plugin installation required | No active Chrome extension |

