ai

PATCH /v1/ai/recipes/{recipeId}

Edit an AI posting recipe.

Všechny koncové body ai

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění links.edit; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako pole v těle JSON.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X PATCH https://api.zinndigital.com/v1/ai/recipes/{recipeId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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`.

Parametry

NázevTypPožadovánoCo to je
recipeId (path)UuidAno

Tělo požadavku

NázevTypPožadovánoCo to je
namestringAno
is_enabledbooleanNe
briefstringNe
tonestringNe
word_countintegerNe
languagestringNe
posts_per_runintegerNe
providerstringNe
model_idstringNe
model_familystringNe
anchorsAiAnchor[]Ne
anchor_policystring<none, every_post, rotate>Ne
link_set_idstringNeThe 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…
cadencestring<manual, daily, weekly, monthly>Ne
cadence_hour_utcintegerNe
cadence_dowintegerNe
cadence_domintegerNe
target_kindstring<none, sites, site_group, cms_targets>Ne
target_sitesstring[]Ne
target_site_group_idobjectNe
target_cms_target_idsstring[]Ne
target_categorystringNe
requires_capabilitiesstring[]Ne
capability_policystring<refuse, degrade, ask>Ne
image_providerstringNe
image_modelstringNe
featured_imagebooleanNe
inline_image_countintegerNe
inline_placementstring<after_intro, between_sections, end>Ne
image_stylestringNe
publish_modestring<draft, schedule, publish>Ne
schedule_offset_hoursintegerNe
schedule_stagger_minutesintegerNe
org_idUuidNeUUIDv7 identifier — sortable by creation time (docs/02 §8).

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringAno
is_enabledbooleanAno
briefstringNe
tonestringNe
word_countintegerNe
languagestringNeBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerNe⛔ 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.
providerstringNeBlank = whatever the funding route resolves to.
model_idstringNeBlank = the newest verified model in the family.
model_familystringNe
anchorsAiAnchor[]Ne
anchor_policystring<none, every_post, rotate>Ne
link_set_idstringNeThe 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…
cadencestring<manual, daily, weekly, monthly>Ano
cadence_hour_utcintegerNe
cadence_dowintegerNe0 = Monday.
cadence_domintegerNe⛔ 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_atobjectNe
last_run_atobjectNe
target_kindstring<none, sites, site_group, cms_targets>Ne
target_sitesstring[]Ne
target_site_group_idobjectNe
target_cms_target_idsstring[]Ne
target_categorystringNe
requires_capabilitiesstring[]NeCapability 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_policystring<refuse, degrade, ask>NeWhat 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_providerstringNe
image_modelstringNe
featured_imagebooleanNe
inline_image_countintegerNe
inline_placementstring<after_intro, between_sections, end>Ne
image_stylestringNe
publish_modestring<draft, schedule, publish>Ano⚖️ 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_hoursintegerNe
schedule_stagger_minutesintegerNeMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]NeProviders 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_atstringAno
updated_atstringNe

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429