ai

GET /v1/ai/recipes/{recipeId}

One AI posting recipe.

Todos los endpoints de ai

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso links.view; una clave que no lo tenga se rechazará con un código 403, no 404.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

Requires `links.view`.

Parámetros

NombreTipoObligatorio¿Qué es esto?
recipeId (path)Uuid

Respuesta

NombreTipoObligatorio¿Qué es esto?
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestring
is_enabledboolean
briefstringNo
tonestringNo
word_countintegerNo
languagestringNoBCP-47, or empty for "the language the brief is written in".
posts_per_runintegerNo⛔ 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.
providerstringNoBlank = whatever the funding route resolves to.
model_idstringNoBlank = the newest verified model in the family.
model_familystringNo
anchorsAiAnchor[]No
anchor_policystring<none, every_post, rotate>No
link_set_idstringNoThe 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_utcintegerNo
cadence_dowintegerNo0 = Monday.
cadence_domintegerNo⛔ 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_atobjectNo
last_run_atobjectNo
target_kindstring<none, sites, site_group, cms_targets>No
target_sitesstring[]No
target_site_group_idobjectNo
target_cms_target_idsstring[]No
target_categorystringNo
requires_capabilitiesstring[]NoCapability 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>NoWhat 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_providerstringNo
image_modelstringNo
featured_imagebooleanNo
inline_image_countintegerNo
inline_placementstring<after_intro, between_sections, end>No
image_stylestringNo
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_hoursintegerNo
schedule_stagger_minutesintegerNoMinutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint.
blocking_providersstring[]NoProviders 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_atstringNo

Errores que este endpoint puede devolver

401 · 403 · 404 · 429