API Documentation for OutXAI

Getting started

Welcome to OutXAI API!

OutXAI API is the starting point on your journey towards building powerful Social Monitoring Systems. With OutXAI you can get all the data you need to build an efficient application while also saving your time and budget.

• OutXAI API is using the REST technology for interchanging data between your application and our service.
• The data exchange is made through the widely used HTTP protocol, which allows applying our API to almost all programming languages.

Our API currently supports three core endpoints:

• POST Watchlists - Create keyword-based watchlists for monitoring
• GET Posts - Retrieve and filter LinkedIn posts from your watchlists
• PUT Watchlists - Update existing watchlists (rename, frequency, enable/disable)

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

Ready to get started? Check out our detailed endpoint documentation below.

---

1. 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.

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”

Essential Parameters:

Optional Parameters:

Request Body Examples

Simple:

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

Advance:

{
  "keywords": [
    {
      "keyword": "artificial intelligence",
      "required_keywords": ["technology", "innovation"],
      "exclude_keywords": ["science fiction", "movies"]
    },
    {
      "keyword": "machine learning",
      "required_keywords": ["data"],
      "exclude_keywords": ["gaming"]
    }
  ]
}

Request Body

{
  "keywords": ["blockchain", "cryptocurrency", "web3"],
  "name": "Crypto Trends Watchlist",
  "description": "Track latest trends in blockchain and cryptocurrency"
}

Response

Success (200) - New Watchlist Created

{
  "id": "uuid-string",
  "name": "Crypto Trends Watchlist",
  "slug": "crypto-trends-watchlist-abc123",
  "keywords": ["blockchain", "cryptocurrency", "web3"],
  "created": true,
  "results": [
    {
      "success": true,
      "keyword": "blockchain",
      "keyword_id": "uuid-string"
    },
    {
      "success": true,
      "keyword": "cryptocurrency",
      "keyword_id": "uuid-string"
    },
    {
      "success": false,
      "keyword": "web3",
      "error": "Failed to create keyword tracking"
    }
  ]
}

Response Fields Description

Inside results array Fields description

Errors

---

2. GET Posts

Provide a Watchlist ID to retrieve the posts associated with one or more watchlists.

Once the request is processed, the response will include the watchlist details along with the corresponding posts.

Curl

curl -X GET "https://cafqluqomuhgtchexldv.supabase.co/functions/v1/api-posts?watchlist_id=<Watchlist_ID>"
  -H "x-api-key: YOUR_TEAM_API_KEY_HERE"
  

Multiple watchlist_id Curl

curl -X GET "https://cafqluqomuhgtchexldv.supabase.co/functions/v1/api-posts?watchlist_id=<Watchlist_ID1>,<Watchlist_ID2>,<Watchlist_ID3>&current_page=1&lang=true"
  -H "x-api-key: YOUR_TEAM_API_KEY_HERE"

Required Parameters

Optional Parameters

Response

{
  "data": [
    {
      "id": "string",
      "linkedin_post_url": "string",
      "tracking_lists_id": "string",
      "content": "string",
      "image_url": "string",
      "image_text": "string",
      "author_name": "string",
      "author_url": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "posted_at": "2024-01-01T00:00:00Z",
      "likes_count": 0,
      "shares_count": 0,
      "influence_score": 0,
      "sentiment": "string",
      "comments_count": 0,
      "bookmark": false,
      "post_type": "string",
      "language": "string",
      "tags": ["tag1", "tag2"],
      "commented": false,
      "author_headline": "string",
      "author_image_url": "string",
      "image_urls": ["url1", "url2"],
      "videos": null,
      "seniority_level": "string",
      "liked": false,
      "tagDescriptions": [
        {
          "tag": "string",
          "description": "string"
        }
      ]
    }
  ],
  "count": 100
}

Response Field

Inside data array (Post Object)

Inside tagDescriptions array

Errors

---

3. PUT Watchlist

Update Watchlist API allows you to modify an existing watchlist.

You can update several properties of the watchlist, such as:

• Name – rename the watchlist to keep it organized or aligned with new use cases.
• Fetch frequency – control how often data is refreshed for the watchlist.
• Status – enable or disable the watchlist without permanently deleting it.

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

This endpoint is designed to help you maintain flexibility and keep your watchlists up to date as your monitoring needs evolve.

Curl

curl -X PUT "https://cafqluqomuhgtchexldv.supabase.co/functions/v1/api-watchlist"
  -H "x-api-key: YOUR_TEAM_API_KEY_HERE"
  -H "Content-Type: application/json"
  -d '{
    "id": "your-watchlist-id",
    "fetchFreqInHours": 6
  }'

Authentication

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

---

Essential Parameters

Optional Parameters

---

Request Body

Retrieve your UUID-string from POST Watchlist response

{
  "id": "uuid-string",
  "name": "Updated Name",
  "fetchFreqInHours": 12,
  "disable": false
}

---

Response

Success (200) – Watchlist Updated

{
  "id": "uuid-string",
  "name": "Updated Name",
  "fetchFreqInHours": 12,
  "disable": false,
  "updated": true,
  "message": "Watchlist updated successfully"
}

---

Errors

---

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