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

Paginated search results with available topic filters.

Paginated search results from the knowledge base, including available topic filters.

object

entries

required

The matching KB entries on the current page.

Array<object>

A single search result from the knowledge base.

object

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"
]

total

required

Total number of entries matching the search query.

integer

Example

12

page

required

Current page number (1-based).

integer

Example

1

limit

required

Number of results per page.

integer

Example

20

topics

required

All unique topics present in the matching entries. Useful for building filter UIs.

Array<string>

Example

[
  "shipping",
  "delivery",
  "returns",
  "pricing"
]