ai

GET /v1/ai/recipes/{recipeId}

One AI posting recipe.

Lahat ng ai endpoint

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na links.view; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

Requires `links.view`.

Mga Parameter

PangalanUriKailanganAno ito
recipeId (path)UuidOo

Tugon

PangalanUriKailanganAno ito
idUuidOoUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringOo
is_enabledbooleanOo
briefstringHindi
tonestringHindi
word_countintegerHindi
languagestringHindiBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerHindi⛔ 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.
providerstringHindiBlank = whatever the funding route resolves to.
model_idstringHindiBlank = the newest verified model in the family.
model_familystringHindi
anchorsAiAnchor[]Hindi
anchor_policystring<none, every_post, rotate>Hindi
link_set_idstringHindiThe 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…
cadencestring<manual, daily, weekly, monthly>Oo
cadence_hour_utcintegerHindi
cadence_dowintegerHindi0 = Monday.
cadence_domintegerHindi⛔ 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_atobjectHindi
last_run_atobjectHindi
target_kindstring<none, sites, site_group, cms_targets>Hindi
target_sitesstring[]Hindi
target_site_group_idobjectHindi
target_cms_target_idsstring[]Hindi
target_categorystringHindi
requires_capabilitiesstring[]HindiCapability 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_policystring<refuse, degrade, ask>HindiWhat 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_providerstringHindi
image_modelstringHindi
featured_imagebooleanHindi
inline_image_countintegerHindi
inline_placementstring<after_intro, between_sections, end>Hindi
image_stylestringHindi
publish_modestring<draft, schedule, publish>Oo⚖️ 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_hoursintegerHindi
schedule_stagger_minutesintegerHindiMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]HindiProviders 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_atstringOo
updated_atstringHindi

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 429