Skip to main content
This guide will help you make your first API requests to OutX and get familiar with the core workflows.

​
Prerequisites

Before you begin, make sure you have:
1

API Key

Get your API key from mentions.outx.ai/api-doc
2

Base URL

All requests go to: https://api.outx.ai

​
Your First Watchlist

Let’s create a keyword watchlist to track LinkedIn posts about AI and machine learning.

​
Step 1: Create a Keyword Watchlist

curl -X POST \
  "https://api.outx.ai/api-keyword-watchlist" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "AI & ML Trends",
    "keywords": [
      "artificial intelligence",
      {
        "keyword": "machine learning",
        "required_keywords": ["python", "tensorflow"],
        "exclude_keywords": ["beginner", "tutorial"]
      }
    ],
    "fetchFreqInHours": 12
  }'
Response: 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "AI & ML Trends",
  "slug": "ai-ml-trends-550e8400",
  "type": "keyword",
  "keywords": ["artificial intelligence", "machine learning"],
  "fetchFreqInHours": 12,
  "created": true
}
Save the id from the response - you’ll need it to retrieve posts from this watchlist!

​
Step 2: Retrieve Posts from Your Watchlist

Now let’s fetch posts from the watchlist we just created: 
curl -X GET \
  "https://api.outx.ai/api-posts?watchlist_id=550e8400-e29b-41d4-a716-446655440000&current_page=1" \
  -H "x-api-key: YOUR_API_KEY"
Response: 
{
  "data": [
    {
      "id": "post-123",
      "content": "Exciting developments in machine learning with Python and TensorFlow...",
      "author_name": "John Doe",
      "author_url": "https://linkedin.com/in/johndoe",
      "linkedin_post_url": "https://linkedin.com/feed/update/...",
      "posted_at": "2024-01-15T10:30:00Z",
      "likes_count": 245,
      "comments_count": 32,
      "liked": false,
      "commented": false
    }
  ],
  "count": 156
}

​
Step 3: Engage with a Post

Let’s like one of the posts we retrieved: 
curl -X POST \
  "https://api.outx.ai/api-like" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "post_id": "post-123",
    "user_email": "your.email@example.com",
    "actor_type": "user"
  }'
Response: 
{
  "success": true,
  "message": "Like task created successfully",
  "task_id": "task-456"
}

​
Common Workflows

Create a people watchlist to monitor posts from key industry leaders:
curl -X POST \
  "https://api.outx.ai/api-people-watchlist" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "Tech Leaders",
    "profiles": [
      "https://linkedin.com/in/satyanadella",
      "https://linkedin.com/in/sundarpichai",
      "elon-musk"
    ]
  }'
Track posts from competitor company pages:
curl -X POST \
  "https://api.outx.ai/api-company-watchlist" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "Competitors",
    "companies": [
      "https://linkedin.com/company/openai",
      "https://linkedin.com/company/anthropic",
      "google-deepmind"
    ]
  }'
Retrieve trending posts with high engagement:
curl -X GET \
  "https://api.outx.ai/api-posts?watchlist_id=YOUR_ID&trending=true&sort_by=engagement" \
  -H "x-api-key: YOUR_API_KEY"
Like posts on behalf of your company page:
curl -X POST \
  "https://api.outx.ai/api-like" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "post_id": "post-123",
    "user_email": "admin@company.com",
    "actor_type": "company",
    "company_title": "Your Company Name"
  }'

​
Next Steps

Keyword Watchlist API

Learn about advanced keyword filtering

Posts API

Explore all post filtering options

Like API

Automate post likes

Comment API

Add comments programmatically

​
Need Help?

Have questions or need assistance? Contact us at support@outx.ai