احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز links.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/ai/recipes/{recipeId} \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Requires `links.view`.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
recipeId (path) | Uuid | بله | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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 · 429