Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione links.edit; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
L'ID della tua organizzazione va qui
Questo endpoint accetta org_id come campo nel corpo JSON.
L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X PATCH https://api.zinndigital.com/v1/ai/recipes/{recipeId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
recipeId (path) | Uuid | Sì | — |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
name | string | Sì | — |
is_enabled | boolean | No | — |
brief | string | No | — |
tone | string | No | — |
word_count | integer | No | — |
language | string | No | — |
posts_per_run | integer | No | — |
provider | string | No | — |
model_id | string | No | — |
model_family | string | No | — |
anchors | AiAnchor[] | No | — |
anchor_policy | string<none, every_post, rotate> | No | — |
link_set_id | string | No | 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> | No | — |
cadence_hour_utc | integer | No | — |
cadence_dow | integer | No | — |
cadence_dom | integer | No | — |
target_kind | string<none, sites, site_group, cms_targets> | No | — |
target_sites | string[] | No | — |
target_site_group_id | object | No | — |
target_cms_target_ids | string[] | No | — |
target_category | string | No | — |
requires_capabilities | string[] | No | — |
capability_policy | string<refuse, degrade, ask> | No | — |
image_provider | string | No | — |
image_model | string | No | — |
featured_image | boolean | No | — |
inline_image_count | integer | No | — |
inline_placement | string<after_intro, between_sections, end> | No | — |
image_style | string | No | — |
publish_mode | string<draft, schedule, publish> | No | — |
schedule_offset_hours | integer | No | — |
schedule_stagger_minutes | integer | No | — |
org_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Sì | — |
is_enabled | boolean | Sì | — |
brief | string | No | — |
tone | string | No | — |
word_count | integer | No | — |
language | string | No | BCP-47, or empty for "the language the brief is written in". |
posts_per_run | integer | No | ⛔ 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 | No | Blank = whatever the funding route resolves to. |
model_id | string | No | Blank = the newest verified model in the family. |
model_family | string | No | — |
anchors | AiAnchor[] | No | — |
anchor_policy | string<none, every_post, rotate> | No | — |
link_set_id | string | No | 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> | Sì | — |
cadence_hour_utc | integer | No | — |
cadence_dow | integer | No | 0 = Monday. |
cadence_dom | integer | No | ⛔ 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 | No | — |
last_run_at | object | No | — |
target_kind | string<none, sites, site_group, cms_targets> | No | — |
target_sites | string[] | No | — |
target_site_group_id | object | No | — |
target_cms_target_ids | string[] | No | — |
target_category | string | No | — |
requires_capabilities | string[] | No | 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> | No | 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 | No | — |
image_model | string | No | — |
featured_image | boolean | No | — |
inline_image_count | integer | No | — |
inline_placement | string<after_intro, between_sections, end> | No | — |
image_style | string | No | — |
publish_mode | string<draft, schedule, publish> | Sì | ⚖️ 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 | No | — |
schedule_stagger_minutes | integer | No | 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[] | No | 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 | Sì | — |
updated_at | string | No | — |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422 · 429