profound-logoProfound CMS
⌘K
Admin
Theme
BelgelerTutorialBlogPhilosophy
BelgelerTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyŞablon oluşturucuda komut dosyası yazmaProject ScaffoldingMedia Library

Headless

Hızlı BaşlangıçSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetCEL önbelleği ile blokları getirgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getVeri kümesi şema adını algetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postGönderi çevirisipatchÇeviri yamalarıgetKullanımı alpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Veri kümesi şema adını al

Yayınlanmış belgeleri bir şema için — tamamını, birini, bir toplu kümeyi veya bir sayfayı — akış halinde bir JSON dizisi olarak getirir.

Yayınlanmış belgeleri bir şema için — tamamını, tek bir belgeyi, kimliklere göre bir toplu kümeyi veya bir sayfayı — JSON dizisi olarak akış halinde getirir. /schemas/{schema_name} adresinde de kullanılabilir. Görsel referansları URL'lere dönüştürülür ve language ayarlandığında ilgili çeviri temel içeriğin üzerine birleştirilir.

Kimlik Doğrulama: API anahtarı. Sunucu require_schema_api_key = true olarak ayarladığında anahtar gereklidir; aksi halde anonim okumaya izin verilir.

Yol parametreleri

ParametreTürGerekliNotlar
schema_namestringevetBelge şeması, örn. post.

Sorgu parametreleri

ParametreTürGerekliNotlar
websiteIduuidhayırHedef web sitesi; varsayılan olarak Host üst bilgisi / yapılandırması kullanılır.
iduuidhayırTek bir belge getirir. ids üzerinde önceliklidir.
idsstringhayırVirgülle ayrılmış UUID'ler (toplu, en fazla 200). Sayfalamaya göre önceliklidir.
languagestringhayırBu yerel ayara ait çeviriyi temel içeriğin üzerine birleştirir.
limitintegerhayırSayfa boyutu, varsayılan 200, üst sınır 200.
offsetintegerhayırAtlanacak satır sayısı (yalnızca pozitif bir limit ile uygulanır).
api_keystringhayırx-api-key üst bilgisine alternatif.

Ne id ne de ids ayarlandığında, belgeler published_at DESC sırasına göre döndürülür.

Yanıt

Akış halinde bir JSON dizisi. Her öğe, belgenin yayımlanmış içeriğinin üst düzeyde açılmış halidir ve _id, _title ve _publishedAt anahtarları eklenmiştir:

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

İçerik alanları çakışma durumunda eklenen anahtarların önüne geçer. { alt, _asset: { id } } biçimindeki görsel referanslarına _asset içine çözümlenmiş bir url eklenir.

Örnek

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

Hatalar

  • 400 — geçersiz websiteId, geçersiz id veya hatalı ids (boş, 200'den fazla veya geçersiz bir UUID)
  • 401 — geçersiz API anahtarı (veya gerekli olduğunda eksik)
  • 500 — sorgu hatası
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›