public

GET /v1/public/kb

Browse or search the knowledge base.

Tutti gli endpoint public

Autenticazione

Questo endpoint è pubblico. Non richiede credenziali né alcuna organizzazione: è ciò che leggono il nostro sito di marketing e i nostri motori di risposta basati su IA.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Parametri

NomeTipoObbligatorioChe cos'è
cursor (query)stringNoOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNoMaximum items to return (page size).
locale (query)stringNoThe 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)stringNoOnly articles in this category slug.
q (query)stringNoFree text, minimum two characters.

Risposta

NomeTipoObbligatorioChe cos'è
dataKbArticle[]
pagePageMeta

Errori che questo endpoint può restituire

422 · 429