Algolia

Algolia Search API

Core indexing and search API for adding, updating and deleting records and querying them with typo-tolerant, faceted, geo-aware and rule-driven search served from globally distributed search nodes. The largest surface in the estate at 78 operations, and the one carrying the retry strategy, asynchronous-task and API-key ACL semantics the rest of the platform inherits.

GitHub OpenAPI

Operations 78

GET /{path} Send requests to the Algolia REST API #
POST /{path} Send requests to the Algolia REST API #
PUT /{path} Send requests to the Algolia REST API #
DELETE /{path} Send requests to the Algolia REST API #
POST /1/indexes/{indexName}/query Search an index #
POST /1/indexes/{indexName}/facets/{facetName}/query Search for facet values #
POST /1/indexes/{indexName}/browse Browse for records #
POST /1/indexes/{indexName} Add a new record (with auto-generated object ID) #
DELETE /1/indexes/{indexName} Delete an index #
GET /1/indexes/{indexName}/{objectID} Retrieve a record #
PUT /1/indexes/{indexName}/{objectID} Add or replace a record #
DELETE /1/indexes/{indexName}/{objectID} Delete a record #
POST /1/indexes/{indexName}/deleteByQuery Delete records matching a filter #
POST /1/indexes/{indexName}/clear Delete all records from an index #
POST /1/indexes/{indexName}/{objectID}/partial Add or update attributes #
POST /1/indexes/{indexName}/batch Batch indexing operations on one index #
POST /1/indexes/*/batch Batch indexing operations on multiple indices #
POST /1/indexes/*/objects Retrieve records #
GET /1/indexes/{indexName}/settings Retrieve index settings #
PUT /1/indexes/{indexName}/settings Update index settings #
GET /1/indexes/{indexName}/synonyms/{objectID} Retrieve a synonym #
PUT /1/indexes/{indexName}/synonyms/{objectID} Create or replace a synonym #
DELETE /1/indexes/{indexName}/synonyms/{objectID} Delete a synonym #
POST /1/indexes/{indexName}/synonyms/batch Create or replace synonyms #
POST /1/indexes/{indexName}/synonyms/clear Delete all synonyms #
POST /1/indexes/{indexName}/synonyms/search Search for synonyms #
GET /1/keys List API keys #
POST /1/keys Create an API key #
GET /1/keys/{key} Retrieve API key permissions #
PUT /1/keys/{key} Update an API key #
DELETE /1/keys/{key} Delete an API key #
POST /1/keys/{key}/restore Restore an API key #
GET /1/indexes/{indexName}/rules/{objectID} Retrieve a rule #
PUT /1/indexes/{indexName}/rules/{objectID} Create or replace a rule #
DELETE /1/indexes/{indexName}/rules/{objectID} Delete a rule #
POST /1/indexes/{indexName}/rules/batch Create or update rules #
POST /1/indexes/{indexName}/rules/clear Delete all rules #
POST /1/indexes/{indexName}/rules/search Search for rules #
POST /1/dictionaries/{dictionaryName}/batch Add or delete dictionary entries #
POST /1/dictionaries/{dictionaryName}/search Search dictionary entries #
GET /1/dictionaries/*/settings Retrieve dictionary settings #
PUT /1/dictionaries/*/settings Update dictionary settings #
GET /1/dictionaries/*/languages List available languages #
POST /1/clusters/mapping Assign or move a user ID #
GET /1/clusters/mapping List user IDs #
POST /1/clusters/mapping/batch Assign multiple userIDs #
GET /1/clusters/mapping/top Get top user IDs #
GET /1/clusters/mapping/{userID} Retrieve user ID #
DELETE /1/clusters/mapping/{userID} Delete user ID #
GET /1/clusters List clusters #
POST /1/clusters/mapping/search Search for user IDs #
GET /1/clusters/mapping/pending Get migration and user mapping status #
GET /1/security/sources List allowed sources #
PUT /1/security/sources Replace allowed sources #
POST /1/security/sources/append Add a source #
DELETE /1/security/sources/{source} Delete a source #
GET /1/logs Retrieve log entries #
GET /1/task/{taskID} Check application task status #
GET /1/indexes/{indexName}/task/{taskID} Check task status #
POST /1/indexes/{indexName}/operation Copy or move an index #
GET /1/indexes List indices #
GET /waitForApiKey Wait for an API key operation #
GET /waitForTask Wait for operation to complete #
GET /waitForAppTask Wait for application-level operation to complete #
GET /browseObjects Get all records from an index #
GET /generateSecuredApiKey Create secured API keys #
GET /accountCopyIndex Copies the given `sourceIndexName` records, rules and synonyms to an other… #
GET /replaceAllObjects Replace all records in an index #
GET /replaceAllObjectsWithTransformation Replace all records in an index #
GET /chunkedBatch Replace all records in an index #
GET /saveObjects Saves the given array of objects in the given index #
GET /saveObjectsWithTransformation Save objects to an Algolia index by leveraging the Transformation pipeline… #
POST /deleteObjects Deletes every records for the given objectIDs #
POST /partialUpdateObjects Replaces object content of all the given objects according to their respective… #
POST /partialUpdateObjectsWithTransformation Save objects to an Algolia index by leveraging the Transformation pipeline… #
GET /indexExists Check if an index exists or not #
GET /setClientApiKey Switch the API key used to authenticate requests #

Documentation

📖
Documentation
https://www.algolia.com/doc/rest-api/search/
📖
APIReference
https://www.algolia.com/doc/api-reference/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/openapi/algolia-search-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/openapi/algolia-algoliasearch-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-api-key-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-synonym-hit-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-rule-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-action-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-search-for-facet-values-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/json-schema/algolia-dictionary-entry-schema.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/overlays/algolia-search-api-overlay.yaml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/algolia-search-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

algolia-search-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Search API
  summary: The Algolia Search API lets you search, configure, and manage your indices and records
  description: '## Client libraries


    Use Algolia''s API clients and libraries to reliably integrate Algolia''s APIs with your apps.'
  version: 1.0.0
servers:
- url: https://{appId}.algolia.net
  variables:
    appId:
      default: ALGOLIA_APPLICATION_ID
- url: https://{appId}-1.algolianet.com
  variables:
    appId:
      default: ALGOLIA_APPLICATION_ID
- url: https://{appId}-2.algolianet.com
  variables:
    appId:
      default: ALGOLIA_APPLICATION_ID
- url: https://{appId}-3.algolianet.com
  variables:
    appId:
      default: ALGOLIA_APPLICATION_ID
- url: https://{appId}-dsn.algolia.net
  variables:
    appId:
      default: ALGOLIA_APPLICATION_ID
security:
- appId: []
  apiKey: []
tags:


# --- truncated at 32 KB (267 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/openapi/algolia-search-api-openapi.yml