ai

GET /v1/ai/recipes/{recipeId}

One AI posting recipe.

Semua titik akhir ai

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin links.view; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

Requires `links.view`.

Parameter

NamaJenisWajibTentang apa ini
recipeId (path)UuidYa

Tanggapan

NamaJenisWajibTentang apa ini
idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringYa
is_enabledbooleanYa
briefstringTidak
tonestringTidak
word_countintegerTidak
languagestringTidakBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerTidak⛔ 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.
providerstringTidakBlank = whatever the funding route resolves to.
model_idstringTidakBlank = the newest verified model in the family.
model_familystringTidak
anchorsAiAnchor[]Tidak
anchor_policystring<none, every_post, rotate>Tidak
link_set_idstringTidakThe 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>Ya
cadence_hour_utcintegerTidak
cadence_dowintegerTidak0 = Monday.
cadence_domintegerTidak⛔ 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_atobjectTidak
last_run_atobjectTidak
target_kindstring<none, sites, site_group, cms_targets>Tidak
target_sitesstring[]Tidak
target_site_group_idobjectTidak
target_cms_target_idsstring[]Tidak
target_categorystringTidak
requires_capabilitiesstring[]TidakCapability 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>TidakWhat 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_providerstringTidak
image_modelstringTidak
featured_imagebooleanTidak
inline_image_countintegerTidak
inline_placementstring<after_intro, between_sections, end>Tidak
image_stylestringTidak
publish_modestring<draft, schedule, publish>Ya⚖️ 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_hoursintegerTidak
schedule_stagger_minutesintegerTidakMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]TidakProviders 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_atstringYa
updated_atstringTidak

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429