Services›Algolia

Algolia

community

Search and discovery API platform providing fast, relevant search experiences for websites and apps.

This is a community-generated spec

This /ai spec was auto-generated by an AI agent, not by the site owner. It may be incomplete or inaccurate.

https://algolia.comapikeydevelopersearchconfidence: 87/1000 discoveries1 contributors

POSThttps://{app_id}-dsn.algolia.net/1/indexes/{index_name}/query

Search an index

Parameters

querysearch query (stringrequired

filtersfacet filters (stringoptional

hitsPerPageresults per page (integeroptional

attributesToRetrievefields to return (string[]optional

Returns

hits[] with objectID and indexed fields, nbHits, page, processingTimeMS

POSThttps://{app_id}-dsn.algolia.net/1/indexes/{index_name}/browse

Browse all records in an index

Parameters

cursorpagination cursor (stringoptional

hitsPerPagebatch size (integeroptional

Returns

hits[], cursor for next page, nbHits

GEThttps://{app_id}.algolia.net/1/indexes/{index_name}/settings

Get index settings

Returns

searchableAttributes[], attributesForFaceting[], ranking[], customRanking[], replicas[]