ai

GET /v1/ai/recipes/{recipeId}

One AI posting recipe.

Alle ai Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung links.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Requires `links.view`.

Parameter

NameTypErforderlichWas es ist
recipeId (path)UuidJa

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringJa
is_enabledbooleanJa
briefstringNein
tonestringNein
word_countintegerNein
languagestringNeinBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerNein⛔ 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.
providerstringNeinBlank = whatever the funding route resolves to.
model_idstringNeinBlank = the newest verified model in the family.
model_familystringNein
anchorsAiAnchor[]Nein
anchor_policystring<none, every_post, rotate>Nein
link_set_idstringNeinThe 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>Ja
cadence_hour_utcintegerNein
cadence_dowintegerNein0 = Monday.
cadence_domintegerNein⛔ 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_atobjectNein
last_run_atobjectNein
target_kindstring<none, sites, site_group, cms_targets>Nein
target_sitesstring[]Nein
target_site_group_idobjectNein
target_cms_target_idsstring[]Nein
target_categorystringNein
requires_capabilitiesstring[]NeinCapability 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>NeinWhat 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_providerstringNein
image_modelstringNein
featured_imagebooleanNein
inline_image_countintegerNein
inline_placementstring<after_intro, between_sections, end>Nein
image_stylestringNein
publish_modestring<draft, schedule, publish>Ja⚖️ 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_hoursintegerNein
schedule_stagger_minutesintegerNeinMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]NeinProviders 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_atstringJa
updated_atstringNein

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429