Аутентификация
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үрі | Міндетті | Мазмұны |
|---|---|---|---|
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). |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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