Search help

Searches Liquify Guides for query. Optional locale (see Locales); when omitted, uses the user’s preferredLanguage, else en. If that locale returns no hits and is not English, retries en. Unsupported locale values return invalid_argument. Optional limit (default 5, max 10).

GET/v1/search_help

Query

Field	Type	Required	Default	Description
query	string	Yes	—	Natural-language search against Liquify Guides.
locale	string	No	—	Supported locale code. Omit to use the user’s preferred language.
limit	number	No	5	Max guide hits to return (1–10; default 5).

Response `data`

Field	Type	Description
items	array	Guide hits.

Item fields

Field	Type	Description
title	string	Guide title.
url	string	Absolute docs URL.
excerpt	string	Short snippet.

Request

curl --request GET \
  --url 'https://api.getliquify.com/v1/search_help?query=what+is+a+box&locale=en&limit=5' \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "data": {
    "items": [
      {
        "title": "The box method",
        "url": "https://getliquify.com/en/docs/concepts/the-box-method",
        "excerpt": "…"
      }
    ]
  }
}

Query

Response data

Item fields

Related

Response `data`