public

GET /v1/public/kb

Browse or search the knowledge base.

Todos os endpoints de public

Autenticação

Este endpoint é público. Ele não requer credenciais nem organização — é o que nosso próprio site de marketing e os mecanismos de resposta de IA leem.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

**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.

Parâmetros

NomeTipoObrigatórioO que é
cursor (query)stringNãoOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNãoMaximum items to return (page size).
locale (query)stringNãoThe 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)stringNãoOnly articles in this category slug.
q (query)stringNãoFree text, minimum two characters.

Resposta

NomeTipoObrigatórioO que é
dataKbArticle[]Sim
pagePageMetaSim

Erros que este endpoint pode retornar

422 · 429