profound-logoProfound CMS
⌘K
Admin
Theme
Tài liệuHướng dẫnBlogTriết học
Tài liệuHướng dẫnBlogTriết học

Kết hợp

Định tuyến tham sốCác loại ComponentSetup server sent events (SSE) content refetchThiết lập proxy bảng điều khiển quản trịCEL Scripting in Template BuilderProject ScaffoldingThư viện phương tiện

Không đầu

Bắt đầu nhanhJson và claude codeComponent Zod Pull

REST API

Tổng quan REST APIgetKết nối API trang webgetGET /routesgetLấy tuyếngetGET /blocksgetLấy các khối kèm bộ đệm CELgetGET /blocks/generatedgetGET /componentsgetLấy tên thành phầngetLấy tên lược đồ tập dữ liệugetGET /content-changes (SSE)patchCập nhật tên lược đồ tập dữ liệupostPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Lấy tên lược đồ tập dữ liệu

Truy xuất các tài liệu đã xuất bản cho một lược đồ — tất cả, một, một lô hoặc một trang — dưới dạng mảng JSON được truyền luồng.

Truy xuất các tài liệu đã xuất bản cho một lược đồ — tất cả, một tài liệu đơn lẻ, một lô theo ID, hoặc một trang — được truyền dưới dạng một mảng JSON. Cũng khả dụng tại /schemas/{schema_name}. Tham chiếu hình ảnh được phân giải thành URL, và khi language được thiết lập thì bản dịch tương ứng sẽ được gộp lên nội dung gốc.

Xác thực: Khóa API. Chỉ cần có khóa khi máy chủ đặt require_schema_api_key = true; nếu không thì cho phép đọc ẩn danh.

Tham số đường dẫn

Tham sốKiểuBắt buộcGhi chú
schema_namestringcóLược đồ tài liệu, ví dụ: post.

Tham số truy vấn

Tham sốKiểuBắt buộcGhi chú
websiteIduuidkhôngTrang web đích; quay về tiêu đề Host / cấu hình khi không cung cấp.
iduuidkhôngTruy xuất một tài liệu đơn lẻ. Ưu tiên hơn ids.
idsstringkhôngCác UUID phân tách bằng dấu phẩy (lô, tối đa 200). Ưu tiên hơn phân trang.
languagestringkhôngGộp bản dịch cho ngôn ngữ này lên nội dung gốc.
limitintegerkhôngKích thước trang, mặc định 200, giới hạn tối đa 200.
offsetintegerkhôngSố hàng cần bỏ qua (chỉ áp dụng khi giới hạn lớn hơn 0).
api_keystringkhôngLựa chọn thay thế cho tiêu đề x-api-key.

Khi cả id và ids đều không được thiết lập, các tài liệu sẽ được trả về theo thứ tự published_at DESC.

Phản hồi

Một mảng JSON được truyền luồng. Mỗi phần tử là nội dung đã xuất bản của tài liệu ở cấp cao nhất, cùng với các khóa được chèn _id, _title và _publishedAt:

[
  {
    "_id": "...",
    "_title": "Bắt đầu",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Bắt đầu",
    "description": "...",
    "content": "..."
  }
]

Các trường nội dung sẽ ghi đè lên những khóa được chèn khi trùng lặp. Tham chiếu hình ảnh có dạng { alt, _asset: { id } } sẽ được bổ sung url đã phân giải vào _asset.

Ví dụ

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

Lỗi

  • 400 — websiteId không hợp lệ, id không hợp lệ, hoặc ids sai (trống, nhiều hơn 200, hoặc một UUID không hợp lệ)
  • 401 — khóa API không hợp lệ (hoặc thiếu khi được yêu cầu)
  • 500 — truy vấn thất bại
Continue Reading
Previous‹Lấy tên thành phầnNextGET /content-changes (SSE)›