Documentation • Rails • Community Forum • Stack Overflow • Report a bug • FAQ • Support
## ✨ Features Thin & minimal low-level HTTP client to interact with Algolia's API ## 💡 Getting Started First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager: ```bash gem install algolia ``` Then, create objects on your index: ```ruby client = Algolia::SearchClient.create('YourApplicationID', 'YourAPIKey') client.save_object('your_index_name', {objectID: 1, name: 'Foo'}) ``` Finally, you may begin searching a object using the `search` method: ```ruby objects = client.search_single_index('your_index_name', 'Foo') ``` For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**. ## ❓ Troubleshooting Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md) ## Contributing This repository hosts the code of the generated Algolia API client for Ruby, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction). ## 📄 License The Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE).