v0.1-beta

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.

curl -G -H "Authorization: Token {TOKEN}" https://searq.org/api/search.json -d "q=ruby"

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.