BizKitHub
DocsAPI ReferenceSupport/api/v1/support/docs-suggest
getSupportPublic API v1

/api/v1/support/docs-suggest

Autocomplete for help-desk ticket forms: returns the public documentation pages (docs.bizkithub.com) most relevant to a free-text subject. Searches article titles, section headings, perex, meta description, body, public tags and category names/descriptions across every docs locale. Each item is an article, a section (deep link to a heading anchor) or a category, with an absolute url in the locale the hit was found in. Only public, non-deleted content is searched. Any valid API key may call it; the docs corpus is shared.

supportgetApiV1SupportDocs-suggest

Parameters

4 query

Query parameters

· 4
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
querystringRequired

The ticket subject as typed so far. Free text; noise words are dropped and Czech inflection is tolerated.

Length: 0–200
ExampleNedaří se mi odeslat fakturu e-mailem
localestringOptional

Preferred locale (default cs). Hits in this locale rank slightly higher; hits in other locales are still returned.

Examplecs
limitstring | integerOptional

Maximum number of suggestions (default 5).

Range: 1–10
Example5

Response schema

1 status code documented

200Success
querystringRequired

Normalized query.

termsstring[]Required

Search terms (stems) actually used.

itemsobject[]Required
Each array item:
type"article" | "section" | "category"Required
titlestringRequired
ExampleFaktury
contextstring | nullRequired

Article title for a section; category (or parent category) name otherwise.

One of 2:
Variant 1
string
Variant 2
null
snippetstringRequired

One-line plain-text preview around the first hit.

localestringRequired
Examplecs
urlstringRequired
Examplehttps://docs.bizkithub.com/cs/faktury
scorenumberRequired

Response example

application/json
{
  "query": "example_query",
  "terms": [
    "string"
  ],
  "items": [
    {
      "title": "Faktury",
      "snippet": "example_snippet",
      "locale": "cs",
      "url": "https://docs.bizkithub.com/cs/faktury",
      "score": 0
    }
  ]
}

Request example

GET /api/v1/support/docs-suggest

get
curl -X GET "https://api.bizkithub.com/api/v1/support/docs-suggest?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&query=Neda%C5%99%C3%AD%20se%20mi%20odeslat%20fakturu%20e-mailem&locale=cs&limit=5" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key