profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypy komponentówSetup server sent events (SSE) content refetchInstall Profound CMS as a proxySkrypty w kreatorze szablonówProject ScaffoldingBiblioteka multimediów

Headless

Szybki startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Przegląd REST APIgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postTłumaczenie postapatchKorekty tłumaczeńgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /dataset/{schema_name}

Pobierz opublikowane dokumenty dla schematu — wszystkie, pojedynczy, partię lub stronę — jako strumieniowaną tablicę JSON.

Pobierz opublikowane dokumenty dla schematu — wszystkie, pojedynczy dokument, partię według identyfikatorów lub stronę — strumieniowane jako tablica JSON. Również dostępne pod adresem /schemas/{schema_name}. Odwołania do obrazów są rozwiązywane do adresów URL, a gdy ustawiono language, pasujące tłumaczenie jest scalane z treścią bazową.

Uwierzytelnianie: Klucz API. Klucz jest wymagany tylko wtedy, gdy serwer ustawi require_schema_api_key = true; w przeciwnym razie dozwolony jest anonimowy odczyt.

Parametry ścieżki

ParametrTypWymaganeUwagi
schema_namestringtakSchemat dokumentu, np. post.

Parametry zapytania

ParametrTypWymaganeUwagi
websiteIduuidnieDocelowa witryna; w razie braku używa nagłówka Host / konfiguracji.
iduuidniePobierz pojedynczy dokument. Ma pierwszeństwo przed ids.
idsstringnieUUID rozdzielone przecinkami (partia, maksymalnie 200). Ma pierwszeństwo przed paginacją.
languagestringnieScal tłumaczenie dla tego ustawienia regionalnego z treścią bazową.
limitintegernieRozmiar strony, domyślnie 200, ograniczony do 200.
offsetintegernieLiczba pomijanych wierszy (stosowane tylko przy dodatnim limicie).
api_keystringnieAlternatywa dla nagłówka x-api-key.

Gdy nie ustawiono id ani ids, dokumenty są zwracane w kolejności published_at DESC.

Odpowiedź

Strumieniowana tablica JSON. Każdy element to opublikowana treść dokumentu spłaszczona na najwyższym poziomie oraz wstrzyknięte klucze _id, _title i _publishedAt:

[
  {
    "_id": "...",
    "_title": "Pierwsze kroki",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Pierwsze kroki",
    "description": "...",
    "content": "..."
  }
]

Pola treści mają pierwszeństwo przed wstrzykniętymi kluczami w przypadku kolizji. Odwołania do obrazów w formie { alt, _asset: { id } } otrzymują rozwiązany url wstrzyknięty do _asset.

Przykład

curl '{CMS_API_URL}/dataset/post?websiteId=<uuid>&limit=50' \
  -H 'x-api-key: <key>'

Błędy

  • 400 — nieprawidłowy websiteId, nieprawidłowy id lub błędne ids (puste, więcej niż 200 albo nieprawidłowy UUID)
  • 401 — nieprawidłowy klucz API (lub brak, gdy jest wymagany)
  • 500 — błąd zapytania
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›