توثيقِ شناخت
ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس links.edit اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔
جہاں آپ کی تنظیم کی آئی ڈی آتی ہے
یہ اینڈ پوائنٹ JSON باڈی میں ایک فیلڈ کے طور پر org_id لیتا ہے۔
آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر API کیز کی سکرین پر، خود کلید کے ساتھ موجود ہوتی ہے۔ یہ آپ کی کی جانے والی ہر کال میں ایک ہی آئی ڈی ہوتی ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
curl -X POST https://api.zinndigital.com/v1/ai/recipes \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں
تفصیلات
⛔ Bounds are enforced at **authoring** time, not at run time: more than five anchors or more than ten posts per run would be refused on every run, so a recipe saved with them would look fine, sit on a schedule, and fail silently every night. Requires `links.edit` — the same key as writing a post by hand, because that is what this is.
درخواست کا باڈی
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
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). |
جواب
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
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 · 422 · 429