ai
POST /v1/ai/recipes/{recipeId}/run
Queue an AI posting recipe to run now.
認証
ベアラー トークンとして API キーを送信します。キーには links.edit 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/ai/recipes/{recipeId}/run \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 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