Skip to main content
All OutX API endpoints require authentication using an API key. This ensures secure access to your data and protects your account.

​
Getting Your API Key

To obtain your API key:
  1. Log in to your OutX account
  2. Visit mentions.outx.ai/api-doc
  3. Click “Reveal API Key” to view your key
  4. Copy and securely store your API key
OutX dashboard showing where to reveal and copy your API key
Keep your API key secure and never share it publicly. Treat it like a password.

​
Using Your API Key

Include your API key in the x-api-key header of every API request:

​
Header Format

x-api-key: YOUR_API_KEY

​
Example Request

curl -X GET \
  "https://api.outx.ai/api-keyword-watchlist" \
  -H "x-api-key: YOUR_API_KEY"

​
Authentication Errors

​
401 Unauthorized

This error occurs when:
  • No API key is provided
  • The API key is invalid or expired
  • The API key format is incorrect
Response: 
{
  "error": "Unauthorized"
}
Solution: Verify that you’re including the correct API key in the x-api-key header.

​
403 Forbidden

This error occurs when:
  • You’re trying to access resources that don’t belong to your team
  • Your API key doesn’t have permission for the requested operation
Response: 
{
  "error": "Access denied: You don't have permission to access this resource"
}
Solution: Ensure you’re only accessing resources associated with your account.

​
Best Practices

  • Never commit API keys to version control
  • Use environment variables or secure key management systems
  • Rotate keys periodically for enhanced security
  • Always use HTTPS for API requests - Never send API keys over unencrypted connections
  • Track your API usage to stay within rate limits - Set up alerts for unusual activity - Review API logs regularly
  • Implement proper error handling in your code
  • Retry failed requests with exponential backoff
  • Log authentication errors for debugging

​
Rate Limiting

API rate limits are enforced per API key and vary based on your subscription plan:
  • Free Plan: 100 requests/hour
  • Pro Plan: 1,000 requests/hour
  • Enterprise Plan: Custom limits
When you exceed the rate limit, you’ll receive a 429 Too Many Requests response: 
{
  "error": "Rate limit exceeded. Please try again later."
}
Need higher rate limits? Contact support@outx.ai to discuss enterprise options.

​
Team-Based Access

Your API key is associated with your team account. This means:
  • All API requests are scoped to your team’s data
  • You can only access watchlists and posts created by your team
  • Team members share the same rate limits

​
Next Steps

Quick Start Guide

Make your first API request

Watchlist APIs

Create and manage watchlists