View as Markdown
Algolia icon

Algolia ACTION

Delete Objects

Delete objects from 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 Delete 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-delete-objects",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    algolia: { authProvisionId: "apn_xxxxxxx" },
    indexName: "Index Name",
    objectIds: ["Object Ids"],
  },
})

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.

Delete Objects inputs
Property Type Description
indexName Index Name string
The name of the index
Required Dynamic
objectIds Object Ids string[]
An array of JavaScript object IDs, each corresponding to a existing object in your search index
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-delete-objects
Version
0.0.2
App
Algolia
Authentication
API key
Behavior
May modify external data