POST Watchlist API - Create Watchlist

POST Watchlist

Create Watchlist API provides you a way to Create your watchlists once you have the Keywords Defined.

All POST data should be sent in the JSON format (UTF-8 encoding).

You can add multiple keyword in the keywords array in your watchlist which you want to track.

Quick Set up Guide

• To get your API KEY mail us support@outx.ai
• Create a watchlist using the POST endpoint
• Retrieve posts using the GET endpoint with your watchlist ID
• Update watchlist settings as needed using the PUT endpoint
• Like and Comment using Engagement APIs

Curl

curl -X POST "https://cafqluqomuhgtchexldv.supabase.co/functions/v1/api-watchlist"
  -H "x-api-key: YOUR_TEAM_API_KEY_HERE"
  -H "Content-Type: application/json"
  -d '{
    "keywords": [
      {
        "keyword": "artificial intelligence",
        "required_keywords": ["business", "enterprise"],
        "exclude_keywords": ["gaming", "entertainment"]
      },
      "machine learning"
    ],
    "name": "Enterprise AI Watchlist",
    "description": "Track enterprise AI and ML discussions"
  }'

Authentication

• x-api-key: “YOUR TEAM API KEY HERE”

Parameters

Essential Parameters:

Optional Parameters:

Request Body

Simple:

{
  "keywords": ["artificial intelligence", "machine learning", "AI"]
}

Advance:

{
  "keywords": [
    "remote work",
    {
      "keyword": "work from home",
      "required_keywords": ["productivity", "tools"],
      "exclude_keywords": ["job posting", "hiring"]
    },
    "digital nomad"
  ],
  "name": "Remote Work Insights",
  "description": "Track discussions about remote work culture and productivity",
  "labels": [
    {
      "name": "Remote Culture",
      "description": "Posts about remote work culture and best practices"
    },
    {
      "name": "Productivity Tools",
      "description": "Tools and software for remote productivity"
    },
    {
      "name": "Digital Nomad Lifestyle",
      "description": "Location-independent work and travel"
    }
  ]
}

Response

Success (200) - New Watchlist Created

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Crypto & Blockchain Watchlist",
  "slug": "crypto-blockchain-watchlist-abc123",
  "keywords": ["blockchain", "cryptocurrency", "bitcoin", "ethereum"],
  "created": true,
  "results": [
    {
      "success": true,
      "keyword": "blockchain",
      "keyword_id": "keyword-uuid-1"
    },
    {
      "success": true,
      "keyword": "cryptocurrency", 
      "keyword_id": "keyword-uuid-2"
    },
    {
      "success": true,
      "keyword": "bitcoin",
      "keyword_id": "keyword-uuid-3"
    },
    {
      "success": true,
      "keyword": "ethereum",
      "keyword_id": "keyword-uuid-4"
    }
  ],
  "labels": [
    {
      "key": "Blockchain Technology",
      "description": "Posts about blockchain infrastructure and development"
    },
    {
      "key": "Cryptocurrency Market",
      "description": "Posts about crypto trading, prices, and market analysis"
    },
    {
      "key": "DeFi",
      "description": "Decentralized finance applications and protocols"
    },
    {
      "key": "Web3"
    }
  ]
}

Response Fields Description

Inside results array Fields description

Errors

For more information about the OutXAI API, feel free to contact us at support@outx.ai.