Lucidworks builds AI-powered search, discovery, and agent platforms used by enterprise commerce, support, and workplace teams. The Lucidworks AI Platform, Fusion, Neural Hybrid Search, Agent Studio, Commerce Studio, and Analytics Studio expose REST APIs for prediction, embedding, classification, signals capture, query rewriting, custom rule management, content chunking, and model deployment.
Lucidworks publishes 40 API contracts indexed on the APIs.io network, including Chunking API, Classification API, Deployments API, and 37 more. Tagged areas include Search, Artificial Intelligence, Enterprise Search, Vector Search, and RAG.
The Lucidworks catalog on APIs.io includes 1 Spectral governance ruleset.
Lucidworks’ developer surface includes authentication, documentation, API reference, engineering blog, and 14 more developer resources.
Regulatory Posture applies to this provider. Its tags matched the
Horizontal (data, software, accessibility, platform) regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 75 points between them,
because the conditional facet above carries the other
25. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 75% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site.
It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/lucidworks/"><img src="https://apis.io/badge/lucidworks/card.svg" alt="Lucidworks on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
MCP Server+12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency+9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
Stable Error Semantics+8 pts — OpenAPI $refs a shared error schema across 4xx/5xx responses (verified), else common[].type includes ErrorCatalog / ErrorCodes / DeclineCodes
A2A Agent Card+8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Delegated User Identity+6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)
9 more unmet checks in the Agent Readiness table above.
Kin Score — facets with the most composite points still available (weight × headroom):
Access Clarityscores 13.2 — up to +17.4 composite points
The Kin Score Market layer reads a provider inside its market:
its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted:
not part of the Kin Score or agent readiness.
Registered MCP server and declares compatibility are report only — not weighted.
Undeclared means we found nothing we can read, so there is no number: we never infer integrations.
Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.
Fusion REST APIs administer collections, indexing pipelines, query pipelines, connectors, and search apps inside the Lucidworks Fusion platform. The legacy Custom Rules API for ...
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...
The Collections API manages Fusion collections. It provides endpoints for creating, updating, and deleting collection, as well as endpoints for getting a collection's status and...
The Configurations API allows setting global properties for Fusion. Some settings are not set by any configuration file but are reported as settings from the operating system. T...
These APIs manage data models. Data models simplify the process of getting started with Fusion by providing pre-configured objects to reduce the effort spent on basic starting t...
The Features API lets you observe the status of features across collections. To manipulate features for a specific collection, use the Collections API.
These endpoints show you how your Fusion objects are grouped. For example, you can use this API to see the signals-related jobs and collections that are part of a primary collec...
The Links API manages the links that represent the relationships between Fusion objects. You can see these links in the Object Explorer in the Fusion UI. You can also export and...
The Objects API lets you import and export objects between Fusion instances. Fusion objects include all your searchable data, plus pipelines, aggregations, and other configurati...
Use the Scheduler API to define a schedule for system activities and manage the jobs that result from the schedule. All of the Fusion services are available for scheduling, as a...
The Solr Admin API lets you send commands to Solr through Fusion's proxy service. This allows you to protect your Solr instances from outside connections, and apply roles and us...
The Solr API is used to manage collection-level configurations. Since this API proxies requests to Solr, each available method corresponds to the method in Solr. So, a `GET` req...
The ZooKeeper Import/Export API provides methods to upload or download information from Fusion's ZooKeeper service. This service provides an alternative to the ZooKeeper clients...
Not yet checked against Lucidworks's own pricing page. Compiled by API Evangelist on 2026-05-05 from lucidworks.com/; confirm before you rely on a figure.
aid: lucidworks
name: Lucidworks
url: https://raw.githubusercontent.com/api-evangelist/lucidworks/refs/heads/main/apis.yml
deliveryModel:
model: library
open_source: false
commercial: false
callable_host: false
label: Library · distributed through package registries, no callable service
confidence: low
source:
- openapi
generated: '2026-08-28'
method: derived
accessModel:
pricing: enterprise
onboarding: unknown
trial: false
try_now: false
public: false
label: Enterprise
confidence: medium
source:
- plans
- authentication
- security
generated: '2026-11-06'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/lucidworks.png
type: Index
position: Consuming
access: 3rd-Party
x-docs-platform: mintlify
x-docs-platform-confidence: medium
x-docs-platform-checked: 2026-10-03
x-docs-hosting: vercel
tags:
- Search
- Artificial Intelligence
- Enterprise Search
- Vector Search
- RAG
- Commerce
created: '2025-01-07'
modified: '2026-10-06'
specificationVersion: '0.23'
description: Lucidworks builds AI-powered search, discovery, and agent platforms used by enterprise commerce, support, and
workplace teams. The Lucidworks AI Platform, Fusion, Neural Hybrid Search, Agent Studio, Commerce Studio, and Analytics
Studio expose REST APIs for prediction, embedding, classification, signals capture, query rewriting, custom rule management,
content chunking, and model deployment.
apis:
- aid: lucidworks:fusion
name: Lucidworks Fusion REST API
description: Fusion REST APIs administer collections, indexing pipelines, query pipelines, connectors, and search apps inside
the Lucidworks Fusion platform. The legacy Custom Rules API for Fusion 5.7 is part of this family of administrative endpoints.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
tags:
- Fusion
- Enterprise Search
- Indexing
- Pipelines
- Connectors
properties:
- type: Documentation
url: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
- type: Documentation
url: https://legacydoc.lucidworks.com/fusion/5.7/331/custom-rules-api
- aid: lucidworks:lucidworks-chunking-api
name: Lucidworks Chunking API
description: Split content into chunks
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Chunking
properties:
- type: OpenAPI
url: openapi/lucidworks-chunking-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-classification-api
name: Lucidworks Classification API
description: Predict ranked labels
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Classification
properties:
- type: OpenAPI
url: openapi/lucidworks-classification-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-deployments-api
name: Lucidworks Deployments API
description: Manage model deployments
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Deployment
tags_raw:
- Deployments
properties:
- type: OpenAPI
url: openapi/lucidworks-deployments-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-embeddings-api
name: Lucidworks Embeddings API
description: Generate vector encodings
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Embeddings
properties:
- type: OpenAPI
url: openapi/lucidworks-embeddings-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-models-api
name: Lucidworks Models API
description: Manage models
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Models
properties:
- type: OpenAPI
url: openapi/lucidworks-models-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-predictions-api
name: Lucidworks Predictions API
description: Submit prediction requests by use case
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Predictions
properties:
- type: OpenAPI
url: openapi/lucidworks-predictions-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-queryrewrites-api
name: Lucidworks QueryRewrites API
description: Manage query rewrite rules
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- QueryRewrites
properties:
- type: OpenAPI
url: openapi/lucidworks-queryrewrites-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-results-api
name: Lucidworks Results API
description: Fetch prediction results
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Results
properties:
- type: OpenAPI
url: openapi/lucidworks-results-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-rules-api
name: Lucidworks Rules API
description: Manage custom business rules
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Rules
properties:
- type: OpenAPI
url: openapi/lucidworks-rules-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-signals-api
name: Lucidworks Signals API
description: Capture and retrieve user behavior signals
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Signals
properties:
- type: OpenAPI
url: openapi/lucidworks-signals-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-tokenization-api
name: Lucidworks Tokenization API
description: Tokenize text by model
humanURL: https://doc.lucidworks.com/api-reference
baseURL: https://api.lucidworks.ai
tags:
- Tokenization
properties:
- type: OpenAPI
url: openapi/lucidworks-tokenization-api-openapi.yml
- type: Documentation
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-predictions/english-language-model-text-encoder
- type: Documentation
url: https://doc.lucidworks.com/api-reference/get-signals/click-signals
- type: Documentation
url: https://doc.lucidworks.com/api-reference/rule-management/list-rules
- type: Documentation
url: https://doc.lucidworks.com/api-reference/query-rewrite-management/list-query-rewrites
- type: Documentation
url: https://doc.lucidworks.com/api-reference/split-content-into-chunks/chunk-text-using-the-specified-chunker
- type: Documentation
url: https://doc.lucidworks.com/api-reference/manage-models/list-all-models
- aid: lucidworks:lucidworks-apps-api
name: Lucidworks Apps API
description: The Apps API manages your Fusion apps. To export or import an app, see the Objects API. You can also import
an app using the Fusion UI.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Application
tags_raw:
- Apps
properties:
- type: OpenAPI
url: openapi/lucidworks-apps-api-openapi.yml
- aid: lucidworks:lucidworks-blobs-api
name: Lucidworks Blobs API
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.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Blobs
properties:
- type: OpenAPI
url: openapi/lucidworks-blobs-api-openapi.yml
- aid: lucidworks:lucidworks-collections-api
name: Lucidworks Collections API
description: 'The Collections API manages Fusion collections. It provides endpoints for creating, updating, and deleting
collection, as well as endpoints for getting a collection''s status and usage statistics.
Fusion maintains internal system collections for logs, blobs, and metrics data which operate in conjunction with collections
created by users. The Collections API is used to manage all Fusion collections.'
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Collection
tags_raw:
- Collections
properties:
- type: OpenAPI
url: openapi/lucidworks-collections-api-openapi.yml
- aid: lucidworks:lucidworks-configurations-api
name: Lucidworks Configurations API
description: 'The Configurations API allows setting global properties for Fusion.
Some settings are not set by any configuration file but are reported as settings from the operating system. Those settings
cannot be changed with this API.
> ⚠️ **Blocked by default:** This API is blocked on the API gateway by default because it exposes all Fusion admin service
environment variables. It can be enabled in special cases — contact [Lucidworks Support](https://lucidworks.com/support)
to discuss your use case. In Fusion 5.18 and later, use [Fusion Vault](/docs/5/fusion/operations/security/external-vault)
instead, which provides a safer, structured approach to managing configuration values and secrets. The Configurations
API is deprecated as of Fusion 5.18.'
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Configurations
properties:
- type: OpenAPI
url: openapi/lucidworks-configurations-api-openapi.yml
- aid: lucidworks:lucidworks-crud-events-api
name: Lucidworks CRUD events API
description: Check the status of the CRUD Events service.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- CRUD events
properties:
- type: OpenAPI
url: openapi/lucidworks-crud-events-api-openapi.yml
- aid: lucidworks:lucidworks-data-models-api
name: Lucidworks Data models API
description: 'These APIs manage data models.
Data models simplify the process of getting started with Fusion by providing pre-configured objects to reduce the effort
spent on basic starting tasks. This helps keep documents consistent between datasources and intuitive to the object''s
type.'
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Data Models
tags_raw:
- Data models
properties:
- type: OpenAPI
url: openapi/lucidworks-data-models-api-openapi.yml
- aid: lucidworks:lucidworks-features-api
name: Lucidworks Features API
description: The Features API lets you observe the status of features across collections. To manipulate features for a
specific collection, use the Collections API.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Features
properties:
- type: OpenAPI
url: openapi/lucidworks-features-api-openapi.yml
- aid: lucidworks:lucidworks-groups-api
name: Lucidworks Groups API
description: These endpoints show you how your Fusion objects are grouped. For example, you can use this API to see the
signals-related jobs and collections that are part of a primary collection's group.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Group
tags_raw:
- Groups
properties:
- type: OpenAPI
url: openapi/lucidworks-groups-api-openapi.yml
- aid: lucidworks:lucidworks-history-api
name: Lucidworks History API
description: The History API provides information about the services that are running. The list of these services is provided
by the Introspect API.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- History
properties:
- type: OpenAPI
url: openapi/lucidworks-history-api-openapi.yml
- aid: lucidworks:lucidworks-introspect-api
name: Lucidworks Introspect API
description: The Fusion Introspect endpoint lists basic information about endpoints and parameters for all Fusion endpoints.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Introspect
properties:
- type: OpenAPI
url: openapi/lucidworks-introspect-api-openapi.yml
- aid: lucidworks:lucidworks-jobs-api
name: Lucidworks Jobs API
description: The Jobs API allows you to define schedules for objects that perform work. You can schedule datasources, tasks,
and Spark jobs.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Job
tags_raw:
- Jobs
properties:
- type: OpenAPI
url: openapi/lucidworks-jobs-api-openapi.yml
- aid: lucidworks:lucidworks-license-api
name: Lucidworks License API
description: The License API provides license management features.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- License
properties:
- type: OpenAPI
url: openapi/lucidworks-license-api-openapi.yml
- aid: lucidworks:lucidworks-links-api
name: Lucidworks Links API
description: 'The Links API manages the links that represent the relationships between Fusion objects. You can see these
links in the Object Explorer in the Fusion UI. You can also export and import links using the Objects API.
Links are structured as a tuple of (`subject`, `object`, `linkType`). An example would be (`foo`, `bar`, `dependsOn`),
which would read as "foo dependsOn bar".'
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Links
properties:
- type: OpenAPI
url: openapi/lucidworks-links-api-openapi.yml
- aid: lucidworks:lucidworks-nodes-api
name: Lucidworks Nodes API
description: The Nodes API lets you check the status of each node in the search cluster.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Node
tags_raw:
- Nodes
properties:
- type: OpenAPI
url: openapi/lucidworks-nodes-api-openapi.yml
- aid: lucidworks:lucidworks-objects-api
name: Lucidworks Objects API
description: The Objects API lets you import and export objects between Fusion instances. Fusion objects include all your
searchable data, plus pipelines, aggregations, and other configurations on which your collections depend.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Objects
properties:
- type: OpenAPI
url: openapi/lucidworks-objects-api-openapi.yml
- aid: lucidworks:lucidworks-registration-api
name: Lucidworks Registration API
description: Check the status of the Registration service.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Registration
properties:
- type: OpenAPI
url: openapi/lucidworks-registration-api-openapi.yml
- aid: lucidworks:lucidworks-scheduler-api
name: Lucidworks Scheduler API
description: 'Use the Scheduler API to define a schedule for system activities and manage the jobs that result from the
schedule. All of the Fusion services are available for scheduling, as are any Solr activities and any other HTTP-based
URI.
>This API is deprecated in favor of the Jobs API.'
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Scheduler
properties:
- type: OpenAPI
url: openapi/lucidworks-scheduler-api-openapi.yml
- aid: lucidworks:lucidworks-search-cluster-api
name: Lucidworks Search cluster API
description: The Search Cluster API lets you connect Fusion with existing Solr instances in a Zookeeper-managed cluster.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Search cluster
properties:
- type: OpenAPI
url: openapi/lucidworks-search-cluster-api-openapi.yml
- aid: lucidworks:lucidworks-search-logs-api
name: Lucidworks Search logs API
description: The Search Logs API lets you manage a `searchLogs` collection.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Search logs
properties:
- type: OpenAPI
url: openapi/lucidworks-search-logs-api-openapi.yml
- aid: lucidworks:lucidworks-solr-admin-api
name: Lucidworks Solr admin API
description: 'The Solr Admin API lets you send commands to Solr through Fusion''s proxy service. This allows you to protect
your Solr instances from outside connections, and apply roles and user permissions from Fusion when running Solr commands.
Requests sent to this API are subject to access restrictions above the collection level.
Note that because one `searchCluster` may host several collections, it is not recommended to use this with a collection-level
command (such as a query, or document update).'
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Solr admin
properties:
- type: OpenAPI
url: openapi/lucidworks-solr-admin-api-openapi.yml
- aid: lucidworks:lucidworks-solr-api
name: Lucidworks Solr API
description: 'The Solr API is used to manage collection-level configurations.
Since this API proxies requests to Solr, each available method corresponds to the method in Solr. So, a `GET` request
to Solr would use the `GET` method of this endpoint; a `POST` would use the `POST` method, and so on.
Depending on the request, the response may consist of records that match a query or output from a Schema API request.'
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Solr
properties:
- type: OpenAPI
url: openapi/lucidworks-solr-api-openapi.yml
- aid: lucidworks:lucidworks-solr-configuration-api
name: Lucidworks Solr Configuration API
description: The Solr Configuration REST API lets you access and manage Solr configuration files stored in ZooKeeper.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Solr Configuration
properties:
- type: OpenAPI
url: openapi/lucidworks-solr-configuration-api-openapi.yml
- aid: lucidworks:lucidworks-swagger-api
name: Lucidworks Swagger API
description: These endpoints give you details about Fusion's REST API schemas.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Swagger
properties:
- type: OpenAPI
url: openapi/lucidworks-swagger-api-openapi.yml
- aid: lucidworks:lucidworks-system-api
name: Lucidworks System API
description: The System REST API allows you to monitor the system performance.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- System
properties:
- type: OpenAPI
url: openapi/lucidworks-system-api-openapi.yml
- aid: lucidworks:lucidworks-tasks-api
name: Lucidworks Tasks API
description: These endpoints let you manage tasks, a flexible job type that can be used to clean up old logs or run any
REST call.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Task
tags_raw:
- Tasks
properties:
- type: OpenAPI
url: openapi/lucidworks-tasks-api-openapi.yml
- aid: lucidworks:lucidworks-update-api
name: Lucidworks Update API
description: Consult Lucidworks before using these endpoints.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags: []
tags_raw:
- Update
properties:
- type: OpenAPI
url: openapi/lucidworks-update-api-openapi.yml
- aid: lucidworks:lucidworks-webapps-api
name: Lucidworks Webapps API
description: Deprecated.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- Web App
tags_raw:
- Webapps
properties:
- type: OpenAPI
url: openapi/lucidworks-webapps-api-openapi.yml
- aid: lucidworks:lucidworks-zookeeper-api
name: Lucidworks Zoo Keeper API
description: The ZooKeeper Import/Export API provides methods to upload or download information from Fusion's ZooKeeper
service. This service provides an alternative to the ZooKeeper clients `zkCli.sh` and `zk-shell` which are part of the
Apache Zookeeper distribution included as part of the Fusion distribution.
humanURL: https://doc.lucidworks.com/docs/5/fusion/dev-portal/rest-apis
baseURL: https://api.lucidworks.ai
tags:
- ZooKeeper
properties:
- type: OpenAPI
url: openapi/lucidworks-zookeeper-api-openapi.yml
common:
- type: Plans
url: plans/lucidworks-plans-pricing.yml
- type: RateLimits
url: rate-limits/lucidworks-rate-limits.yml
- type: FinOps
url: finops/lucidworks-finops.yml
- url: https://lucidworks.com/blog/feed
type: BlogRSS
- type: CapabilityMap
url: capabilities/lucidworks-capability-edges.yml
name: Lucidworks Business Capability Map
- type: AgenticAccess
url: agentic-access/lucidworks-agentic-access.yml
- type: TrustCenter
url: security/lucidworks-trust-center.yml
- type: DomainSecurity
url: security/lucidworks-domain-security.yml
- type: Authentication
url: authentication/lucidworks-authentication.yml
- type: GitHubOrganization
url: https://github.com/lucidworks
- type: LinkedIn
url: https://www.linkedin.com/company/lucidworks
- type: Website
url: https://lucidworks.com
- type: Documentation
url: https://doc.lucidworks.com
- type: APIReference
url: https://doc.lucidworks.com/api-reference
- type: Authentication
url: https://doc.lucidworks.com/api-reference/request-access-token/request-access-token
- type: SDKs
url: https://doc.lucidworks.com/docs/5/fusion/dev-portal/connectors-sdk/overview
- type: Blog
url: https://lucidworks.com/blog
- type: LlmsText
url: https://lucidworks.ai/llms.txt
maintainers:
- FN: Kin Lane
email: kin@apievangelist.com
Lucidworks API — frequently asked questions
Does Lucidworks have an API?
Yes. APIs.io lists 40 APIs from Lucidworks, including Lucidworks Fusion REST API, Lucidworks Chunking API and Lucidworks Classification API, and 37 more.
Is there an OpenAPI specification for the Lucidworks API?
Yes. APIs.io indexes 39 OpenAPI specifications for Lucidworks, each linked for download from this page.
How do I authenticate with the Lucidworks API?
Lucidworks uses bearer-token authentication (http · 1 scheme). The details are profiled on APIs.io as Lucidworks Authentication.
How much does the Lucidworks API cost?
APIs.io lists 1 pricing plan for Lucidworks, with each plan's price, limits and inclusions under Pricing on this page.
Is the Lucidworks API ready for AI agents?
Lucidworks has a Kin Score of 34.4 out of 100 (thin) and an Agent Readiness score of 20.3 (agent-aware), scored by API Evangelist on 2026-11-06.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
Kin Score
How this is scored →
It updates itself when the score changes. Paste this where you link to your API docs: