agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this board.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
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>> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
function | string<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked> | Yes | Which AI function to run. |
card_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
apply | boolean | No | 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 | No | 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 | No | Per-function input. draft_card takes brief and optionally source; release_notes takes column_id. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
function | string | Yes | — |
text | string | Yes | The output, or the reason it was skipped. |
payload | object | No | Structured result — labels, sub-tasks, candidate duplicates. |
model | string | No | The model that served it. Null on a skip, because none was chosen. |
provider | string | No | — |
funding | string<byo, credits, included> | No | 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 | No | The meter row, so board history and AI spend join up. Null on a skip. |
skipped | boolean | Yes | 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 | No | 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> | No | 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 | No | 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 | No | 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 | No | Served from the previous identical run rather than the model. |
created_card_ids | Uuid[] | No | — |
run_id | Uuid | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422