View as Markdown
Algolia icon

Algolia ACTION

Create Objects

Adds an array of JavaScript objects to the given index. See docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Algolia account once, then configure and run Create Objects 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-create-objects",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    algolia: { authProvisionId: "apn_xxxxxxx" },
    indexName: "Index Name",
    objects: ["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.

Create Objects inputs
Property Type Description
indexName Index Name string
The name of the index
Required Dynamic
objects Objects string[]
An array of JavaScript objects, each corresponding to a new object in your search index. It's recommended you create this array of objects in a prior code step, then select expression mode and enter a variable reference to that array here
Required
autoGenerateObjectIDIfNotExist Auto Generate Object ID If Not Present boolean
If an objectID property is not present on objects, automatically assign on. Defaults to true
Optional

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-create-objects
Version
0.0.3
App
Algolia
Authentication
API key
Behavior
May modify external data