ai
POST /v1/ai/recipes/{recipeId}/run
Queue an AI posting recipe to run now.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението links.edit; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/ai/recipes/{recipeId}/run \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
recipeId (path) | Uuid | Да | — |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
recipe_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
trigger | string<manual, schedule> | Да | — |
state | string<queued, running, succeeded, partial, failed> | Да | ⛔ 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_at | object | Не | — |
finished_at | object | Не | — |
posts_created | integer | Не | — |
post_ids | string[] | Не | — |
anchor_warnings | string[] | Не | Anchors the model did not place verbatim, aggregated across the run so the customer sees it once instead of opening ten drafts to find out. |
funding | string | Не | Who paid. byo means the article was written on the customer's own key and we charged nothing. |
model | string | Не | — |
workflow_id | string | Не | The durable execution, when there is one. |
error_code | string | Не | A 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)… |
error | string | Не | The 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… |
created_at | string | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429