
Algolia Search
CertifiedQuery records in an Algolia index
Algolia Search
Query records in an Algolia index
Runs a search against a single Algolia index with any supported search parameters and returns hits. Uses the Admin API Key. With no params, the empty query matches all records but returns only the first page (Algolia default hitsPerPage=20).
type: io.kestra.plugin.algolia.SearchExamples
Search products
id: search_products
namespace: company.team
tasks:
- id: search_products
type: io.kestra.plugin.algolia.Search
applicationId: "{{ secret('ALGOLIA_APP_ID') }}"
apiKey: "{{ secret('ALGOLIA_API_KEY') }}"
indexName: "products"
params:
query: "t-shirt"
hitsPerPage: 5
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-algolia --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
apiKey *string
Admin API Key
Admin API Key used for search, indexing, and deletes; render from secrets.
applicationId *string
Algolia Application ID
Required; project Application ID from the Algolia dashboard.
indexName *string
Target index name
Algolia index to query within the configured application.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150params object
Search parameters
Any Algolia search params (query, hitsPerPage, filters, facets, etc.). Defaults to an empty map: the empty query matches all records but returns only the first page (Algolia default hitsPerPage=20).
Outputs
hits array
Search results (hits)
List of hits returned by Algolia for the query.
com.fasterxml.jackson.databind.node.ObjectNode
nbHits integer
Number of hits