ai

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

Queue an AI posting recipe to run now.

Tất cả các điểm cuối ai

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền links.edit; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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

Tham số

TênLoạiBắt buộcNội dung này là gì
recipeId (path)Uuid

Phản hồi

TênLoạiBắt buộcNội dung này là gì
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
recipe_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
triggerstring<manual, schedule>
statestring<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_atobjectKhông
finished_atobjectKhông
posts_createdintegerKhông
post_idsstring[]Không
anchor_warningsstring[]KhôngAnchors the model did not place verbatim, aggregated across the run so the customer sees it once instead of opening ten drafts to find out.
fundingstringKhôngWho paid. `byo` means the article was written on the customer's own key and we charged nothing.
modelstringKhông
workflow_idstringKhôngThe durable execution, when there is one.
error_codestringKhôngA 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)…
errorstringKhôngThe 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_atstring

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 422 · 429