Skip to main content
POST
Preview knowledge retrieval for a query

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.

Path Parameters

id
string<uuid>
required

Body

application/json
query
string
required
Required string length: 1 - 2000
folder_id
string<uuid> | null
language
string | null
Required string length: 2 - 16
qr_code_id
string<uuid> | null
product_id
string<uuid> | null
object_id
string<uuid> | null

Response

Retrieval trace

query
string
required
folder_id
string<uuid> | null
required
language
string | null
required
qr_code_id
string<uuid> | null
required
product_id
string<uuid> | null
required
object_id
string<uuid> | null
required
scan_applied
boolean | null
required
reranked
boolean
required
rerank_provider
string | null
required
mmr_lambda
number
required
counts
object
required
selected
object[]
required
dropped
object[]
required
served_context
string
required
tool_result
string | null
required
scan_item_note
string | null
required