> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Algolia

> How to set up the Algolia connector, plus the actions that are available.

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/algolia/filled/svg" alt="Algolia" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span>v1.1.0</span></div>
    <div><a href="/connectors/algolia/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">42 actions</a> · 1 auth method</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">Search</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · API Key" href="/connectors/algolia/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/algolia/filled/svg" horizontal>
        Connect your Algolia account using your Application ID and API Key from the Algolia dashboard.
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

    See the guide for the authentication type chosen in the Connector Profile:

    <Columns cols={2}>
      <Card title="Link Account · API Key" href="/connectors/algolia/guides/link-account/api-key" icon="https://stackone-logos.com/api/algolia/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>42 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_top_searches" data-action-label="Retrieve Top Searches" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Top Searches</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_top_searches" aria-label="Copy algolia_retrieve_top_searches"><code className="connector-page-code">algolia\_retrieve\_top\_searches</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the most popular search queries.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_number_of_searches" data-action-label="Retrieve Number Of Searches" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Number Of Searches</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_number_of_searches" aria-label="Copy algolia_retrieve_number_of_searches"><code className="connector-page-code">algolia\_retrieve\_number\_of\_searches</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the total number of searches over time.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_searches_no_results" data-action-label="Retrieve Searches No Results" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Searches No Results</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_searches_no_results" aria-label="Copy algolia_retrieve_searches_no_results"><code className="connector-page-code">algolia\_retrieve\_searches\_no\_results</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the most frequent searches without results.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_click_through_rate" data-action-label="Retrieve Click Through Rate" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Click Through Rate</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_click_through_rate" aria-label="Copy algolia_retrieve_click_through_rate"><code className="connector-page-code">algolia\_retrieve\_click\_through\_rate</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves click-through rate analytics.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_average_click_position" data-action-label="Retrieve Average Click Position" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Average Click Position</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_average_click_position" aria-label="Copy algolia_retrieve_average_click_position"><code className="connector-page-code">algolia\_retrieve\_average\_click\_position</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the average position of clicked results.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_top_search_results" data-action-label="Retrieve Top Search Results" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Top Search Results</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_top_search_results" aria-label="Copy algolia_retrieve_top_search_results"><code className="connector-page-code">algolia\_retrieve\_top\_search\_results</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the most frequently returned search results.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_number_of_users" data-action-label="Retrieve Number Of Users" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Number Of Users</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_number_of_users" aria-label="Copy algolia_retrieve_number_of_users"><code className="connector-page-code">algolia\_retrieve\_number\_of\_users</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the number of unique users.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_no_results_rate" data-action-label="Retrieve No Results Rate" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve No Results Rate</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_no_results_rate" aria-label="Copy algolia_retrieve_no_results_rate"><code className="connector-page-code">algolia\_retrieve\_no\_results\_rate</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the rate of searches returning no results.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_searches_no_clicks" data-action-label="Retrieve Searches No Clicks" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Searches No Clicks</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_searches_no_clicks" aria-label="Copy algolia_retrieve_searches_no_clicks"><code className="connector-page-code">algolia\_retrieve\_searches\_no\_clicks</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves top searches that received no clicks.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_no_click_rate" data-action-label="Retrieve No Click Rate" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve No Click Rate</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_no_click_rate" aria-label="Copy algolia_retrieve_no_click_rate"><code className="connector-page-code">algolia\_retrieve\_no\_click\_rate</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the rate of searches without any clicks.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_click_positions" data-action-label="Retrieve Click Positions" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Click Positions</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_click_positions" aria-label="Copy algolia_retrieve_click_positions"><code className="connector-page-code">algolia\_retrieve\_click\_positions</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves click position distribution analytics.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_list_indices" data-action-label="List Indices" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Indices</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_list_indices" aria-label="Copy algolia_list_indices"><code className="connector-page-code">algolia\_list\_indices</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Lists all indices in your Algolia application.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_delete_index" data-action-label="Delete Index" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Index</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_delete_index" aria-label="Copy algolia_delete_index"><code className="connector-page-code">algolia\_delete\_index</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Deletes an index and all its data.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_copy_or_move_index" data-action-label="Copy Or Move Index" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Copy Or Move Index</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_copy_or_move_index" aria-label="Copy algolia_copy_or_move_index"><code className="connector-page-code">algolia\_copy\_or\_move\_index</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Copies or moves (renames) an index within the same Algolia application.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_task_status" data-action-label="Retrieve Task Status" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Task Status</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_task_status" aria-label="Copy algolia_retrieve_task_status"><code className="connector-page-code">algolia\_retrieve\_task\_status</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Gets the status of an asynchronous task.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_send_events" data-action-label="Send Events" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Send Events</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_send_events" aria-label="Copy algolia_send_events"><code className="connector-page-code">algolia\_send\_events</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Sends click, conversion, or view events to Algolia Insights API for analytics and personalization.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_list_api_keys" data-action-label="List API Keys" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List API Keys</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_list_api_keys" aria-label="Copy algolia_list_api_keys"><code className="connector-page-code">algolia\_list\_api\_keys</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Lists all API keys associated with your Algolia application, including their permissions and restrictions.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_get_api_key_info" data-action-label="Get API Key Info" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get API Key Info</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_get_api_key_info" aria-label="Copy algolia_get_api_key_info"><code className="connector-page-code">algolia\_get\_api\_key\_info</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the permissions and details of the current API key.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_record" data-action-label="Retrieve Record" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve Record</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_record" aria-label="Copy algolia_retrieve_record"><code className="connector-page-code">algolia\_retrieve\_record</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves a single record by its objectID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_add_new_record" data-action-label="Add A New Record" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Add A New Record</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_add_new_record" aria-label="Copy algolia_add_new_record"><code className="connector-page-code">algolia\_add\_new\_record</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Adds a record to an index or replaces it with an auto-generated objectID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_add_or_replace_record" data-action-label="Add Or Replace Record" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Add Or Replace Record</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_add_or_replace_record" aria-label="Copy algolia_add_or_replace_record"><code className="connector-page-code">algolia\_add\_or\_replace\_record</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Adds or replaces a record with a specific objectID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_add_or_update_attributes" data-action-label="Add Or Update Attributes" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Add Or Update Attributes</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_add_or_update_attributes" aria-label="Copy algolia_add_or_update_attributes"><code className="connector-page-code">algolia\_add\_or\_update\_attributes</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Partially updates a record by adding or modifying specific attributes.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_delete_record" data-action-label="Delete Record" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Record</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_delete_record" aria-label="Copy algolia_delete_record"><code className="connector-page-code">algolia\_delete\_record</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Removes a record from an index.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_batch_indexing_operations" data-action-label="Batch Indexing Operations On One Index" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Batch Indexing Operations On One Index</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_batch_indexing_operations" aria-label="Copy algolia_batch_indexing_operations"><code className="connector-page-code">algolia\_batch\_indexing\_operations</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Adds, updates, or deletes records in one index with a single API request.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_browse_for_records" data-action-label="Browse For Records" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Browse For Records</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_browse_for_records" aria-label="Copy algolia_browse_for_records"><code className="connector-page-code">algolia\_browse\_for\_records</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves records from an index, up to 1,000 per request.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_delete_records_matching_filter" data-action-label="Delete Records Matching A Filter" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Records Matching A Filter</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_delete_records_matching_filter" aria-label="Copy algolia_delete_records_matching_filter"><code className="connector-page-code">algolia\_delete\_records\_matching\_filter</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Deletes all records matching filter criteria. This operation doesn't accept empty filters.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_a_rule" data-action-label="Retrieve A Rule" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve A Rule</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_a_rule" aria-label="Copy algolia_retrieve_a_rule"><code className="connector-page-code">algolia\_retrieve\_a\_rule</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves a single rule by its ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_create_or_replace_rule" data-action-label="Create Or Replace A Rule" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Or Replace A Rule</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_create_or_replace_rule" aria-label="Copy algolia_create_or_replace_rule"><code className="connector-page-code">algolia\_create\_or\_replace\_rule</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Creates or replaces a query rule.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_delete_a_rule" data-action-label="Delete A Rule" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete A Rule</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_delete_a_rule" aria-label="Copy algolia_delete_a_rule"><code className="connector-page-code">algolia\_delete\_a\_rule</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Removes a rule from the index.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_create_or_update_rules" data-action-label="Create Or Update Rules" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Or Update Rules</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_create_or_update_rules" aria-label="Copy algolia_create_or_update_rules"><code className="connector-page-code">algolia\_create\_or\_update\_rules</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Creates or updates multiple rules at once.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_delete_all_rules" data-action-label="Delete All Rules" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete All Rules</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_delete_all_rules" aria-label="Copy algolia_delete_all_rules"><code className="connector-page-code">algolia\_delete\_all\_rules</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Removes all rules from an index.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_search_for_rules" data-action-label="Search For Rules" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Search For Rules</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_search_for_rules" aria-label="Copy algolia_search_for_rules"><code className="connector-page-code">algolia\_search\_for\_rules</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Searches for rules in your index.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_search_single_index" data-action-label="Search Single Index" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Search Single Index</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_search_single_index" aria-label="Copy algolia_search_single_index"><code className="connector-page-code">algolia\_search\_single\_index</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Searches for records in a single index and returns matching hits.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_search_multiple_indices" data-action-label="Search Multiple Indices" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Search Multiple Indices</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_search_multiple_indices" aria-label="Copy algolia_search_multiple_indices"><code className="connector-page-code">algolia\_search\_multiple\_indices</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Searches across multiple indices in a single request.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_index_settings" data-action-label="Get Index Settings" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Index Settings</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_index_settings" aria-label="Copy algolia_retrieve_index_settings"><code className="connector-page-code">algolia\_retrieve\_index\_settings</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves all settings for an index.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_update_index_settings" data-action-label="Update Index Settings" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Index Settings</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_update_index_settings" aria-label="Copy algolia_update_index_settings"><code className="connector-page-code">algolia\_update\_index\_settings</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Updates settings for an index.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_search_for_synonyms" data-action-label="Search For Synonyms" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Search For Synonyms</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_search_for_synonyms" aria-label="Copy algolia_search_for_synonyms"><code className="connector-page-code">algolia\_search\_for\_synonyms</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves all synonyms for an index.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_retrieve_a_synonym" data-action-label="Retrieve A Synonym" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Retrieve A Synonym</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_retrieve_a_synonym" aria-label="Copy algolia_retrieve_a_synonym"><code className="connector-page-code">algolia\_retrieve\_a\_synonym</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves a single synonym by its ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_create_or_replace_a_synonym" data-action-label="Create Or Replace A Synonym" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Or Replace A Synonym</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_create_or_replace_a_synonym" aria-label="Copy algolia_create_or_replace_a_synonym"><code className="connector-page-code">algolia\_create\_or\_replace\_a\_synonym</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Creates or updates a single synonym.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_delete_a_synonym" data-action-label="Delete A Synonym" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete A Synonym</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_delete_a_synonym" aria-label="Copy algolia_delete_a_synonym"><code className="connector-page-code">algolia\_delete\_a\_synonym</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Removes a synonym from the index.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_delete_all_synonyms" data-action-label="Delete All Synonyms" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete All Synonyms</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_delete_all_synonyms" aria-label="Copy algolia_delete_all_synonyms"><code className="connector-page-code">algolia\_delete\_all\_synonyms</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Removes all synonyms from an index.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="algolia_create_or_replace_synonyms" data-action-label="Create Or Replace Synonyms" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Or Replace Synonyms</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="algolia_create_or_replace_synonyms" aria-label="Copy algolia_create_or_replace_synonyms"><code className="connector-page-code">algolia\_create\_or\_replace\_synonyms</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Creates or updates multiple synonyms at once.</div>
      </div>
    </div>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.