ai

POST /v1/ai/recipes

Create an AI posting recipe.

Tous les points de terminaison ai

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation links.edit ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet endpoint prend org_id comme champ dans le corps JSON.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X POST https://api.zinndigital.com/v1/ai/recipes \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

⛔ Bounds are enforced at **authoring** time, not at run time: more than five anchors or more than ten posts per run would be refused on every run, so a recipe saved with them would look fine, sit on a schedule, and fail silently every night. Requires `links.edit` — the same key as writing a post by hand, because that is what this is.

Corps de la requête

NomTypeObligatoireQu'est-ce que c'est
namestringOui
is_enabledbooleanNon
briefstringNon
tonestringNon
word_countintegerNon
languagestringNon
posts_per_runintegerNon
providerstringNon
model_idstringNon
model_familystringNon
anchorsAiAnchor[]Non
anchor_policystring<none, every_post, rotate>Non
link_set_idstringNonThe 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>Non
cadence_hour_utcintegerNon
cadence_dowintegerNon
cadence_domintegerNon
target_kindstring<none, sites, site_group, cms_targets>Non
target_sitesstring[]Non
target_site_group_idobjectNon
target_cms_target_idsstring[]Non
target_categorystringNon
requires_capabilitiesstring[]Non
capability_policystring<refuse, degrade, ask>Non
image_providerstringNon
image_modelstringNon
featured_imagebooleanNon
inline_image_countintegerNon
inline_placementstring<after_intro, between_sections, end>Non
image_stylestringNon
publish_modestring<draft, schedule, publish>Non
schedule_offset_hoursintegerNon
schedule_stagger_minutesintegerNon
org_idUuidNonUUIDv7 identifier — sortable by creation time (docs/02 §8).

Réponse

NomTypeObligatoireQu'est-ce que c'est
idUuidOuiUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringOui
is_enabledbooleanOui
briefstringNon
tonestringNon
word_countintegerNon
languagestringNonBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerNon⛔ 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.
providerstringNonBlank = whatever the funding route resolves to.
model_idstringNonBlank = the newest verified model in the family.
model_familystringNon
anchorsAiAnchor[]Non
anchor_policystring<none, every_post, rotate>Non
link_set_idstringNonThe 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>Oui
cadence_hour_utcintegerNon
cadence_dowintegerNon0 = Monday.
cadence_domintegerNon⛔ 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_atobjectNon
last_run_atobjectNon
target_kindstring<none, sites, site_group, cms_targets>Non
target_sitesstring[]Non
target_site_group_idobjectNon
target_cms_target_idsstring[]Non
target_categorystringNon
requires_capabilitiesstring[]NonCapability 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>NonWhat 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_providerstringNon
image_modelstringNon
featured_imagebooleanNon
inline_image_countintegerNon
inline_placementstring<after_intro, between_sections, end>Non
image_stylestringNon
publish_modestring<draft, schedule, publish>Oui⚖️ 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_hoursintegerNon
schedule_stagger_minutesintegerNonMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]NonProviders 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_atstringOui
updated_atstringNon

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 422 · 429