ai

PATCH /v1/ai/recipes/{recipeId}

Edit an AI posting recipe.

Барлық ai соңғы нүктелері

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте links.edit рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Ұйымыңыздың идентификаторы орналасатын жер

Бұл соңғы нүкте JSON корпусында өріс ретінде org_id қабылдайды.

Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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 консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған 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`.

Параметрлер

АтыTүріМіндеттіМазмұны
recipeId (path)UuidИә

Сұрау денесі

АтыTүріМіндеттіМазмұны
namestringИә
is_enabledbooleanЖоқ
briefstringЖоқ
tonestringЖоқ
word_countintegerЖоқ
languagestringЖоқ
posts_per_runintegerЖоқ
providerstringЖоқ
model_idstringЖоқ
model_familystringЖоқ
anchorsAiAnchor[]Жоқ
anchor_policystring<none, every_post, rotate>Жоқ
link_set_idstringЖоқ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…
cadencestring<manual, daily, weekly, monthly>Жоқ
cadence_hour_utcintegerЖоқ
cadence_dowintegerЖоқ
cadence_domintegerЖоқ
target_kindstring<none, sites, site_group, cms_targets>Жоқ
target_sitesstring[]Жоқ
target_site_group_idobjectЖоқ
target_cms_target_idsstring[]Жоқ
target_categorystringЖоқ
requires_capabilitiesstring[]Жоқ
capability_policystring<refuse, degrade, ask>Жоқ
image_providerstringЖоқ
image_modelstringЖоқ
featured_imagebooleanЖоқ
inline_image_countintegerЖоқ
inline_placementstring<after_intro, between_sections, end>Жоқ
image_stylestringЖоқ
publish_modestring<draft, schedule, publish>Жоқ
schedule_offset_hoursintegerЖоқ
schedule_stagger_minutesintegerЖоқ
org_idUuidЖоқUUIDv7 identifier — sortable by creation time (docs/02 §8).

Жауап

АтыTүріМіндеттіМазмұны
idUuidИәUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringИә
is_enabledbooleanИә
briefstringЖоқ
tonestringЖоқ
word_countintegerЖоқ
languagestringЖоқBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerЖоқ⛔ 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.
providerstringЖоқBlank = whatever the funding route resolves to.
model_idstringЖоқBlank = the newest verified model in the family.
model_familystringЖоқ
anchorsAiAnchor[]Жоқ
anchor_policystring<none, every_post, rotate>Жоқ
link_set_idstringЖоқ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…
cadencestring<manual, daily, weekly, monthly>Иә
cadence_hour_utcintegerЖоқ
cadence_dowintegerЖоқ0 = Monday.
cadence_domintegerЖоқ⛔ 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_atobjectЖоқ
last_run_atobjectЖоқ
target_kindstring<none, sites, site_group, cms_targets>Жоқ
target_sitesstring[]Жоқ
target_site_group_idobjectЖоқ
target_cms_target_idsstring[]Жоқ
target_categorystringЖоқ
requires_capabilitiesstring[]Жоқ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_policystring<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_providerstringЖоқ
image_modelstringЖоқ
featured_imagebooleanЖоқ
inline_image_countintegerЖоқ
inline_placementstring<after_intro, between_sections, end>Жоқ
image_stylestringЖоқ
publish_modestring<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_hoursintegerЖоқ
schedule_stagger_minutesintegerЖоқMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]Жоқ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_atstringИә
updated_atstringЖоқ

Бұл соңғы нүкте қайтара алатын қателер

401 · 403 · 404 · 422 · 429