ai
POST /v1/ai/recipes/{recipeId}/run
Queue an AI posting recipe to run now.
تصدیقهویت
یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د links.edit اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.
دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
curl -X POST https://api.zinndigital.com/v1/ai/recipes/{recipeId}/run \
-H "Authorization: Bearer zdk_live_…"ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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 | هو | — |
تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي
401 · 403 · 404 · 422 · 429