/api/v1/workspaces/{workspaceId}/knowledge/relevant-pages

Scope knowledge:read

Find published knowledge pages relevant to a question or ticket text. Searches the internal wiki and public help, and returns excerpts with their scope.

Pfad

workspaceIdPflicht

string

Workspace that owns the resource.

Request

application/json · KnowledgeRelevantSearchRequestDto

query

string

Query.

locale

string

Language code.

limit

integer (int32)

Limit.

Antworten

200KnowledgeRelevantHitDto[]The request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

Knowledge relevant hit.

pageId

string (uuid)

Identifier of the page.

title

string

Title.

slug

string

Stable slug used in paths and API calls.

scope

KnowledgePageScope

siteId

string (uuid)

Identifier of the site.

locale

string

Language code.

heading

string

Heading.

excerpt

string

Excerpt.

score

number (double)

Score.

400ApiProblemThe request is invalid.

401ApiProblemThe private app token is missing or invalid.

403ApiProblemThe token is missing the required scope, or this action is not allowed.

404ApiProblemThe workspace or resource was not found.

defaultApiProblemError response.