search mobile facets autocomplete spellcheck crawler rankings weights synonyms analytics engage api customize documentation install setup technology content domains user history info home business cart chart contact email activate analyticsalt analytics autocomplete cart contact content crawling custom documentation domains email engage faceted history info install mobile person querybuilder search setup spellcheck synonyms weights engage_search_term engage_related_content engage_next_results engage_personalized_results engage_recent_results success add arrow-down arrow-left arrow-right arrow-up caret-down caret-left caret-right caret-up check close content conversions-small conversions details edit grid help small-info error live magento minus move photo pin plus preview refresh search settings small-home stat subtract text trash unpin wordpress x alert case_deflection advanced-permissions keyword-detection predictive-ai sso

Overview, API References

Connect to an unlimited number of private content sources using the Enterprise Search APIs.

This overview will discuss:

Authentication

Each API call requires an access_token and a content_source_key.

The access_token is your private API key. You'll need it to authenticate each request. Keep it secret!

The content_source_key identifies which content source you'd like to reach with your request.

curl -X POST http://localhost:3002/api/v1/ent/sources/[CONTENT_SOURCE_KEY]/documents/bulk_create \
-H "Authorization: Bearer [ACCESS_TOKEN]" \
-H "Content-Type: application/json" \
-d '
  ...
'

Create a new Custom API Source or view the details of an existing Custom API Source to find these values.

The access_token is shared amongst all connectors. But the content_source_token is unique to each connector.

External IDs (external_id)

Each document within a content source must have a unique external_id.

Two documents in two separate content sources may have the same external_id.

You can update existing documents by issuing a POST request to an existing external_id.

If the external_id does not exist, a new document is created.

It is up to you to maintain the integrity of your external_id for each document within each custom API content source.

We recommend that you avoid SHAs or any id derived from the content of a document.

Modification of original data will alter value, making it difficult to identify the document in the search index. This can lead to record duplication.


Enjoying the beta? Something broken? Lost? Please send us your feedback or visit the Enterprise Search community.