.svg){kind=logo}
How to Get Started with the Lucidya API
Learn how to generate an API key and get started with the Lucidya API to access Social Listening data, real-time alerts via webhooks, and Lucidya's AI models.
The Lucidya API lets third-party applications access Lucidya's features programmatically. It is currently available for three products: Social Listening, Alerts, and AI API. It supports easy integration with various software and platforms for data synchronization and workflow automation.
What the API Offers
Social Listening API: extracts data from your monitoring screens including all data available within the platform pages, providing comprehensive social media insights.
Alerts API (Webhooks): notifies your application about alerts in real time without requiring you to send a request each time. Webhooks are part of the alert creation process and act as the push-based alert delivery method.
AI API: connects other software directly to Lucidya's AI models, providing access to features such as sentiment analysis, dialect recognition, and attribute identification.
Key Concepts
API Key: a unique identifier used to authenticate your application's access to the Lucidya API. It functions as a digital key and must be generated before you can make any API requests.
Quota Consumption: Social Listening API products consume one quota per request. The AI API consumes one quota per sentence, with limits on sentence length and count.
How to Get Started
Step 1. Generate an API Key
From the menu, select the API type you want to access. Add your IP addresses. Copy the generated token. This API key is required for all requests to the Lucidya API.
Step 2. Integrate with Your Application
Use the generated API key to authenticate requests from your application. The API is designed for easy integration with various software and platforms.
For further assistance contact Lucidya Support.
Frequently asked questions
The API is currently available for Social Listening, Alerts, and AI API products.
The Social Listening API extracts data from your monitoring screens. The AI API connects directly to Lucidya's AI models to provide sentiment analysis, dialect recognition, and attribute identification for your own data.
Webhooks deliver alert notifications to your application in real time. Instead of sending repeated requests to check for updates, your application receives a notification automatically when an alert is triggered.
Social Listening API requests consume one quota per request. AI API requests consume one quota per sentence, with limits on sentence length and total sentence count.
Lucidya uses API key authentication and IP address restrictions to secure data access and ensure privacy compliance.