Getting Started with the Indexing API

This tutorial will guide you through the first steps of using the Indexing API. Here you will learn how to add a document in the …

API API Reference Indexing

Report user event

POST /v1/stats/{index public key} Reports search and click events. Payload for a click event Payload for a search event Search event parameters Click event parameters …

API Reference

Choosing the Search Index

When you have signed up for AddSearch, you have an account. The account links to a sample index you can use for checking out how …

API Dashboard Indexing

Get Search Results

Please note that this page has noindex, nofollow GET /v1/search/{index public key} Retrieve search results from the index. Required Query Parameter Optional Query Parameters Example …

API Reference

Search UI Library Components

AddSearch Search UI Library consists of components you can use to create a search UI for your website. All components are visual with dedicated functionalities …

Search UI Library

Delete Batch of Documents

DELETE /v2/indices/{index public key}/documents:batch Remove multiple documents from the index. Payload The payload includes a list of document ids in an array. Response On successful …

API Reference

Delete Document

DELETE /v2/indices/{index public key}/documents/{document id} Remove a document from the index. Response On successful queuing of the delete operation, the endpoint returns an HTTP 202.

API Reference

Batch Update Documents

PUT /v2/indices/{index public key}/documents:batch Update a batch of documents or create new documents with predefined ids. Payload The request body should be a JSON object, …

API Reference

Update Existing Document

PUT /v2/indices/{index public key}/documents/{document id} Update existing document, or create a new document with predefined URL or ID. PUT /v2/indices/{index public key}/documents/ Omit the document …

API Reference