GET `/v1/ai/recipes/{recipeId}`

One AI posting recipe.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن links.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X GET https://api.zinndigital.com/v1/ai/recipes/{recipeId} \
  -H "Authorization: Bearer zdk_live_…"

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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

GET /v1/ai/recipes/{recipeId}