ai

GET /v1/ai/recipes/{recipeId}

One AI posting recipe.

すべての ai エンドポイント

認証

ベアラー トークンとして API キーを送信します。キーには links.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Requires `links.view`.

パラメータ

名前タイプ必須これがその内容です
recipeId (path)Uuidはい

返信

名前タイプ必須これがその内容です
idUuidはいUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringはい
is_enabledbooleanはい
briefstringいいえ
tonestringいいえ
word_countintegerいいえ
languagestringいいえBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerいいえ⛔ 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.
providerstringいいえBlank = whatever the funding route resolves to.
model_idstringいいえBlank = the newest verified model in the family.
model_familystringいいえ
anchorsAiAnchor[]いいえ
anchor_policystring<none, every_post, rotate>いいえ
link_set_idstringいいえ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…
cadencestring<manual, daily, weekly, monthly>はい
cadence_hour_utcintegerいいえ
cadence_dowintegerいいえ0 = Monday.
cadence_domintegerいいえ⛔ 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_atobjectいいえ
last_run_atobjectいいえ
target_kindstring<none, sites, site_group, cms_targets>いいえ
target_sitesstring[]いいえ
target_site_group_idobjectいいえ
target_cms_target_idsstring[]いいえ
target_categorystringいいえ
requires_capabilitiesstring[]いいえ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_policystring<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_providerstringいいえ
image_modelstringいいえ
featured_imagebooleanいいえ
inline_image_countintegerいいえ
inline_placementstring<after_intro, between_sections, end>いいえ
image_stylestringいいえ
publish_modestring<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_hoursintegerいいえ
schedule_stagger_minutesintegerいいえMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]いいえ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_atstringはい
updated_atstringいいえ

このエンドポイントが返すエラー

401 · 403 · 404 · 429