Skip to content
Wink

Query property embeddings

POST
/api/property-embeddings/external/query
 
curl --request POST \
  --url https://api.wink.travel/api/property-embeddings/external/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Runs a semantic vector-store similarity search against property embeddings for a resolved property. Returns only PUBLIC-sensitivity facts as Map<String, Object> with ‘text’ and ‘metadata’ keys. Optionally filters by fact type.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Request Body required

Section titled “Request Body required ”
Media type application/json

Query property embeddings using an external identifier

object
namespace
required

Identifier namespace (HOTEL_CODE, URL_NAME, PLACE_ID, or PARTNER)

string
""
Allowed values: HOTEL_CODE URL_NAME PLACE_ID PARTNER
Example 
PARTNER
externalId
required

External identifier value

string
"" >= 1 characters
Example 
BOOKING-987654
query
required

Natural language query

string
"" >= 1 characters
Example 
What amenities and wellness facilities does this hotel offer?
topK

Number of results to return

integer format: int32
default: 5 >= 1 <= 20
Example 
5
factTypes

Optional fact type filter (e.g. AMENITY, EXPERIENCE, INVENTORY)

Array<string>
""
Allowed values: HOTEL_DESCRIPTION AMENITY EXPERIENCE INVENTORY POLICY LOCATION GUEST_REVIEW RATE_SUMMARY SOCIAL_POST_GENERATED STAFF_NOTE COMPETITOR_INSIGHT PARTNER_KNOWLEDGE PARTNER_LOCAL_INSIGHT

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Search results retrieved successfully

Media type application/json
Array<object>
object
key
additional properties
Example generated
[
  {
    "additionalProperty": "example"
  }
]

400

Section titled “400 ”

Invalid request (invalid topK range, namespace, or identifier)

401

Section titled “401 ”

Missing or invalid JWT authentication

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

404

Section titled “404 ”

Property not found for the given namespace and externalId

Media type application/json
Array<object>
object
key
additional properties
Example generated
[
  {
    "additionalProperty": "example"
  }
]

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}