Lucidworks AI APIs
Lucidworks AI APIs are designed to work with Lucidworks AI and other Lucidworks products and services. These APIs are not available for standalone access. For more details, please contact Lucidworks. |
Lucidworks AI provides the following APIs:
-
Authentication API. This API authenticates a user to perform actions in APIs related to integrations. The Authentication API contains one endpoint, which generates an access token to use in future integrations API requests. For more information, see Authentication API.
-
Lucidworks AI Use Case API. This API returns a list of each use case and its associated models. The usecase endpoint requires an authentication token with scope
machinelearning.predict
, which is the same scope used in the Prediction API. For more information, see Lucidworks AI Use Case API. -
LWAI Prediction API. This API is used send synchronous API calls that run predictions from pre-trained or custom embedding models. The prediction endpoints require an authentication token with scope
machinelearning.predict
. For more information, see LWAI Prediction API. -
Lucidworks AI Async Prediction API. This API is used to send asynchronous API calls that run predictions on specific models. The async prediction endpoints require an authentication token with scope
machinelearning.predict
. For more information, see Lucidworks AI Async Prediction API. -
Lucidworks AI Models API. This API is used to discover available pre-trained and custom models, as well as train and deploy those models. The endpoints require an authentication token with scope
machinelearning.model
. For more information, see Lucidworks AI Models API.
General information about the APIs can be accessed by clicking Integrations and viewing the APIs tab.