POST `/v1/ai/site-builds/{siteBuildId}/preview`

What publishing this draft would do to that site. Changes nothing.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 hosting.deploy.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/ai/site-builds/{siteBuildId}/preview \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "site_id": <Uuid>, "disposition": <SiteMakerDisposition> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

Answers "what happens if the site is already there" before anything happens: which existing files are kept, which are added, which would be **overwritten**, and which generated files would be renamed to avoid a collision. This runs the same guard the publication itself runs, not a second description of it. A preview computed by different code is a promise the real path never made, and it would be wrong in exactly the cases that matter. The preview does **not** require the typed confirmation that a `replace` needs. A customer has to be able to see what would be destroyed before deciding to confirm it; demanding the confirmation in order to show the consequence is the wrong way round. Requires `hosting.deploy.manage`.

参数

名称	类型	必填	内容简介
`siteBuildId (path)`	`Uuid`	是	—

请求正文

名称	类型	必填	内容简介
`site_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`disposition`	`SiteMakerDisposition`	是	What to do with what is already on the destination. `add_to` keeps every existing byte, `revamp` replaces presentation and keeps content, `replace` is destructive and requires a…

响应

名称	类型	必填	内容简介
`preview`	`SiteMakerPreview`	是	—

此端点可能返回的错误

401 · 403 · 404 · 422 · 429

POST /v1/ai/site-builds/{siteBuildId}/preview