Skip to main content

​
Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

​
Pre-built tooling

ToolsStatus
Pre-built authorization (API Key)✅
Pre-built authorization UI✅
Custom authorization UI✅
End-user authorization guide✅
Expired credentials detection✅
ToolsStatus
Pre-built integrations✅
API unification✅
2-way sync✅
Webhooks from Nango on data modifications✅
Real-time webhooks from 3rd-party API🚫 (time to contribute: <48h)
Proxy requests✅
ToolsStatus
HTTP request logging✅
End-to-end type safety✅
Data runtime validation✅
OpenTelemetry export✅
Slack alerts on errors✅
Integration status API✅
ToolsStatus
Create or customize use-cases✅
Pre-configured pagination🚫 (time to contribute: <48h)
Pre-configured rate-limit handling🚫 (time to contribute: <48h)
Per-customer configurations✅

​
API Keys

Function nameDescriptionTypeSource code
delete-api-keyDelete an API key in Algolia.Action🔗 Github
get-api-keyRetrieve a single API key from Algolia.Action🔗 Github
list-api-keysList API keys from Algolia.Action🔗 Github
update-api-keyUpdate an API key in Algolia.Action🔗 Github

​
Api Keys

Function nameDescriptionTypeSource code
create-api-keyCreate an API key in Algolia.Action🔗 Github

​
Indices

Function nameDescriptionTypeSource code
copy-indexCopy an Algolia index to a new destination index.Action🔗 Github
delete-indexDelete an Algolia index and all its objects.Action🔗 Github
get-indexRetrieve metadata for a single Algolia index.Action🔗 Github
list-indicesList indices from Algolia.Action🔗 Github
move-indexRename an Algolia index by moving it to a new name (destructive — overwrites destination).Action🔗 Github

​
Logs

Function nameDescriptionTypeSource code
get-logsRetrieve recent API operation logs from Algolia.Action🔗 Github

​
Objects

Function nameDescriptionTypeSource code
batch-objectsBatch create, update, or delete Algolia objects.Action🔗 Github
create-objectCreate an object in an Algolia index. Returns a generated objectID.Action🔗 Github
delete-objectDelete an object from an Algolia index.Action🔗 Github
get-objectRetrieve a single object from an Algolia index.Action🔗 Github
list-objectsList objects from an Algolia index using the browse endpoint.Action🔗 Github
partial-update-objectUpdate specific attributes of an existing Algolia object without replacing the whole record.Action🔗 Github
update-objectReplace an Algolia object entirely (full overwrite by objectID).Action🔗 Github

​
Rules

Function nameDescriptionTypeSource code
create-ruleCreate a query rule in an Algolia index.Action🔗 Github
delete-ruleDelete a query rule from an Algolia index.Action🔗 Github
get-ruleRetrieve a single query rule from an Algolia index.Action🔗 Github
list-rulesList query rules from an Algolia index.Action🔗 Github
update-ruleUpdate a query rule in an Algolia index.Action🔗 Github
Function nameDescriptionTypeSource code
search-indexRun an Algolia search query against an index.Action🔗 Github
search-multiple-indicesRun search queries across multiple Algolia indices in a single request.Action🔗 Github

​
Settings

Function nameDescriptionTypeSource code
get-settingsRetrieve Algolia index settings.Action🔗 Github
set-settingsUpdate Algolia index settings.Action🔗 Github

​
Synonyms

Function nameDescriptionTypeSource code
create-synonymCreate a synonym in an Algolia index.Action🔗 Github
delete-synonymDelete a synonym from an Algolia index.Action🔗 Github
get-synonymRetrieve a single synonym from an Algolia index.Action🔗 Github
list-synonymsList synonyms from an Algolia index.Action🔗 Github
update-synonymUpdate a synonym in an Algolia index.Action🔗 Github

​
Others

Function nameDescriptionTypeSource code
api-keysSync API keys from Algolia.Sync🔗 Github
indicesSync indices from Algolia.Sync🔗 Github
objectsSync objects from an Algolia indexSync🔗 Github
rulesSync query rules from an Algolia indexSync🔗 Github
synonymsSync synonyms from an Algolia index.Sync🔗 Github

​
Access requirements

Pre-RequisitesStatusComment
Paid dev account❓
Paid test account❓
Partnership❓
App review❓
Security audit❓

​
Setup guide

No setup guide yet.
Need help getting started? Get help in the community.
Contribute improvements to the setup guide by editing this page
Contribute useful links by editing this page

​
API gotchas

  • Algolia uses API_KEY auth mode with X-Algolia-API-Key: API_KEYand X-Algolia-Application-Id: APP_ID in the request header to access different endpoints.
Contribute API gotchas by editing this page

​
Going further

Connect to Algolia

Guide to connect to Algolia using Connect UI