Search knowledge base entries

GET

/api/workspaces/{workspaceId}/kb-entries/search

• Production

Performs a full-text search across knowledge base entries in a workspace. Searches against question text, answer text, and topics. Returns matching entries with pagination metadata and a list of all unique topics for filter UI construction. An empty query returns no results.

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

string format: uuid

The workspace to search within.

Query Parameters

q

string

Search query to match against KB entry content. Leave empty to get no results (not a wildcard).

Example

delivery times

Responses

200

The matching entries, the best match first. A blank query answers an empty list.

Array<object>

A single search result from the knowledge base.

object

id

The entry’s id.

string format: uuid

Example

aabbccdd-eeff-4788-9233-445566778899

question

required

The question this entry addresses.

string

Example

What are your delivery times to Germany?

answer

required

The answer for this entry.

string

Example

Standard delivery to Germany takes 3-5 business days.

topics

required

Tags categorizing this entry.

Array<string>

Example

[
  "shipping",
  "delivery"
]

rrf_score

How well the entry matches the query, the higher the better: the two rankings the search combines, by text and by meaning, fused.

number

Example

0.0327