Autentifikatsiya
API kalitini bearer token sifatida yuboring. Kalit links.edit ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.
Tashkilotingiz identifikatori kiritiladigan joy
Ushbu so'rov JSON tanasida org_id ni maydon sifatida qabul qiladi.
Tashkilotingiz identifikatori boshqaruv panelingizdagi API kalitlari ekranida, kalitning o'z yonida joylashgan. Bu siz amalga oshiradigan har bir so'rovda bir xil identifikator hisoblanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X PATCH https://api.zinndigital.com/v1/ai/recipes/{recipeId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
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`.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
recipeId (path) | Uuid | Ha | — |
Soʻrov tanasi
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
name | string | Ha | — |
is_enabled | boolean | Yo'q | — |
brief | string | Yo'q | — |
tone | string | Yo'q | — |
word_count | integer | Yo'q | — |
language | string | Yo'q | — |
posts_per_run | integer | Yo'q | — |
provider | string | Yo'q | — |
model_id | string | Yo'q | — |
model_family | string | Yo'q | — |
anchors | AiAnchor[] | Yo'q | — |
anchor_policy | string<none, every_post, rotate> | Yo'q | — |
link_set_id | string | Yo'q | 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> | Yo'q | — |
cadence_hour_utc | integer | Yo'q | — |
cadence_dow | integer | Yo'q | — |
cadence_dom | integer | Yo'q | — |
target_kind | string<none, sites, site_group, cms_targets> | Yo'q | — |
target_sites | string[] | Yo'q | — |
target_site_group_id | object | Yo'q | — |
target_cms_target_ids | string[] | Yo'q | — |
target_category | string | Yo'q | — |
requires_capabilities | string[] | Yo'q | — |
capability_policy | string<refuse, degrade, ask> | Yo'q | — |
image_provider | string | Yo'q | — |
image_model | string | Yo'q | — |
featured_image | boolean | Yo'q | — |
inline_image_count | integer | Yo'q | — |
inline_placement | string<after_intro, between_sections, end> | Yo'q | — |
image_style | string | Yo'q | — |
publish_mode | string<draft, schedule, publish> | Yo'q | — |
schedule_offset_hours | integer | Yo'q | — |
schedule_stagger_minutes | integer | Yo'q | — |
org_id | Uuid | Yo'q | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Ha | — |
is_enabled | boolean | Ha | — |
brief | string | Yo'q | — |
tone | string | Yo'q | — |
word_count | integer | Yo'q | — |
language | string | Yo'q | BCP-47, or empty for "the language the brief is written in". |
posts_per_run | integer | Yo'q | ⛔ 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 | Yo'q | Blank = whatever the funding route resolves to. |
model_id | string | Yo'q | Blank = the newest verified model in the family. |
model_family | string | Yo'q | — |
anchors | AiAnchor[] | Yo'q | — |
anchor_policy | string<none, every_post, rotate> | Yo'q | — |
link_set_id | string | Yo'q | 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> | Ha | — |
cadence_hour_utc | integer | Yo'q | — |
cadence_dow | integer | Yo'q | 0 = Monday. |
cadence_dom | integer | Yo'q | ⛔ 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 | Yo'q | — |
last_run_at | object | Yo'q | — |
target_kind | string<none, sites, site_group, cms_targets> | Yo'q | — |
target_sites | string[] | Yo'q | — |
target_site_group_id | object | Yo'q | — |
target_cms_target_ids | string[] | Yo'q | — |
target_category | string | Yo'q | — |
requires_capabilities | string[] | Yo'q | 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> | Yo'q | 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 | Yo'q | — |
image_model | string | Yo'q | — |
featured_image | boolean | Yo'q | — |
inline_image_count | integer | Yo'q | — |
inline_placement | string<after_intro, between_sections, end> | Yo'q | — |
image_style | string | Yo'q | — |
publish_mode | string<draft, schedule, publish> | Ha | ⚖️ 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 | Yo'q | — |
schedule_stagger_minutes | integer | Yo'q | 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[] | Yo'q | 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 | Ha | — |
updated_at | string | Yo'q | — |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 422 · 429