Lucidworks Blobs API

The Blob Store REST API allows storing binary objects in Solr. You can use it to store entity extraction models, lookup lists or exclusion lists for use in index pipelines. This may include the entity extraction models and lookup lists included with Fusion in the `{fusion_path}/data/nlp` directory, or files that you have created on your own.

Operations 7

GET /blobs/status Get blob store service status #
GET /blobs List all blobs #
GET /blobs/{id} Get a blob #
PUT /blobs/{id} Upload a blob #
DELETE /blobs/{id} Delete a blob #
HEAD /blobs/{id} Get blob metadata #
PUT /blobs/convert Convert blob manifests #

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-blobs-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.

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

OpenAPI Specification

lucidworks-blobs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fusion Admin Blobs 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: Blobs
  description: The Blob Store REST API allows storing binary objects in Solr. You can use it to store entity extraction models, lookup lists or exclusion lists for use in index pipelines. This may include the entity extraction models and lookup lists included with Fusion in the `{fusion_path}/data/nlp` directory, or files that you have created on your own.
paths:
  /blobs/status:
    get:
      tags:
      - Blobs
      summary: Get blob store service status
      description: Check the status of the Blob Store service.
      operationId: getStatus_2
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceStatus'
  /blobs:
    get:
      tags:
      - Blobs
      summary: List all blobs
      description: 'Get the list of existing blobs and their attributes.


        Note that recursion is off by default.'
      operationId: listBlobManifests
      parameters:
      - name: dir
        in: query
        description: A blob store directory to be queried.
        schema:
          type: string
      - name: recurse
        in: query
        description: '`true` to recurse when querying the directory.'
        schema:
          type: boolean
          default: false
      - name: showdirs
        in: query
        description: Show directories when querying directory.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Blob'
  /blobs/{id}:
    get:
      tags:
      - Blobs
      summary: Get a blob
      description: Get a blob's attributes.
      operationId: getBlob
      parameters:
      - name: id
        in: path
        description: The blob ID.
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              example:
              - id: query-pipeline-js-stage.js
                path: /query-pipeline-js-stage.js
                dir: /
                filename: query-pipeline-js-stage.js
                contentType: text/javascript
                size: 0
                modifiedTime: '2018-09-11T16:23:17.743Z'
                version: 1611328911094841344
                md5: d41d8cd98f00b204e9800998ecf8427e
                metadata:
                  resourceType: file:js-query
    put:
      tags:
      - Blobs
      summary: Upload a blob
      description: Upload a blob and define its ID.
      operationId: putBlob
      parameters:
      - name: id
        in: path
        description: The blob ID.
        required: true
        schema:
          pattern: .*
          type: string
      - name: If-Match
        in: header
        description: An optional tag to match against the specified blob.
        schema:
          type: string
          default: '0'
      - name: Content-Type
        in: header
        description: The media type of the blob body.
        schema:
          type: string
          default: application/octet-stream
      - name: fusion-blob-type
        in: header
        description: The blob sub-type.
        schema:
          type: string
      - name: commit
        in: query
        description: '`true` to commit to Solr''s Blob store.'
        schema:
          type: boolean
          default: true
      - name: update
        in: query
        description: Whether to update the `data`, `metadata`, or `both`.
        schema:
          type: string
          default: both
      requestBody:
        description: The blob to store.
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InputStream'
        required: false
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              example:
                name: mydriver
                contentType: application/java-archive
                size: 707261
                modifiedTime: '2017-06-09T19:00:48.919Z'
                version: 0
                md5: c67163ca764bfe632f28229c142131b5
                metadata:
                  subtype: driver:jdbc
                  drivers: org.postgresql.Driver
                  resourceType: driver:jdbc
      x-codegen-request-body-name: body
    delete:
      tags:
      - Blobs
      summary: Delete a blob
      description: Remove a blob from the Blob Store.
      operationId: deleteFile_1
      parameters:
      - name: id
        in: path
        description: The blob ID.
        required: true
        schema:
          pattern: .*
          type: string
      - name: If-Match
        in: header
        description: An optional tag to match against the specified blob.
        schema:
          type: string
          default: '0'
      - name: commit
        in: query
        description: '`true` to commit to Solr''s Blob store.'
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: successful operation
          content: {}
    head:
      tags:
      - Blobs
      summary: Get blob metadata
      description: Get only the metadata about a blob.
      operationId: getBlobMetadata
      parameters:
      - name: id
        in: path
        description: The blob ID.
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        '200':
          description: successful operation
          content: {}
  /blobs/convert:
    put:
      tags:
      - Blobs
      summary: Convert blob manifests
      description: Migrate blob manifests from 3.x to 4.x format.
      operationId: migrateBlobManifests
      responses:
        '200':
          description: successful operation
          content: {}
      deprecated: true
components:
  schemas:
    InputStream:
      type: object
    Blob:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        path:
          type: string
          readOnly: true
        dir:
          type: string
          readOnly: true
        filename:
          type: string
          readOnly: true
        contentType:
          type: string
          readOnly: true
        size:
          type: integer
          format: int64
          readOnly: true
        modifiedTime:
          type: string
          format: date-time
          readOnly: true
        version:
          type: integer
          format: int64
          readOnly: true
        md5:
          type: string
          readOnly: true
        metadata:
          type: object
          additionalProperties:
            type: string
          readOnly: true
    StatusMessage:
      type: object
      properties:
        date:
          type: string
          format: date-time
          readOnly: true
        message:
          type: string
          readOnly: true
    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'
  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)