public

GET /v1/public/kb

Browse or search the knowledge base.

すべての public エンドポイント

認証

このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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