Product Selector

Fusion 5.9
    Fusion 5.9

    APIs and CredentialsLucidworks AI

    Table of Contents

    The APIs tab in the integrations section provides information about APIs you can use to connect to Lucidworks AI with your own code. In addition, client credential information is displayed.

    For information about how to access the APIs tab, see View the API list and credentials information.

    APIs

    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.

    Credentials

    This section contains information exclusive to your organization and you need to ensure only authorized individuals can access this data.

    The values are used to obtain authentication tokens and values sent in API queries:

    • Customer ID. The unique value that identifies your organization. This value is generated when the workspace is created, and is unique to that workspace. It cannot be reset or changed.

    • Application ID. The unique value that identifies a specific application. Each application has a different value.

    • Client ID. The unique client value that is part of the information required to obtain OAuth 2.0 authorization. For a self-hosted Fusion client integration, this value is unique to the specific integration.

    • Client Secret. The private client value that is part of the information required to obtain OAuth 2.0 authorization. You must keep this value secret. Do not use it in public clients such as client-side applications.