Algolia Search

Algolia Search
Certified
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).

yaml
type: io.kestra.plugin.algolia.Search

Examples

Search products

yaml
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

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.

params 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).