Migration note from current API clients

In July 2022, we released an alpha version generated API clients for the JavaScript, Java and PHP languages. If you are using the latest stable of those clients and looking to upgrade, read the migration guide. You can still browse the documentation of the stable clients on the Algolia documentation.

You can read getting started guides and how to use the API clients on our documentation.

Looking to add a new client, or fix a bug? Make sure to take a look at our contribution guides.

nvm use && yarn

Make sure to have Docker installed so you don't have to install the tooling for every API clients.

yarn docker:setup

Read more on our documentation

The CLI allows you to make changes locally and run commands through the docker container.

• Specs CLI commands
• Clients CLI commands
• CTS CLI commands

Read the guides and requirements to:

• Add a new client
• Add a new language

Test the generated clients by running:

• The playground (see documentation)
• The Common Test Suite (see documentation).

For full documentation, visit the online documentation.

Encountering an issue with the API clients? Before reaching out to support, we recommend heading to our FAQ where you will find answers to the most common issues and gotchas with the client.

You can also open an issue on GitHub.

Algolia API clients automation is an open-sourced software licensed under the MIT license.