Searq provides several endpoints that developers can use to interact with the API:
Search Endpoint
The search endpoint is one of the most important endpoints in Searq. It allows developers to search the index for specific items using a search query. To use the search endpoint, developers can send a GET request to the items endpoint with a search query parameter.
Feeds Endpoint
The feeds endpoint allows developers to add, delete, and update RSS feeds. To add a feed, developers can simply send a POST request to the feeds endpoint with the URL of the RSS feed. Searq will then fetch the feed and add it to the search index.
Tasks Endpoint
The tasks endpoint allows developers to view the status of tasks that are running in the background. For example, when a new feed is added, Searq will fetch the feed and update the search index in the background. Developers can use the tasks endpoint to monitor the status of this process.
Items Endpoint
The items endpoint allows developers to search the index for specific items. Developers can send a GET request to the items endpoint with a search query, and Searq will return a list of items that match the query.
Benefits of using Searq
There are several benefits to using Searq:
Easy to use: Searq provides a simple and intuitive API that developers can use to build their own search engines. Flexible: Searq allows developers to use RSS feeds as the data source, providing flexibility in the types of content that can be searched. Fast: By using MeiliSearch as the search engine, Searq provides lightning-fast search capabilities. Scalable: Searq is built on Ruby on Rails, a framework that provides a robust foundation for building scalable web applications.