Lucidworks

Lucidworks Features API

The Features API lets you observe the status of features across collections. To manipulate features for a specific collection, use the Collections API.

GitHub OpenAPI

Operations 4

GET /features/status Get features service status #
GET /features List all features #
GET /features/{feature} Get a feature #
GET /features/{feature}/_schema Get feature configuration schema #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lucidworks/refs/heads/main/openapi/lucidworks-features-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lucidworks:lucidworks-features-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lucidworks-features-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fusion Admin Features API
  description: These APIs provide general administrative functions for your Fusion instance. Use these APIs to manage Fusion objects, App Studio objects, connections to Solr clusters, license files, job schedules, and more. You can also use them to create a history of service events.
  termsOfService: https://lucidworks.com/legal/developer-license-agreement/
  contact:
    name: Lucidworks
    url: www.lucidworks.com
    email: support@lucidworks.com
  license:
    name: License of API
    url: https://lucidworks.com/legal/developer-license-agreement/
  version: '5.9'
servers:
- url: https://{FUSION HOST}/api
  description: Fusion
  variables:
    FUSION HOST:
      default: FUSION_HOST
      description: Your environment host.
- url: https://{FUSION HOST}/api/apps/{APP_NAME}
  description: Fusion app
  variables:
    FUSION HOST:
      default: FUSION_HOST
      description: Your environment host.
    APP_NAME:
      default: APP_NAME
      description: The name of your Fusion application.
tags:
- name: Features
  description: The Features API lets you observe the status of features across collections. To manipulate features for a specific collection, use the Collections API.
paths:
  /features/status:
    get:
      tags:
      - Features
      summary: Get features service status
      description: Check the status of the Features service.
      operationId: getStatus_7
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceStatus'
              example:
              - name: searchLogs
                collectionId: demo
                params: {}
                enabled: false
              - name: signals
                collectionId: demo
                params: {}
                enabled: false
  /features:
    get:
      tags:
      - Features
      summary: List all features
      description: Fetch the list of existing features.
      operationId: listFeatures_1
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FeatureSpec'
  /features/{feature}:
    get:
      tags:
      - Features
      summary: Get a feature
      description: Fetch details about a feature.
      operationId: getFeature_1
      parameters:
      - name: feature
        in: path
        description: 'The feature to update. Allowed values:


          - `signals`: Create a parallel collection for storing signals data (such as user clicks or ratings). Signals need to be indexed and aggregated before they can be used.

          - `recommendations`: Get configuration information about recommendations. Parameters include `idField` (document ID field), `itemsForUser` (enable or disable items-for-user recommendations), `itemsForQuery` (enable or disable items-for-query recommendations), `itemsForItem` (enable or disable items-for-item recommendations), and `queriesForQuery` (enable or disable queries-for-query recommendations).'
        required: true
        schema:
          type: string
          enum:
          - signals
          - recommendations
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureSpec'
  /features/{feature}/_schema:
    get:
      tags:
      - Features
      summary: Get feature configuration schema
      description: Get a feature's configuration schema.
      operationId: getFeatureSchema
      parameters:
      - name: feature
        in: path
        description: 'The feature to update. Allowed values:


          - `signals`: Create a parallel collection for storing signals data (such as user clicks or ratings). Signals need to be indexed and aggregated before they can be used.

          - `recommendations`: Get configuration information about recommendations. Parameters include `idField` (document ID field), `itemsForUser` (enable or disable items-for-user recommendations), `itemsForQuery` (enable or disable items-for-query recommendations), `itemsForItem` (enable or disable items-for-item recommendations), and `queriesForQuery` (enable or disable queries-for-query recommendations).'
        required: true
        schema:
          type: string
          enum:
          - signals
          - recommendations
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectType'
components:
  schemas:
    PropertyGroup:
      type: object
      properties:
        label:
          type: string
          readOnly: true
        properties:
          type: array
          readOnly: true
          items:
            type: string
    ServiceStatus:
      type: object
      properties:
        status:
          type: string
          enum:
          - starting
          - ok
          - warning
          - error
          - shutdown
        node:
          type: string
          readOnly: true
        messages:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/StatusMessage'
    StatusMessage:
      type: object
      properties:
        date:
          type: string
          format: date-time
          readOnly: true
        message:
          type: string
          readOnly: true
    CallParams:
      type: object
      properties:
        uri:
          type: string
          description: 'A fully-qualified service URI. This can be an HTTP call, a Solr request, or a Managed Fusion service call. <br/>Supported URI schemas are: `http://`, `https://`, `solr://{collection}/…​`, or `service://{serviceName}/{path}`.'
        method:
          type: string
          enum:
          - GET
          - PUT
          - POST
          - DELETE
        queryParams:
          type: object
          description: Query parameters to be passed with the request. For Solr calls, this could be parameters such as `q`, `fq`, `commit`, and so on
          additionalProperties:
            type: string
        headers:
          type: object
          description: Any additional protocol headers, such as `Content-type`.
          additionalProperties:
            type: string
        entity:
          type: object
          description: An optional payload to be sent with the request.
          properties: {}
    ObjectType:
      type: object
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - String
          - Number
          - Integer
          - Boolean
          - Object
          - Array
          - 'Null'
          - Ref
        title:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        required:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AnyType'
          readOnly: true
        additionalProperties:
          type: object
          properties: {}
          readOnly: true
        minProperties:
          type: integer
          format: int32
          readOnly: true
        maxProperties:
          type: integer
          format: int32
          readOnly: true
        definitions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AnyType'
          readOnly: true
        category:
          type: string
          readOnly: true
        categoryPriority:
          type: integer
          format: int32
          readOnly: true
        enum:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: object
            properties: {}
        hints:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
        unsafe:
          type: boolean
          readOnly: true
        default:
          type: object
          properties: {}
          readOnly: true
        oneOf:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/AnyTypeObjectObject'
        propertyGroups:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/PropertyGroup'
    AnyTypeObjectObject:
      type: object
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - String
          - Number
          - Integer
          - Boolean
          - Object
          - Array
          - 'Null'
          - Ref
        title:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        enum:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: object
            properties: {}
        default:
          type: object
          properties: {}
          readOnly: true
        category:
          type: string
          readOnly: true
        categoryPriority:
          type: integer
          format: int32
          readOnly: true
        hints:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
        unsafe:
          type: boolean
          readOnly: true
        oneOf:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/AnyTypeObjectObject'
    FeatureSpec:
      type: object
      properties:
        name:
          type: string
        defaults:
          type: object
          additionalProperties:
            type: object
            properties: {}
        callback:
          $ref: '#/components/schemas/CallParams'
    AnyType:
      type: object
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - String
          - Number
          - Integer
          - Boolean
          - Object
          - Array
          - 'Null'
          - Ref
        title:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        enum:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: object
            properties: {}
        default:
          type: object
          properties: {}
          readOnly: true
        category:
          type: string
          readOnly: true
        categoryPriority:
          type: integer
          format: int32
          readOnly: true
        hints:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
        unsafe:
          type: boolean
          readOnly: true
        oneOf:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/AnyTypeObjectObject'
  securitySchemes:
    Basic_auth:
      type: http
      scheme: basic
    API_key:
      name: x-api-key
      type: apiKey
      in: header
x-original-swagger-version: '2.0'
x-provenance:
  method: harvested
  publisher: Lucidworks
  source: https://doc.lucidworks.com/api-reference/5.9/fusion-api-swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)