RapidAPI logo

Sign Up

Log In

Algolia

FREE
By dimas
Updated 3 months ago
Search
-/10
Popularity Score
-
Latency
-
Success Rate

Algolia API Documentation

Add search functionality with autocomplete to your app.

View API Details
POSTaddGlobalApiKey
POSTaddIndexSpecificApiKey
POSTaddSingleObjectToIndex
POSTbatchObjectsWrite
POSTbatchSynonymsWriteOperations
POSTbatchWriteOperations
POSTchangeIndexSettings
POSTclearSingleIndex
POSTcopySingleIndex
POSTcreateAlternativeCorrectionSynonymSet
POSTcreateOneWaySynonymSet
POSTcreatePlaceholderSynonymSet
POSTcreateRegularSynonymSet
POSTdeleteAllSynonyms
POSTdeleteGlobalApiKey
POSTdeleteIndexSpecificApiKey
POSTdeleteRecordByQuery
POSTdeleteSingleIndex
POSTdeleteSingleObject
POSTdeleteSingleSynonymsSet
POSTgetGlobalApiKeyRights
POSTgetGlobalApiKeys
POSTgetIndexApiKeysForAllIndexes
POSTgetIndexContent
POSTgetIndexSettings
POSTgetIndexSpecificApiKeyRights
POSTgetIndexSpecificApiKeys
POSTgetIndexes
POSTgetLogs
POSTgetObjects
POSTgetSingleObject
POSTgetSingleSynonymsSet
POSTgetTaskStatus
POSTmoveSingleIndex
POSTpartiallyUpdateObject
POSTquerySingleIndex
POSTsearchFacetValues
POSTsearchMultipleIndexes
POSTsearchSynonyms
POSTupdateAlternativeCorrectionSynonymSet
POSTupdateGlobalApiKey
POSTupdateIndexSpecificApiKey
POSTupdateOneWaySynonymSet
POSTupdatePlaceholderSynonymSet
POSTupdateRegularSynonymSet
POSTupdateSingleObject
POSTaddGlobalApiKey

This method add a new global API key.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
aclLIST
REQUIREDList of Strings. Contains the list of rights for this key. Here is the complete list of ACL that can be used for a key: `search`, `browse`, `addObject`, `deleteObject`, `deleteIndex`, `settings`, `editSettings`, `analytics`, `listIndexes`. See README for more info.
appIdCREDENTIALS
REQUIREDAlgolia Application ID.
apiKeyCREDENTIALS
REQUIREDAlgolia Application Key.
Optional Parameters
indexesLIST
OPTIONALRestrict this new API key to specific index names. This option is useful if you want to isolate your development and production environments: you can have one API key targeting all development indices and another one that target all production indices. You can target all indices starting by a prefix or finishing by a suffix with the ‘*’ character (for example “dev_*” matches all indices starting by “dev_” and “*_dev” matches all indices finishing by “_dev”). If the list is empty or not set, the API Key will be valid for all indices.
referersLIST
OPTIONALRestrict this new API key to specific referers. You can specify a pattern with one or two *. For example, “https://algolia.com/*” matches all referers starting with “https://algolia.com/” and “*algolia.com” matches all referers ending with “.algolia.com”. You can combine both of them to like “*.algolia.com*” to allow the domain algolia.com. Defaults to all referers if empty or blank
maxQueriesPerIPPerHourNUMBER
OPTIONALSpecify the maximum number of API calls allowed from an IP address per hour.
maxHitsPerQueryNUMBER
OPTIONALSpecify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited).
validityNUMBER
OPTIONALSpecify a validity for this key in seconds (the key will automatically be removed after this period of time). Defaults to 0 (no validity limit).
descriptionSTRING
OPTIONALUsed to identify a key.
queryParametersSTRING
OPTIONALForce some query parameters to be applied foreach query made with this api key. You can force all query parameters like: “typoTolerance=strict&ignorePlurals=false&filters=rights:public”. The parameters use the url string format.
Request Snippet
unirest.post("https://AlgoliadimasV1.p.rapidapi.com/addGlobalApiKey")
.header("X-RapidAPI-Host", "AlgoliadimasV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
Log inSign up

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://AlgoliadimasV1.p.rapidapi.com/addGlobalApiKey")
.header("X-RapidAPI-Host", "AlgoliadimasV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication