ai

POST /v1/ai/recipes/{recipeId}/run

Queue an AI posting recipe to run now.

Toate punctele finale ai

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea links.edit; o cheie care nu o are va fi respinsă cu 403, nu 404.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

**Returns as soon as the run is recorded — it does not wait for the article.** Writing takes longer than an HTTP request may live: the dashboard aborts at 20s and the engine's own worker timeout is 30s, so a synchronous run was killed mid-call every time. The response carries a run whose `state` is `queued`; poll `GET /v1/ai/recipes/{recipeId}/runs` until it reaches `succeeded`, `partial` or `failed`. A queued run normally starts within two minutes. The work then happens on the customer's own key when they have one, on Zinn® AI credits otherwise — **one meter either way** (owner directive D4). What happens after the drafts exist is the recipe's `publish_mode`, which defaults to `draft`: nothing is scheduled or published unless the customer turned that on for that recipe. A `422` means nothing was queued and nothing was charged — funding is checked before the run is recorded, so an unaffordable run is refused here rather than failing later. Requires `links.edit`.

Parametri

NumeTipObligatoriuCe este
recipeId (path)UuidDa

Răspuns

NumeTipObligatoriuCe este
idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
recipe_idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
triggerstring<manual, schedule>Da
statestring<queued, running, succeeded, partial, failed>Da⛔ `partial` is a real state, not a rounding of failure: some posts were written and a later step failed. Telling the customer the run failed would make them run it again and pay…
started_atobjectNu
finished_atobjectNu
posts_createdintegerNu
post_idsstring[]Nu
anchor_warningsstring[]NuAnchors the model did not place verbatim, aggregated across the run so the customer sees it once instead of opening ten drafts to find out.
fundingstringNuWho paid. `byo` means the article was written on the customer's own key and we charged nothing.
modelstringNu
workflow_idstringNuThe durable execution, when there is one.
error_codestringNuA stable machine code for what went wrong, empty on a clean run. ⛔ Set on a `partial` run as well as a `failed` one — `no_target_sites` (the recipe schedules but names no site)…
errorstringNuThe engine's own English sentence, for a code a client does not recognise. ⛔ A client SHOULD render its own translated copy from `error_code` and fall back to this only for an u…
created_atstringDa

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422 · 429