Skip to main content
POST
/
api
/
knowledge
/
search
/
similar
Similar Search
curl --request POST \
  --url https://{tenant}.app.big-panda.ai/api/knowledge/search/similar \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "anchor_product_ids": [
    "<string>"
  ],
  "limit": 8,
  "vector_field": "<string>",
  "site_id": "<string>",
  "language": "<string>",
  "exclude_product_ids": [
    "<string>"
  ]
}
'
{
  "anchor_product_ids": [
    "<string>"
  ],
  "vector_field": "<string>",
  "products": [
    {
      "id": "<string>",
      "external_id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "short_description": "<string>",
      "sku": "<string>",
      "gtin": "<string>",
      "brand": "<string>",
      "category": "<string>",
      "price_current": "<string>",
      "price_msrp": "<string>",
      "price_special": "<string>",
      "price_on_request": true,
      "currency": "<string>",
      "image_url": "<string>",
      "product_url": "<string>",
      "availability": "<string>",
      "rating_average": "<string>",
      "rating_count": 123,
      "language": "<string>",
      "score": 123,
      "score_sources": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.big-panda.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API-Token aus dem Big-Panda-Admin-UI unter Einstellungen → API-Keys. Header: Authorization: Bearer <token>.

Headers

X-Scopes
string
default:""

Space-separated scope set from the token (ADR-015)

Body

application/json

Find products similar to a set of anchor products.

User-triggered Find-Similar action (Theme 4) — caller passes anchor product IDs, gets back products closest to the centroid of their vectors in the configured anchor-vector space.

anchor_product_ids
string[]
required
Required array length: 1 - 10 elements
limit
integer
default:8
Required range: 1 <= x <= 50
vector_field
string | null

description / properties / attributes / hybrid; default from tenant settings

site_id
string | null
language
string | null
exclude_product_ids
string[]

IDs to exclude from the result (e.g. already shown)

Response

Successful Response

Result of a centroid-based similar search.

anchor_product_ids
string[]
required
vector_field
string
required
products
ProductSearchHit · object[]