agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this board.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/ai/run \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "function": <string<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked>> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Runs a board AI function and returns its output. A refusal to spend is a 200, not a 4xx. When the org has no AI credit, no provider key, or is not in good standing, the response carries skipped: true with a skipReason and a customer-readable text — because the customer asked and we told them why not, which is a complete answer rather than a fault in their request. ⛔ A client reading 200 as "it ran" will record a success for a call that did nothing. Read skipped. apply defaults to false: AI on a board proposes and a person commits.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
boardId (path) | Uuid | 是 | Project board ID (UUIDv7). |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
function | string<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked> | 是 | Which AI function to run. |
card_id | Uuid | 否 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
apply | boolean | 否 | Write the result to the board. Defaults to false: AI on a board proposes and a person commits, so the irreversible half must be asked for explicitly. |
force | boolean | 否 | Re-run rather than replay. An identical call within 15 minutes is served from the previous run with no model call and no charge, so a retried automation cannot bill twice; force… |
options | object | 否 | Per-function input. draft_card takes brief and optionally source; release_notes takes column_id. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
function | string | 是 | — |
text | string | 是 | The output, or the reason it was skipped. |
payload | object | 否 | Structured result — labels, sub-tasks, candidate duplicates. |
model | string | 否 | The model that served it. Null on a skip, because none was chosen. |
provider | string | 否 | — |
funding | string<byo, credits, included> | 否 | Who paid. byo is the customer's own provider key; credits and included are Zinn®'s. All three are recorded on the same meter. |
usage_id | Uuid | 否 | The meter row, so board history and AI spend join up. Null on a skip. |
skipped | boolean | 是 | Read this. True means nothing ran and nothing was charged. A caller that treats 200 as "it worked" records a success for a call that did nothing. |
skip_reason | string | 否 | Machine-readable cause, e.g. AI_BUDGET_EXHAUSTED, AI_NOT_IN_GOOD_STANDING, not_enough_discussion, nothing_blocked. |
skip_kind | string<nothing_to_do, not_in_good_standing, not_entitled, unavailable> | 否 | The CLASS of the skip, beside its code. nothing_to_do is the product working (a healthy board has nothing blocked; a thread is too short to summarise) and is good news, not a… |
skip_params | object | 否 | The values the refusal sentence quotes (count, column), sent structurally so a client can render that sentence in the customer's own language rather than the engine's English.… |
failure | VendorFailure | 否 | CLAUDE.md §57 — what to tell the customer about a refusal, as a stable message key plus a tone, so the dashboard renders the sentence in their own language. Present only on a… |
cached | boolean | 否 | Served from the previous identical run rather than the model. |
created_card_ids | Uuid[] | 否 | — |
run_id | Uuid | 否 | — |
此端点可能返回的错误
401 · 403 · 404 · 422