Docs API Reference Knowledge Base/bff/kb/entry-from-chat

/bff/kb/entry-from-chat

Enqueues a chat-qa job with mode=agent-derived — the handler creates the entry with status=active (i.e. immediately retrievable) because the operator already vouched for the substance by clicking confirm.

Knowledge BasepostBffKbEntry-from-chat

Parameters

5 body

5 total

Body · 5

questionstringRequired

Length: 0–4000

answerstringRequired

Length: 1–20000

tagsstring[]

localestringRequired

Communication locale code — controls the language of textual data (product names, descriptions, articles, storefront UI, transactional e-mails).

Preferred format: BCP 47 language tag — language[-Script][-REGION]. Use the full tag whenever the script or region matters:

en-GB vs. en-US (British vs. American spelling)
pt-PT vs. pt-BR (European vs. Brazilian Portuguese)
zh-Hans vs. zh-Hant (Simplified vs. Traditional Chinese)
sr-Latn vs. sr-Cyrl (Latin vs. Cyrillic Serbian)

Backwards-compatible fallback: the bare two-letter ISO 639-1 code (cs, en, pl, …) is accepted indefinitely — legacy clients that only send the language subtag continue to work unchanged.

Resolution algorithm (server-side): the input is resolved against the supported locale list via the [RFC 4647 Lookup] progressive-fallback strategy — trailing subtags are stripped one by one until a supported locale is found. Example: en-GB-oxendict → en-GB → en (matched). If no subtag combination is supported, the request is rejected.

Currently supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da, hu, ro, nl, pt, fi, nb, hr. Region-specific variants (e.g. en-GB, pt-BR) are accepted and resolved to their base language when the exact variant is not registered separately.

Length: 2–35

dedupeKeystring

Optional idempotency key — the assistant chat-message external id is a good default.

Length: 0–120

Request

POST /bff/kb/entry-from-chat

post

curl -X POST "https://api.bizkithub.com/bff/kb/entry-from-chat" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "question": "example_question",
  "answer": "example_answer",
  "tags": [
    "string"
  ],
  "locale": "cs",
  "dedupeKey": "example_dedupeKey"
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key