Discover how to integrate Apidog with Algolia to enhance search functionality for your API documentation.
By default, the published API documentation includes a built-in search feature that lets users search for endpoints or documentation by name or path.Additionally, Apidog offers integration with Algolia to enhance search capabilities. To take advantage of this feature, you'll need to enable it and complete the required configurations.Apidog version v2.6.31 or later is required.
Integrating Algolia with Apidog#
Step 1: Create an Algolia Account#
2.
After registering, log in to your Algolia account.
Step 2: Create an Algolia Application#
1.
Once logged in, create a new application in the Algolia dashboard.
2.
Click onUpload a Fileto upload data.
For starters to set up easier, you can use the provided example code to generate a JSON file. Simply drag and drop the JSON file into Algolia. The JSON file's name will be your Index Name, which you’ll need later in Apidog’s documentation search configuration.
3.
Design your search display.
4.
Proceed by clickingNextuntil you reach the final step.
5.
In the final step, you will be asked how you want to build the search front-end. You can skip this option.
1.
Navigate to the Algolia Settings -> API Keys page and get the configuration details for your application.
Index Namewill be displayed here:2.
Copy and fill these configuration details into Apidog’s documentation search settings.
Step 4: Save and Enable the Feature#
After filling in the required configuration details in Apidog, save the settings to enable the enhanced search functionality.If you hit the free plan’s limits, you will see a notification in Apidog: Ask AI#
The Ask AI feature enables users to experience conversational, AI-powered Q&A directly within your documentation search.Configuration in Algolia#
If you are using Algolia's Ask AI implementation:Navigate to Data Sources -> Ask AI in your Algolia dashboard;
Set up your assistant and grab the Assistant ID;
Continue the configuration in Apidog (next section).
Navigate to Generative AI -> Agents in your Algolia dashboard;
Set up your documentation assistant agent and grab the Agent ID;
Continue the configuration in Apidog (next section).
In the Algolia Ask AI allowed sources or whitelist, add your Apidog documentation URL/domain, as shown in the image below. Configuration in Apidog#
You can enable the Ask AI feature by binding your assistant_id in the Documentation Search settings as shown below.First turn the Ask AI toggle on.
Then insert the Assistant ID you grabbed from the previous section to the Assistant ID box.
If you are using Agent Studio, turn the Agent Studio toggle on and use your Agent ID in the Assistant ID box.
Free Algolia DocSearch Plan#
Algolia offers a free DocSearch plan for specific purposes (like documentation search). You can apply for the free Algolia DocSearch plan here. For the Documentation URL field in the application form, you can enter your public API documentation URL from Apidog.Once the application is successful, Algolia will send you a confirmation email, and you will receive a message in Algolia dashboard inviting you to join the application. Click to confirm to join the application Algolia offers.After confirmation, follow the same process mentioned above to get the configuration details for your application and bind it with your Apidog project.