Use Case API

The Lucidworks AI Use Case API returns a list of each use case and the available models that support each use case. This API serves as a central repository of the most current use cases and models that Lucidworks AI supports, including custom models. As Lucidworks AI adds new use cases or models, the Use Case API returns the new use cases and models as soon as they’re available, eliminating the need to manually check another resource to view what is currently available. You can enter the values returned in the response of the Use Case API in the:

• LWAI Prediction API use case requests
• Lucidworks AI Async Prediction API use case requests

For a list of models that Lucidworks supports, see Pre-trained embedding models and Generative AI models. For the types of custom models that you can train in Lucidworks AI, see Custom embedding model training.

​

Prerequisites

To use this API, you need:

• The unique APPLICATION_ID for your Lucidworks AI application, which is provided by Lucidworks.
• A bearer token generated with a scope value of machinelearning.predict. For more information, see Authentication API.