ai

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

Queue an AI posting recipe to run now.

Bütün ai nöqtələri

Doğrulama

API açarını bearer token kimi göndərin. Açar links.edit icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

**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`.

Parametrlər

AdTipTələb olunurNədir
recipeId (path)UuidBəli

Cavab

AdTipTələb olunurNədir
idUuidBəliUUIDv7 identifier — sortable by creation time (docs/02 §8).
recipe_idUuidBəliUUIDv7 identifier — sortable by creation time (docs/02 §8).
triggerstring<manual, schedule>Bəli
statestring<queued, running, succeeded, partial, failed>Bəli⛔ `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_atobjectXeyr
finished_atobjectXeyr
posts_createdintegerXeyr
post_idsstring[]Xeyr
anchor_warningsstring[]XeyrAnchors the model did not place verbatim, aggregated across the run so the customer sees it once instead of opening ten drafts to find out.
fundingstringXeyrWho paid. `byo` means the article was written on the customer's own key and we charged nothing.
modelstringXeyr
workflow_idstringXeyrThe durable execution, when there is one.
error_codestringXeyrA 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)…
errorstringXeyrThe 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_atstringBəli

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 422 · 429