profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxySzkriptelés a sablonkészítőbenProject ScaffoldingMédiatár

Fej nélküli

Quick startJSON és Claude kódComponent Zod Pull

REST API

REST API áttekintésgetConnect your websitegetGET /routesgetÚtvonal feloldásagetBlokkok lekérésegetGET /blocks/with-cel-cachegetGenerált blokkok lekérésegetKomponensek lekérésegetGET /components/{name}getAdatkészlet-séma nevének lekérésegetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postUtólagos fordításpatchFordítások javításagetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Adatkészlet-séma nevének lekérése

Közzétett dokumentumok lekérése egy sémához — mindet, egyet, egy köteget vagy egy oldalt — streamelt JSON tömbként.

Lekéri egy séma közzétett dokumentumait — mindet, egyetlen dokumentumot, azonosítók alapján egy köteget vagy egy oldalt — JSON tömbként streamelve. Elérhető a /schemas/{schema_name} útvonalon is. A képhivatkozások URL-re oldódnak, és amikor a language meg van adva, a megfelelő fordítás ráíródik az alap tartalomra.

Hitelesítés: API-kulcs. Csak akkor szükséges kulcs, ha a szerver a require_schema_api_key = true értéket állítja be; ellenkező esetben névtelen olvasás engedélyezett.

Útvonali paraméterek

ParaméterTípusKötelezőMegjegyzés
schema_namestringigenA dokumentumséma, például post.

Lekérdezési paraméterek

ParaméterTípusKötelezőMegjegyzés
websiteIduuidnemCélwebhely; visszaesik a Host fejléc / konfiguráció értékére.
iduuidnemLekér egyetlen dokumentumot. Felülírja az ids paramétert.
idsstringnemVesszővel elválasztott UUID-k (köteg, legfeljebb 200). Felülírja a lapozást.
languagestringnemAz adott területi beállításhoz tartozó fordítást ráolvasztja az alap tartalomra.
limitintegernemOldalméret, alapértelmezés szerint 200, legfeljebb 200.
offsetintegernemKihagyandó sorok száma (csak pozitív limit esetén alkalmazva).
api_keystringnemAlternatívája az x-api-key fejlécnek.

Ha sem id, sem ids nincs megadva, a dokumentumok published_at DESC sorrendben érkeznek vissza.

Válasz

Egy streamelt JSON tömb. Minden elem a dokumentum közzétett tartalma a legfelső szinten, valamint a beszúrt _id, _title és _publishedAt kulcsok:

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

Ütközés esetén a tartalommezők felülírják a beszúrt kulcsokat. A { alt, _asset: { id } } alakú képhivatkozások _asset alá egy feloldott url-t kapnak.

Példa

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

Hibák

  • 400 — érvénytelen websiteId, érvénytelen id, vagy hibás ids (üres, több mint 200, vagy érvénytelen UUID)
  • 401 — érvénytelen API-kulcs (vagy hiányzik, amikor szükséges)
  • 500 — lekérdezési hiba
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›