ai

PATCH /v1/ai/recipes/{recipeId}

Edit an AI posting recipe.

Vituo vyote vya ai

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya links.edit; ufunguo usio nayo unakataliwa kwa 403, si 404.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Sehemu hii ya mwisho inachukua org_id kama uwanja katika mwili wa JSON.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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

Vigezo

JinaAinaInayohitajikaKilicho hiki
recipeId (path)UuidNdiyo

Mwili wa ombi

JinaAinaInayohitajikaKilicho hiki
namestringNdiyo
is_enabledbooleanHapana
briefstringHapana
tonestringHapana
word_countintegerHapana
languagestringHapana
posts_per_runintegerHapana
providerstringHapana
model_idstringHapana
model_familystringHapana
anchorsAiAnchor[]Hapana
anchor_policystring<none, every_post, rotate>Hapana
link_set_idstringHapanaThe 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>Hapana
cadence_hour_utcintegerHapana
cadence_dowintegerHapana
cadence_domintegerHapana
target_kindstring<none, sites, site_group, cms_targets>Hapana
target_sitesstring[]Hapana
target_site_group_idobjectHapana
target_cms_target_idsstring[]Hapana
target_categorystringHapana
requires_capabilitiesstring[]Hapana
capability_policystring<refuse, degrade, ask>Hapana
image_providerstringHapana
image_modelstringHapana
featured_imagebooleanHapana
inline_image_countintegerHapana
inline_placementstring<after_intro, between_sections, end>Hapana
image_stylestringHapana
publish_modestring<draft, schedule, publish>Hapana
schedule_offset_hoursintegerHapana
schedule_stagger_minutesintegerHapana
org_idUuidHapanaUUIDv7 identifier — sortable by creation time (docs/02 §8).

Majibu

JinaAinaInayohitajikaKilicho hiki
idUuidNdiyoUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringNdiyo
is_enabledbooleanNdiyo
briefstringHapana
tonestringHapana
word_countintegerHapana
languagestringHapanaBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerHapana⛔ 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.
providerstringHapanaBlank = whatever the funding route resolves to.
model_idstringHapanaBlank = the newest verified model in the family.
model_familystringHapana
anchorsAiAnchor[]Hapana
anchor_policystring<none, every_post, rotate>Hapana
link_set_idstringHapanaThe 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>Ndiyo
cadence_hour_utcintegerHapana
cadence_dowintegerHapana0 = Monday.
cadence_domintegerHapana⛔ 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_atobjectHapana
last_run_atobjectHapana
target_kindstring<none, sites, site_group, cms_targets>Hapana
target_sitesstring[]Hapana
target_site_group_idobjectHapana
target_cms_target_idsstring[]Hapana
target_categorystringHapana
requires_capabilitiesstring[]HapanaCapability 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>HapanaWhat 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_providerstringHapana
image_modelstringHapana
featured_imagebooleanHapana
inline_image_countintegerHapana
inline_placementstring<after_intro, between_sections, end>Hapana
image_stylestringHapana
publish_modestring<draft, schedule, publish>Ndiyo⚖️ 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_hoursintegerHapana
schedule_stagger_minutesintegerHapanaMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]HapanaProviders 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_atstringNdiyo
updated_atstringHapana

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422 · 429