Instant Search Articles
Type-ahead search for a help-center search box. Returns at most 5 published public articles as lightweight hits (title, slug, collection name, and a short snippet) with totalCount reporting how many matched overall so you can offer "see all results". Falls back to fuzzy matching when the phrase is too short or malformed for full-text search, so partial words and typos still return something. Use Search Articles for the full result page.
Authorization
Authorization In: header
Query Parameters
ID of the help center to search within.
The search text. Must not be empty.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://www.saasco.com/api/v2/knowledge/instant-search?helpCenterId=string&phrase=string"{
"results": [
{
"collectionName": "string",
"id": "string",
"slug": "string",
"snippet": "string",
"title": "string"
}
],
"totalCount": 0
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Search Articles
Full search across a help center's published articles, returning complete articles ranked by relevance plus a `totalCount`. Set `highlight` to also receive the matched fragments of each title and summary, ready to render as emphasised text. This endpoint is public, so it always restricts to published articles no matter what `state` is sent.
Add Article Reaction
Records a reader's helpfulness rating on an article, incrementing that article's happy, neutral, or sad counter. Public and unauthenticated, so it can be called straight from a help-center page. There is no deduplication. The same reader can react repeatedly.