身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 links.edit 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
您的组织 ID 应填在此处
此端点接受 org_id 作为 JSON 正文中的一个字段。
您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X PATCH https://api.zinndigital.com/v1/ai/recipes/{recipeId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Partial update. The schedule is recomputed on every write rather than by a nightly job — a recipe saved with a cadence and no next run is a recipe that never runs and shows no error anywhere. Requires `links.edit`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
recipeId (path) | Uuid | 是 | — |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
name | string | 是 | — |
is_enabled | boolean | 否 | — |
brief | string | 否 | — |
tone | string | 否 | — |
word_count | integer | 否 | — |
language | string | 否 | — |
posts_per_run | integer | 否 | — |
provider | string | 否 | — |
model_id | string | 否 | — |
model_family | string | 否 | — |
anchors | AiAnchor[] | 否 | — |
anchor_policy | string<none, every_post, rotate> | 否 | — |
link_set_id | string | 否 | The reusable link set this recipe draws its links from, or `null` to use the recipe's own `anchors`. When set it **replaces** `anchors` rather than adding to them — two sources… |
cadence | string<manual, daily, weekly, monthly> | 否 | — |
cadence_hour_utc | integer | 否 | — |
cadence_dow | integer | 否 | — |
cadence_dom | integer | 否 | — |
target_kind | string<none, sites, site_group, cms_targets> | 否 | — |
target_sites | string[] | 否 | — |
target_site_group_id | object | 否 | — |
target_cms_target_ids | string[] | 否 | — |
target_category | string | 否 | — |
requires_capabilities | string[] | 否 | — |
capability_policy | string<refuse, degrade, ask> | 否 | — |
image_provider | string | 否 | — |
image_model | string | 否 | — |
featured_image | boolean | 否 | — |
inline_image_count | integer | 否 | — |
inline_placement | string<after_intro, between_sections, end> | 否 | — |
image_style | string | 否 | — |
publish_mode | string<draft, schedule, publish> | 否 | — |
schedule_offset_hours | integer | 否 | — |
schedule_stagger_minutes | integer | 否 | — |
org_id | Uuid | 否 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | 是 | — |
is_enabled | boolean | 是 | — |
brief | string | 否 | — |
tone | string | 否 | — |
word_count | integer | 否 | — |
language | string | 否 | BCP-47, or empty for "the language the brief is written in". |
posts_per_run | integer | 否 | ⛔ Capped at 10. Two hundred articles from one brief are two hundred near-identical articles, which is a **footprint** — the exact thing the Footprint-Free line is sold to avoid. |
provider | string | 否 | Blank = whatever the funding route resolves to. |
model_id | string | 否 | Blank = the newest verified model in the family. |
model_family | string | 否 | — |
anchors | AiAnchor[] | 否 | — |
anchor_policy | string<none, every_post, rotate> | 否 | — |
link_set_id | string | 否 | The reusable link set this recipe draws its links from, or `null` to use the recipe's own `anchors`. When set it **replaces** `anchors` rather than adding to them — two sources… |
cadence | string<manual, daily, weekly, monthly> | 是 | — |
cadence_hour_utc | integer | 否 | — |
cadence_dow | integer | 否 | 0 = Monday. |
cadence_dom | integer | 否 | ⛔ Never 29-31: a monthly recipe set to the 31st would skip February silently, and a schedule that stops without an error is the failure this feature prevents. |
next_run_at | object | 否 | — |
last_run_at | object | 否 | — |
target_kind | string<none, sites, site_group, cms_targets> | 否 | — |
target_sites | string[] | 否 | — |
target_site_group_id | object | 否 | — |
target_cms_target_ids | string[] | 否 | — |
target_category | string | 否 | — |
requires_capabilities | string[] | 否 | Capability ids the target must support, e.g. `cms_target:featured_image`. Enforced on every run: each site's capabilities are read from its CMS target and any shortfall is handl… |
capability_policy | string<refuse, degrade, ask> | 否 | What to do when a target cannot do something the recipe requires. Default `refuse` — silently dropping a requested field is the failure this exists to stop. `refuse` skips that… |
image_provider | string | 否 | — |
image_model | string | 否 | — |
featured_image | boolean | 否 | — |
inline_image_count | integer | 否 | — |
inline_placement | string<after_intro, between_sections, end> | 否 | — |
image_style | string | 否 | — |
publish_mode | string<draft, schedule, publish> | 是 | ⚖️ Owner ruling 2026-08-20: a **per-recipe** switch defaulting to `draft`. `draft` writes into the library and schedules nothing; `schedule` queues placements the customer can s… |
schedule_offset_hours | integer | 否 | — |
schedule_stagger_minutes | integer | 否 | Minutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint. |
blocking_providers | string[] | 否 | Providers this recipe needs a working key for and does not have. Empty means it can run now. ⚖️ A recipe naming no provider is never blocked — credits are the default route and… |
created_at | string | 是 | — |
updated_at | string | 否 | — |
此端点可能返回的错误
401 · 403 · 404 · 422 · 429