Skip to main content
Algolia logo

​
Overview

Add Algolia to any ModuleX agent or workflow. Search and indexing platform for building fast, relevant search experiences via the Algolia REST API ({application_id}-dsn.algolia.net for reads, {application_id}.algolia.net for writes).
Categories: Developer Tools & Infrastructure · Search · Auth: Algolia API Credentials · Actions: 4

​
Authentication

​
Algolia API Credentials

Authenticate using your Algolia Application ID and API Key
1

Step 1

Go to https://dashboard.algolia.com and sign in
2

Step 2

Navigate to Settings > API Keys
3

Step 3

Copy your Application ID and Admin API Key

​
Required Credentials

FieldDescriptionRequiredFormat
Application IDYour Algolia Application ID from the dashboardYesABCDEF1234
Admin API KeyYour Algolia Admin API Key (or a key with appropriate permissions)Yesxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Available Actions

​
Parameters

​
index_name
string
required
The name of the Algolia index to browse

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "hits": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Hits",
      "type": "array"
    },
    "cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cursor"
    }
  },
  "required": [
    "success"
  ],
  "title": "BrowseRecordsOutput",
  "type": "object"
}

​
Parameters

​
index_name
string
required
The name of the Algolia index
​
record_ids
array
required
List of object IDs (strings) to delete from the index

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "task_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Task Id"
    },
    "object_ids": {
      "items": {
        "type": "string"
      },
      "title": "Object Ids",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteRecordsOutput",
  "type": "object"
}

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "index_names": {
      "items": {
        "type": "string"
      },
      "title": "Index Names",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListIndexNameOptionsOutput",
  "type": "object"
}

​
Parameters

​
index_name
string
required
The name of the Algolia index
​
records
array
required
List of JSON objects to save. Each must have an ‘objectID’ field.

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "task_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Task Id"
    },
    "object_ids": {
      "items": {
        "type": "string"
      },
      "title": "Object Ids",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "SaveRecordsOutput",
  "type": "object"
}

​
Limits & Quotas

  • Rate limits depend on the Algolia plan (Community, Standard, Premium). Community plans have lower indexing and search operation limits.
  • Search operations: typically thousands per second on paid plans.
  • Indexing operations: batch limits vary by plan (10 MB per batch maximum payload size).
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Amazon Web Services

Apify

Browser Use