Skip to main content
POST
/
api
/
knowledge
/
search
Unified Search
curl --request POST \
  --url https://{tenant}.app.big-panda.ai/api/knowledge/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "sources": [
    "knowledge",
    "products"
  ],
  "limit": 10,
  "min_similarity": 0.5,
  "language": "<string>",
  "site_id": "<string>",
  "knowledge": {
    "type_filter": [
      "<string>"
    ],
    "tags_filter": [
      "<string>"
    ]
  }
}
'
{
  "query": "<string>",
  "sources_searched": [
    "<string>"
  ],
  "search_log_id": "<string>",
  "treffer": [
    {
      "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": {}
    }
  ],
  "ergebnisse": [
    {
      "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": {}
    }
  ],
  "aehnliche": [
    {
      "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": {}
    }
  ],
  "vielleicht": [
    {
      "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": {}
    }
  ],
  "layer_results": {},
  "latency_breakdown": {},
  "latency_ms": 0,
  "exact_matches": [
    {
      "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": {}
    }
  ],
  "knowledge": [
    {
      "id": "<string>",
      "title": "<string>",
      "content": "<string>",
      "summary": "<string>",
      "category_id": "<string>",
      "language": "<string>",
      "visibility": "<string>",
      "tags": [
        "<string>"
      ],
      "similarity": 123,
      "score": 123,
      "score_sources": {},
      "section": "<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

Unified search across knowledge entries and/or products.

The sources parameter controls which data pools are searched. Per-source tuning lives in knowledge (and later products) sub-objects so consumer-types can scope each pool separately.

​
query
string
required
Required string length: 1 - 2000
​
sources
string[]

Which sources to search: 'knowledge', 'products', or both

​
limit
integer
default:10
Required range: 1 <= x <= 100
​
min_similarity
number | null
Required range: 0 <= x <= 1
​
language
string | null

Filter by language

​
site_id
string | null

Filter products by site (UUID or slug)

​
knowledge
KnowledgeSearchOptions · object

Optional per-source configuration for knowledge entries.

Sprint 7.3 — caller can scope the knowledge results without changing the rest of the search request. Empty/None means "no constraint on this axis".

Response

Successful Response

Combined search results.

Two views on the same data:

  • Sectioned view (Block C strategy): treffer/ergebnisse/ aehnliche/vielleicht — what the new widget renders.
  • Legacy flat view: exact_matches + products + knowledge — kept filled for backward-compat with the RAG-Engine and the pre-refactor widget. Removed once all consumers migrated.

Plus search_log_id — the row-id of the persisted SearchLog, so the widget can later POST click events tied to this search.

​
query
string
required
​
sources_searched
string[]
required
​
search_log_id
string | null
​
treffer
ProductSearchHit · object[]
​
ergebnisse
ProductSearchHit · object[]
​
aehnliche
ProductSearchHit · object[]
​
vielleicht
ProductSearchHit · object[]
​
layer_results
Layer Results · object
​
latency_breakdown
Latency Breakdown · object
​
latency_ms
integer
default:0
​
exact_matches
ProductSearchHit · object[]
​
knowledge
KnowledgeSearchHit · object[]
​
products
ProductSearchHit · object[]