public

GET /v1/public/kb

Browse or search the knowledge base.

Все эндпоинты public

Аутентификация

Этот эндпоинт является публичным. Он не требует учетных данных и организации — его читают наш собственный маркетинговый сайт и поисковые системы на базе ИИ.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X GET https://api.zinndigital.com/v1/public/kb

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

**Anonymous** — no credential, no tenant. This is what the marketing site server-renders and what an AI answer engine crawls (§2.18), so it must work with no authentication at all. Published articles only, and that filter lives in every queryset rather than in a serializer so a new field or endpoint cannot leak a draft. `locale` names what the reader wants; the payload's `locale` reports what they actually got, field by field, with English as the floor.

Параметры

ИмяТипОбязательноЧто это
cursor (query)stringНетOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerНетMaximum items to return (page size).
locale (query)stringНетThe language to render in. An unknown value falls back to English rather than returning nothing, so a visitor whose browser sends a locale we do not serve reads the English arti…
category (query)stringНетOnly articles in this category slug.
q (query)stringНетFree text, minimum two characters.

Ответ

ИмяТипОбязательноЧто это
dataKbArticle[]Да
pagePageMetaДа

Ошибки, которые может возвращать этот эндпоинт

422 · 429