API Overview

Searchcraft’s API provides RESTful endpoints for updating and managing your search application back-end. Utilizing our pre-built, customizable SDKs or a CMS platform integration is the preferred method for integrating Searchcraft into your application. However, if you wish to use the API directly it is available for custom integrations.

Prerequisites

You will need an authentication token in order to access the API. You may generate and retrieve these from your account dashboard. If you are self-hosting, refer to the CLI documentation for more information.

Security

Your authentication key for ingestion should never be used in a front-end application. All requests related to write/delete operations using the ingestion authentication key should be back-end to back-end requests. When using one of the front-end SDKs you should use your read-only authentication key to make search query requests. See the Authentication section for more information on key endpoints and the Access Keys section for more information the different types. Customers are responsible for managing the control over their access keys, Searchcraft is not liable for data loss or additional usage charges incurred as a result of customer security practices.