Algolia Integration

Need to add real-time search to your agents? Algolia offers blazing-fast full-text search with typo-tolerance and instant filtering.

TL;DR

Secure your Algolia Application ID and Search-Only API Key from your dashboard, store them in Vault, and use the Search component to query your index.

List of Algolia Components

Component	What it Does	Inputs	Key Outputs	Use Case
Search	Searches your Algolia index using a user query	index, text, app_id	results	Search product listings or support docs live

Required Setup

API Key Access

Before you begin, you'll need two credentials from your Algolia dashboard:

• Application ID (to identify your project)
• Search-Only API Key (read access only)

Use Vault

Store your API key securely in Vault so that you can use it across components and flows.

Creating a Search Index

When you first register, Algolia will prompt you to:

• Create an application
• Create an index (you can use their demo dataset or upload your own)

Once created, your index name (e.g. products) is used in the component input.

Search Component

Use this component to perform keyword searches within a specific index tied to your Algolia project.

Inputs

Field	Required	Description
index	required	The name of the Algolia index you want to search
text	required	The user query string (e.g., "t-shirt large")
app_id	required	Your Algolia Application ID (from dashboard)

Note: You can add advanced filters or custom parameters using the + Add Input button.

Outputs

Field	Description
results	Array of objects matching the query (hits)
response	Full JSON API response
headers	HTTP response headers

{ "component": "algolia.search", "app_id": "LATENCY", "index": "contacts", "text": "emma" }

Best Practices

• Use Vault to secure all API credentials
• Normalize input queries (lowercase, trimmed) to improve match accuracy
• Use Algolia's relevance settings (ranking, typo-tolerance) in the dashboard to fine-tune results
• Filter based on tags or metadata using custom parameters
• Combine with a user message input component for dynamic end-user queries

Troubleshooting

Error	Cause	Resolution
403 Forbidden	Invalid or missing API key	Double-check key in Vault or component settings
Index Not Found	Mistyped or missing index name	Verify index name from Algolia dashboard
No Results	Legitimate empty result	Check spelling or filters on the query

What's Next?

Use Algolia in flows like:

• 🔎 Instant search for products, articles, or people
• 🧭 Multi-index search (run separate searches across indexes in parallel)
• 💬 Natural language queries from user input → Algolia search → Doc response