認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/content/runs \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "brief": <string>, "site_ids": <string[]> }'ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Writes one article from the brief and places it on every site named, eight at a time. Answers **201 immediately** with the run row — the work itself happens on the durable queue, and the run screen shows it progressing. Gated on `links.edit`, the same key as scheduling a post by hand, because that is what this creates. ⛔ `publish_policy` defaults to `draft_only`, so a request that omits it produces scheduled drafts and puts nothing live. `unattended` is the only value that publishes without a human, and it is the mode the durability guarantees are written for. ⛔ Every site id must belong to this organisation. A run naming a site that does not is refused whole with 422 rather than quietly posting to the rest — *"it only posted to some of them"* is not a state a customer can act on. Sites that cannot receive a post (suspended, a non-WordPress stack, transferred away) are recorded as `skipped` with a reason and do not stop the run.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
brief | string | はい | — |
site_ids | string[] | はい | — |
anchors | ContentRunAnchor[] | いいえ | — |
category | string | いいえ | — |
publish_policy | ContentRunPublishPolicy | いいえ | — |
recipe_id | string | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | string | はい | — |
state | ContentRunState | はい | Where a run got to. `partial` is a real, honest, terminal answer and not a euphemism: some sites published and some did not, nothing is left to try, and the failures can be resu… |
publish_policy | ContentRunPublishPolicy | はい | How far a run may go on its own. `draft_only` is the default and puts nothing live. |
recipe_id | string | いいえ | — |
brief | string | はい | — |
category | string | いいえ | — |
post_id | string | いいえ | The article this run wrote. Written once and reused for every site, so a resumed run places the SAME copy rather than paying for a second generation. |
attempt | integer | はい | Which pass over the failures this is. 0 is the original run. |
workflow_id | string | いいえ | — |
totals | ContentRunTotals | はい | — |
reason | ContentRunFailureReason | いいえ | — |
provider | string | いいえ | — |
message | string | いいえ | An English sentence for the customer. Clients should render their own localised text from `reason` and fall back to this only for a code they do not know. |
resumable | boolean | はい | Whether a resume would actually do anything. False on a paused run with nothing failed — do not offer the button when this is false. |
started_at | string | いいえ | — |
finished_at | string | いいえ | — |
created_at | string | はい | — |
items | ContentRunItem[] | はい | — |
このエンドポイントが返すエラー
401 · 403 · 422 · 503