Skip to main content

Update Hidden Keywords

Use the AddSearch API to update the hidden keywords for a specific document in your search index.

API Endpoint

POST /v1/indices/{index public key}/documents/{doc id}/content/hiddenKeywords
  • Replace {index public key} with your index's public key.
  • Replace {doc id} with the identifier of the document to update.

Request Payload

Send a JSON object with the hidden keywords to associate with the document.

{
"hiddenKeywords": "keyword1 keyword2 keyword3"
}

Fields

FieldDescriptionTypeNotes
hiddenKeywordsList of keywords hidden from user-facing search but still matched by the indexstringKeywords should be separated by spaces or commas (verify delimiter usage)

Response

  • Returns HTTP 200 OK on successful update.

Authentication

This endpoint requires authentication. See the Authentication documentation for details on how to authenticate your API requests.


Ensure you have the correct permissions and the document exists before updating hidden keywords. The hidden keywords help improve search results by matching terms not explicitly visible in the document content.