GET
/
v2
/
search
/
suggestions
Authorization
Query
curl --request GET \
  --url https://api.depict.ai/v2/search/suggestions
{
  "suggestions_request_id": "c6fa5efd-1bde-43a8-9ac4-434605f53024",
  "suggestions": [
    {
      "type": "query",
      "title": "red hat",
      "suggestions_result_id": "60c54958-8f2d-4ffd-a343-d316e79593b8"
    },
    {
      "category_id": "sweaters-hoodies",
      "title": "Sweaters & Hoodies",
      "page_url": "https://foobar.com/sweaters-hoodies",
      "type": "category",
      "suggestions_result_id": "b11ee4a9-0d95-4559-b1fa-76479ca3e3ea"
    }
  ]
}

The suggestions are of two types:

  • suggestions for search queries that are related to the current query
  • suggestions for categories that are related to the current query

Authorizations

api_key
string
queryrequired

Query Parameters

tenant
string
required
market
string
required
query
string
user_id
string
session_id
string
dsid
string
metadata
any

Response

200 - application/json
suggestions
object[]
required

List of suggestions for search queries that should be shown to the user while they are typing.

  • QuerySuggestion

  • CategorySuggestion

suggestions_request_id
string
required

Was this page helpful?

Get ResultsGet Related Recommendations