> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/algolia-prebuilt-connector.md).

# Algolia (prebuilt connector)

## Description

**Algolia** is a search-as-a-service API that focuses on providing the best experience for end users. 

## Authentication 

When adding connector instances for **Algolia**, the following authentication methods are supported:

* [API key](#api-key-authentication)

### API key authentication

When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **API key** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th width="145" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>application id</code></td><td>true</td><td> </td></tr><tr><td><code>api key</code></td><td>true</td><td> </td></tr><tr><td><code>index name</code></td><td>true</td><td></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/algolia-prebuilt-connector.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.