Algolia Index

Algolia Index

Certified

Index or replace Algolia records

Batch-add records to an Algolia index; any object with the same objectID is replaced. Runs a single batch write using the Admin API Key.

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

Authenticate with Admin API Key

Admin API Key used for search, indexing, and deletes; render from secrets.

Provide Algolia Application ID

Required; project Application ID from the Algolia dashboard.

Target index name

Algolia index to write into; must exist or be created beforehand in your application.

SubTypeobject

Record objects

List of JSON maps sent as-is to Algolia. If an item includes objectID, it will be replaced; otherwise Algolia generates one.

Reference (ref) of the pluginDefaults to apply to this task.

Raw batch response

Full response returned by Algolia batch write, including taskID and objectIDs.

More Plugins in this Category

NetBox (EE)
NetBox
Enterprise

Enterprise NetBox tasks to create, update, and query devices, IP addresses, and sites over the NetBox API.

Infrastructure

7 tasks

4 blueprints

Clickhouse
Clickhouse

Tasks that connect to ClickHouse via JDBC to run queries and loads.

Data

5 tasks

2 blueprints