Algolia
Connect to the Algolia Search Engine API to get search functionality that autocompletes and displays instant results. Test the API call and export the code.
Algolia endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST |
addGlobalApiKey /addGlobalApiKey |
This method add a new global API key. |
| POST |
addIndexSpecificApiKey /addIndexSpecificApiKey |
This method add a new key that can access to this index. |
| POST |
addSingleObjectToIndex /addSingleObjectToIndex |
This method adds one object in the index with automatic assignation of `objectId`. |
| POST |
batchObjectsWrite /batchObjectsWrite |
Perform multiple write operations in a single API call. |
| POST |
batchSynonymsWriteOperations /batchSynonymsWriteOperations |
Create/update multiple synonym objects at once, potentially replacing the entire list of synonyms if replaceExistingSynonyms is true.You should always use replaceExistingSynonyms… |
| POST |
batchWriteOperations /batchWriteOperations |
Perform multiple write operations, potentially targeting multiple indices, in a single API call. This is essentially a multi-index version of Batch write operations. It can be… |
| POST |
changeIndexSettings /changeIndexSettings |
This method updates part of index settings, the list of attributes and their behavior are listed in the get index settings API. |
| POST |
clearSingleIndex /clearSingleIndex |
This method deletes the index content. Settings and index specific API keys are kept untouched. |
| POST |
copySingleIndex /copySingleIndex |
This method copy an existing index. If the destination index already exists, its specific API keys will be preserved and the source index specific API keys will be added. |
| POST |
createAlternativeCorrectionSynonymSet /createAlternativeCorrectionSynonymSet |
Create a new alternative correction synonym set |
| POST |
createOneWaySynonymSet /createOneWaySynonymSet |
Create a new one-way synonym set |
| POST |
createPlaceholderSynonymSet /createPlaceholderSynonymSet |
Create a new placeholder correction synonym set |
| POST |
createRegularSynonymSet /createRegularSynonymSet |
Create a new regular synonym set |
| POST |
deleteAllSynonyms /deleteAllSynonyms |
Delete all synonyms from the index |
| POST |
deleteGlobalApiKey /deleteGlobalApiKey |
This method deletes a global API key that has been created with the add global Key API. |
| POST |
deleteIndexSpecificApiKey /deleteIndexSpecificApiKey |
This method delete an index specific API key that have been created with the add index specific key API. |
| POST |
deleteRecordByQuery /deleteRecordByQuery |
Delete all records matching the query.This endpoint doesn’t support all the options of a query, only its filters (numeric, facet, or tag) and geo queries. It also doesn’t accept… |
| POST |
deleteSingleIndex /deleteSingleIndex |
This method deletes an existing index. |
| POST |
deleteSingleObject /deleteSingleObject |
This method deletes an existing object from the index |
| POST |
deleteSingleSynonymsSet /deleteSingleSynonymsSet |
Delete a single synonyms set, identified by the given `objectId` |
| POST |
getGlobalApiKeyRights /getGlobalApiKeyRights |
This method returns the rights of a given global API key that has been created with the add global Key API. |
| POST |
getGlobalApiKeys /getGlobalApiKeys |
This method Lists global API keys with their rights. These keys have been created with the add global key API. |
| POST |
getIndexApiKeysForAllIndexes /getIndexApiKeysForAllIndexes |
This method update a key that can access to this index. |
| POST |
getIndexContent /getIndexContent |
This method allows you to retrieve all index content (for backup, SEO or analytics purpose). It can retrieve up to 1,000 records per call and supports full text search and filters. |
| POST |
getIndexSettings /getIndexSettings |
This method retrieve index settings. |
| POST |
getIndexSpecificApiKeyRights /getIndexSpecificApiKeyRights |
This method returns the rights of a given index specific API key that has been created with the add index specific key API. |
| POST |
getIndexSpecificApiKeys /getIndexSpecificApiKeys |
This method Lists API keys that have access to this index with their rights. These keys have been created with the add index specific key API. |
| POST |
getIndexes /getIndexes |
This command lists all your existing indexes. |
| POST |
getLogs /getLogs |
Return last logs. |
| POST |
getObjects /getObjects |
This method allows to retrieve several objects with one API call. |
| POST |
getSingleObject /getSingleObject |
This method returns one object from the index. |
| POST |
getSingleSynonymsSet /getSingleSynonymsSet |
Fetch a single synonyms set, identified by the given `objectId` |
| POST |
getTaskStatus /getTaskStatus |
This method gets the status of a given task (published or notPublished). Returns also a pendingTask flag that indicates if the index has remaining task(s) running. |
| POST |
moveSingleIndex /moveSingleIndex |
This method move an existing index. If the destination index already exists, its specific API keys will be preserved and the source index specific API keys will be added. |
| POST |
partiallyUpdateObject /partiallyUpdateObject |
This method updates part of an object (if the object does not exist, it will be created. You can avoid an automatic creation of the object by passing createIfNotExists=false as… |
| POST |
querySingleIndex /querySingleIndex |
Return objects that match the query. See README. |
| POST |
searchFacetValues /searchFacetValues |
This method searches for values of a given facet, optionally restricting the returned values to those contained in objects matching other search criteria. |
| POST |
searchMultipleIndexes /searchMultipleIndexes |
This method allows to send multiple search queries, potentially targeting multiple indices, in a single API call. |
| POST |
searchSynonyms /searchSynonyms |
Search/browse all synonyms, possibly filtered by type |
| POST |
updateAlternativeCorrectionSynonymSet /updateAlternativeCorrectionSynonymSet |
Update a new alternative correction synonym set |
| POST |
updateGlobalApiKey /updateGlobalApiKey |
This method update a global API key. |
| POST |
updateIndexSpecificApiKey /updateIndexSpecificApiKey |
This method update a key that can access to this index. |
| POST |
updateOneWaySynonymSet /updateOneWaySynonymSet |
Update a new one-way synonym set |
| POST |
updatePlaceholderSynonymSet /updatePlaceholderSynonymSet |
Update a new placeholder correction synonym set |
| POST |
updateRegularSynonymSet /updateRegularSynonymSet |
Update a new regular synonym set |
| POST |
updateSingleObject /updateSingleObject |
This method adds or replaces an object (if the object does not exist, it will be created). Be careful, when an object already exists for the specified object ID, the whole object… |
Algolia pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — | — |