View as Markdown
Algolia icon

Algolia ACTION

Save Records

Adds records to an index. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Algolia account once, then configure and run Save Records from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "algolia-save-records",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    algolia: { authProvisionId: "apn_xxxxxxx" },
    indexName: "Index Name",
    records: ["Records From JSON Objects"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Save Records inputs
Property Type Description
indexName Index Name string
The name of the index
Required Dynamic
records Records From JSON Objects string[]
The records to add to the index. Each record should be a JSON object. Eg. {"objectID": "1", "name": "Jane Doe"}. For a better user experience, you can use the CSV File To Objects Helper Function action to convert a CSV file to an array of objects and then map the objects to the records field here as a Custom Expression. Eg. {{steps.csv_file_to_objects.$return_value}}.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
algolia-save-records
Version
0.0.2
App
Algolia
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes