Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin links.edit; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X POST https://api.zinndigital.com/v1/ai/recipes/{recipeId}/run \
-H "Authorization: Bearer zdk_live_…"Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
**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`.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
recipeId (path) | Uuid | Ya | — |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
recipe_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
trigger | string<manual, schedule> | Ya | — |
state | string<queued, running, succeeded, partial, failed> | Ya | ⛔ `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 | Tidak | — |
finished_at | object | Tidak | — |
posts_created | integer | Tidak | — |
post_ids | string[] | Tidak | — |
anchor_warnings | string[] | Tidak | 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 | Tidak | Who paid. `byo` means the article was written on the customer's own key and we charged nothing. |
model | string | Tidak | — |
workflow_id | string | Tidak | The durable execution, when there is one. |
error_code | string | Tidak | 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 | Tidak | 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 u… |
created_at | string | Ya | — |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422 · 429