GET /dataset/{schema_name}

获取某个模式的已发布文档——全部、单个、批量或分页——以流式 JSON 数组返回。

获取某个模式的已发布文档——全部文档、单个文档、按 ID 分批，或按页获取——以 JSON 数组的形式流式返回。也可通过 /schemas/{schema_name} 访问。图像引用会解析为 URL，当设置了 language 时，将匹配的译文合并覆盖基础内容。

身份验证： API 密钥。只有当服务器设置 require_schema_api_key = true 时才需要密钥；否则允许匿名读取。

路径参数

参数	类型	必填	说明
`schema_name`	字符串	是	文档模式，例如 `post`。

查询参数

参数	类型	必填	说明
`websiteId`	uuid	否	目标网站；如果未提供，则回退至 `Host` 头部/配置。
`id`	uuid	否	获取单个文档。优先于 `ids`。
`ids`	字符串	否	以逗号分隔的 UUID（批量，最多 200 个）。优先于分页。
`language`	字符串	否	将该语言环境的译文合并覆盖基础内容。
`limit`	整数	否	页面大小，默认为 `200`，上限为 `200`。
`offset`	整数	否	要跳过的行数（仅在正数 `limit` 时生效）。
`api_key`	字符串	否	`x-api-key` 头部的替代项。

当未设置 id 或 ids 时，文档将按 published_at DESC 顺序返回。

响应

一个流式 JSON 数组。每个元素是文档的已发布内容在顶层展开，并注入 _id、_title 和 _publishedAt 键：

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

当发生冲突时，内容字段优先于注入的键。形如 { alt, _asset: { id } } 的图像引用会在 _asset 中注入解析后的 url。

示例

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

错误

400 — 无效的 websiteId、无效的 id，或不合法的 ids（为空、超过 200 个，或包含无效的 UUID）
401 — 无效的 API 密钥（或在需要时缺失）
500 — 查询失败

Previous‹GET /components/{name}Next获取内容变更 SSE›

参数

类型

必填

说明

schema_name

字符串

是

文档模式，例如 post。

查询参数

参数

类型

必填

说明

websiteId

uuid

否

目标网站；如果未提供，则回退至 Host 头部/配置。

id

uuid

否

获取单个文档。优先于 ids。

ids

字符串

否

以逗号分隔的 UUID（批量，最多 200 个）。优先于分页。

language

字符串

否

将该语言环境的译文合并覆盖基础内容。

limit

整数

否

页面大小，默认为 200，上限为 200。

offset

整数

否

要跳过的行数（仅在正数 limit 时生效）。

api_key

字符串

否

x-api-key 头部的替代项。

当未设置 id 或 ids 时，文档将按 published_at DESC 顺序返回。

响应

一个流式 JSON 数组。每个元素是文档的已发布内容在顶层展开，并注入 _id、_title 和 _publishedAt 键：

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

当发生冲突时，内容字段优先于注入的键。形如 { alt, _asset: { id } } 的图像引用会在 _asset 中注入解析后的 url。