# Algolia Website Indexer (`apify/algolia-website-indexer`) Actor

The Indexer crawls recursively a website using the Puppeteer browser (headless Chrome) and indexes the selected pages to the Algolia index.

- **URL**: https://apify.com/apify/algolia-website-indexer.md
- **Developed by:** [Apify](https://apify.com/apify) (Apify)
- **Categories:** Automation, Open source
- **Features:** Full permissions
- **Stats:** 22 total users, 0 monthly users, 100.0% runs succeeded, 2 bookmarks
- **User rating**: 5.00 out of 5 stars

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Algolia Website Indexer

The Indexer crawls a website using the Puppeteer browser (headless Chrome) and indexes the selected pages to the Algolia index.
It was designed to run in an Apify actor.

### Usage

You can find instructions on how to run it in the Apify cloud on its Apify Store page.
If you want to run it in your environment, you can use the Apify CLI.

### Input

The input of the actor is JSON with the following parameters.

| Field | Type | Description |
| ----- | ---- | ----------- |
| algoliaAppId | String | Your Algolia Application ID |
| algoliaApiKey | String | Your Algolia API key |
| algoliaIndexName | String | Your Algolia index name  |
| crawlerName | String | Crawler name, it updates/removes/adds pages into the index regarding this name. In this case, you can have more websites in the index. |
| startUrls | Array | URLs where crawler starts crawling |
| selectors | Array | Selectors, which text content you want to index. Key is name of the attribute and value is the CSS selector.  |
| waitForElement | String | Selector of an element to wait on each page. |
| additionalPageAttrs | Object | Additional attributes you want to attach to each record in the index. |
| skipIndexUpdate | Boolean | Option to switch off updating the Algolia index. |

#### Advanced

There are a few parameters not shown in the UI. These parameters change the behaviour of crawling, and you can set them up using the API or in the local environment.

| Field | Type | Description |
| ----- | ---- | ----------- |
| pageFunction | String | Overrides default pageFunction |
| pseudoUrls | Array | Overrides default pseudoUrls |
| clickableElements | String | Overrides default clickableElements |
| keepUrlFragment | Boolean | Option to switch on enqueueing URL with URL fragments |
| omitSearchParamsFromUrl | Boolean | Option to switch off enqueueing with search params. |

### Debug indexed pages

You can find all the pages that will be indexed in the default dataset for a specific actor run.

# Actor input Schema

## `algoliaAppId` (type: `string`):

Your Algolia Application ID

## `algoliaApiKey` (type: `string`):

Your Algolia API key

## `algoliaIndexName` (type: `string`):

Your Algolia index name

## `crawlerName` (type: `string`):

Crawler name, it updates/removes/adds pages into to index regarding this name. In this case, you can have more website in the index.

## `startUrls` (type: `array`):

URLs where to start crawling

## `selectors` (type: `array`):

Pick selectors, which text content you want to index. Key is name of attribute and value is CSS selector.

## `requiredAttributes` (type: `array`):

Pick attributes, which are required in index. By default all attributes from selectors are required.

## `waitForElement` (type: `string`):

Selector of element to wait on each page.

## `additionalPageAttrs` (type: `object`):

Pick additional attributes you want to attach to each record in index.

## `skipIndexUpdate` (type: `boolean`):

If check crawler will not update Algolia index.

## `pseudoUrls` (type: `array`):

Overrides default pseudoUrls

## `pageFunction` (type: `string`):

Overrides default pageFunction

## `clickableElements` (type: `string`):

Overrides default clickableElements

## `keepUrlFragments` (type: `boolean`):

Option to switch on enqueueing URL with URL fragments

## `omitSearchParamsFromUrl` (type: `boolean`):

Option to switch off enqueueing with search params.

## Actor input object example

```json
{
  "startUrls": [
    {
      "url": "http://example.com"
    }
  ],
  "selectors": [
    {
      "key": "h1",
      "value": "body"
    }
  ],
  "requiredAttributes": [],
  "additionalPageAttrs": {},
  "skipIndexUpdate": true,
  "keepUrlFragments": false,
  "omitSearchParamsFromUrl": false
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "startUrls": [
        {
            "url": "http://example.com"
        }
    ],
    "selectors": [
        {
            "key": "h1",
            "value": "body"
        }
    ],
    "requiredAttributes": [],
    "additionalPageAttrs": {}
};

// Run the Actor and wait for it to finish
const run = await client.actor("apify/algolia-website-indexer").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "startUrls": [{ "url": "http://example.com" }],
    "selectors": [{
            "key": "h1",
            "value": "body",
        }],
    "requiredAttributes": [],
    "additionalPageAttrs": {},
}

# Run the Actor and wait for it to finish
run = client.actor("apify/algolia-website-indexer").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "startUrls": [
    {
      "url": "http://example.com"
    }
  ],
  "selectors": [
    {
      "key": "h1",
      "value": "body"
    }
  ],
  "requiredAttributes": [],
  "additionalPageAttrs": {}
}' |
apify call apify/algolia-website-indexer --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,apify/algolia-website-indexer"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/KtitP9qXCTZkJ5Wm4/builds/7genhiZx9fqtjeScb/openapi.json