PluginsPlugin Algolia

Index​Index

Index Algolia record(s).

Add or replace one or more records in an Algolia index. If an objectID exists, it is replaced, otherwise a new record is created.

yaml
type: "io.kestra.plugin.algolia.Index"

Index a single product record

yaml
id: index_product
namespace: company.team

tasks:
  - id: index
    type: io.kestra.plugin.algolia.record.Index
    applicationId: "{{ secret('ALGOLIA_APP_ID') }}"
    apiKey: "{{ secret('ALGOLIA_API_KEY') }}"
    indexName: "products"
    objects:
      - objectID: "prod_123"
        name: "Black T-shirt"
        color: "black"

Index multiple product records

yaml
id: batch_products
namespace: company.team

tasks:
  - id: add_products
    type: io.kestra.plugin.algolia.record.Index
    applicationId: "{{ secret('ALGOLIA_APP_ID') }}"
    apiKey: "{{ secret('ALGOLIA_API_KEY') }}"
    indexName: "products"
    objects:
      - objectID: "prod_001"
        name: "Blue T-shirt"
      - objectID: "prod_002"
        name: "Running Shoes"
Properties

API Key

Algolia Admin API Key

Algolia Application ID

Index name

The Algolia index where the record will be stored

SubType object

Record object

The object to index in Algolia (as JSON map)

Raw response from Algolia