Authentication
Send an API key as a bearer token. The key must carry the links.edit permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/ai/recipes \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔ 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.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | Yes | — |
is_enabled | boolean | No | — |
brief | string | No | — |
tone | string | No | — |
word_count | integer | No | — |
language | string | No | — |
posts_per_run | integer | No | — |
provider | string | No | — |
model_id | string | No | — |
model_family | string | No | — |
anchors | AiAnchor[] | No | — |
anchor_policy | string<none, every_post, rotate> | No | — |
link_set_id | string | No | 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… |
cadence | string<manual, daily, weekly, monthly> | No | — |
cadence_hour_utc | integer | No | — |
cadence_dow | integer | No | — |
cadence_dom | integer | No | — |
target_kind | string<none, sites, site_group, cms_targets> | No | — |
target_sites | string[] | No | — |
target_site_group_id | object | No | — |
target_cms_target_ids | string[] | No | — |
target_category | string | No | — |
requires_capabilities | string[] | No | — |
capability_policy | string<refuse, degrade, ask> | No | — |
image_provider | string | No | — |
image_model | string | No | — |
featured_image | boolean | No | — |
inline_image_count | integer | No | — |
inline_placement | string<after_intro, between_sections, end> | No | — |
image_style | string | No | — |
publish_mode | string<draft, schedule, publish> | No | — |
schedule_offset_hours | integer | No | — |
schedule_stagger_minutes | integer | No | — |
org_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Yes | — |
is_enabled | boolean | Yes | — |
brief | string | No | — |
tone | string | No | — |
word_count | integer | No | — |
language | string | No | BCP-47, or empty for "the language the brief is written in". |
posts_per_run | integer | No | ⛔ 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. |
provider | string | No | Blank = whatever the funding route resolves to. |
model_id | string | No | Blank = the newest verified model in the family. |
model_family | string | No | — |
anchors | AiAnchor[] | No | — |
anchor_policy | string<none, every_post, rotate> | No | — |
link_set_id | string | No | 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… |
cadence | string<manual, daily, weekly, monthly> | Yes | — |
cadence_hour_utc | integer | No | — |
cadence_dow | integer | No | 0 = Monday. |
cadence_dom | integer | No | ⛔ 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_at | object | No | — |
last_run_at | object | No | — |
target_kind | string<none, sites, site_group, cms_targets> | No | — |
target_sites | string[] | No | — |
target_site_group_id | object | No | — |
target_cms_target_ids | string[] | No | — |
target_category | string | No | — |
requires_capabilities | string[] | No | 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_policy | string<refuse, degrade, ask> | No | 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_provider | string | No | — |
image_model | string | No | — |
featured_image | boolean | No | — |
inline_image_count | integer | No | — |
inline_placement | string<after_intro, between_sections, end> | No | — |
image_style | string | No | — |
publish_mode | string<draft, schedule, publish> | Yes | ⚖️ 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_hours | integer | No | — |
schedule_stagger_minutes | integer | No | Minutes between consecutive posts in one run. ⛔ Not cosmetic: a network whose articles all appear in the same minute is a footprint. |
blocking_providers | string[] | No | 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_at | string | Yes | — |
updated_at | string | No | — |
Errors this endpoint can return
401 · 403 · 422 · 429