Algolia
Overview
Pre-built tooling
✅ Authorization
| Tools | Status |
|---|---|
| Pre-built authorization (API Key) | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| End-user authorization guide | ✅ |
| Expired credentials detection | ✅ |
✅ Read & write data
| Tools | Status |
|---|---|
| Pre-built integrations | ✅ |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Tenklo on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: <48h) |
| Proxy requests | ✅ |
✅ Observability & data quality
| Tools | Status |
|---|---|
| HTTP request logging | ✅ |
| End-to-end type safety | ✅ |
| Data runtime validation | ✅ |
| OpenTelemetry export | ✅ |
| Slack alerts on errors | ✅ |
| Integration status API | ✅ |
✅ Customization
| Tools | Status |
|---|---|
| Create or customize use-cases | ✅ |
| Pre-configured pagination | 🚫 (time to contribute: <48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: <48h) |
| Per-customer configurations | ✅ |
Others
| Function name | Description | Type | Source code |
|---|---|---|---|
batch-objects | Batch create, update, or delete Algolia objects. | Action | 🔗 Github |
copy-index | Copy an Algolia index to a new destination index. | Action | 🔗 Github |
create-api-key | Create an API key in Algolia. | Action | 🔗 Github |
create-object | Create an object in an Algolia index. Returns a generated objectID. | Action | 🔗 Github |
create-rule | Create a query rule in an Algolia index. | Action | 🔗 Github |
create-synonym | Create a synonym in an Algolia index. | Action | 🔗 Github |
delete-api-key | Delete an API key in Algolia. | Action | 🔗 Github |
delete-index | Delete an Algolia index and all its objects. | Action | 🔗 Github |
delete-object | Delete an object from an Algolia index. | Action | 🔗 Github |
delete-rule | Delete a query rule from an Algolia index. | Action | 🔗 Github |
delete-synonym | Delete a synonym from an Algolia index. | Action | 🔗 Github |
get-api-key | Retrieve a single API key from Algolia. | Action | 🔗 Github |
get-index | Retrieve metadata for a single Algolia index. | Action | 🔗 Github |
get-logs | Retrieve recent API operation logs from Algolia. | Action | 🔗 Github |
get-object | Retrieve a single object from an Algolia index. | Action | 🔗 Github |
get-rule | Retrieve a single query rule from an Algolia index. | Action | 🔗 Github |
get-settings | Retrieve Algolia index settings. | Action | 🔗 Github |
get-synonym | Retrieve a single synonym from an Algolia index. | Action | 🔗 Github |
list-api-keys | List API keys from Algolia. | Action | 🔗 Github |
list-indices | List indices from Algolia. | Action | 🔗 Github |
list-objects | List objects from an Algolia index using the browse endpoint. | Action | 🔗 Github |
list-rules | List query rules from an Algolia index. | Action | 🔗 Github |
list-synonyms | List synonyms from an Algolia index. | Action | 🔗 Github |
move-index | Rename an Algolia index by moving it to a new name (destructive — overwrites destination). | Action | 🔗 Github |
partial-update-object | Update specific attributes of an existing Algolia object without replacing the whole record. | Action | 🔗 Github |
search-index | Run an Algolia search query against an index. | Action | 🔗 Github |
search-multiple-indices | Run search queries across multiple Algolia indices in a single request. | Action | 🔗 Github |
set-settings | Update Algolia index settings. | Action | 🔗 Github |
update-api-key | Update an API key in Algolia. | Action | 🔗 Github |
update-object | Replace an Algolia object entirely (full overwrite by objectID). | Action | 🔗 Github |
update-rule | Update a query rule in an Algolia index. | Action | 🔗 Github |
update-synonym | Update a synonym in an Algolia index. | Action | 🔗 Github |
api-keys | Sync API keys from Algolia. | Sync | 🔗 Github |
indices | Sync indices from Algolia. | Sync | 🔗 Github |
objects | Sync objects from an Algolia index | Sync | 🔗 Github |
rules | Sync query rules from an Algolia index | Sync | 🔗 Github |
synonyms | Sync synonyms from an Algolia index. | Sync | 🔗 Github |
Access requirements
| Pre-Requisites | Status | Comment |
|---|---|---|
| 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
Useful links
Contribute useful links by editing this page
API gotchas
- Algolia uses API_KEY auth mode with
X-Algolia-API-Key: API_KEYandX-Algolia-Application-Id: APP_IDin 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