agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this board.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw 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>> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
boardId (path) | Uuid | Ja | Project board ID (UUIDv7). |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
function | string<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked> | Ja | Which AI function to run. |
card_id | Uuid | Nee | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
apply | boolean | Nee | 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 | Nee | 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; `forc… |
options | object | Nee | Per-function input. `draft_card` takes `brief` and optionally `source`; `release_notes` takes `column_id`. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
function | string | Ja | — |
text | string | Ja | The output, or the reason it was skipped. |
payload | object | Nee | Structured result — labels, sub-tasks, candidate duplicates. |
model | string | Nee | The model that served it. Null on a skip, because none was chosen. |
provider | string | Nee | — |
funding | string<byo, credits, included> | Nee | 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 | Nee | The meter row, so board history and AI spend join up. Null on a skip. |
skipped | boolean | Ja | **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 | Nee | 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> | Nee | 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 | Nee | 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 Englis… |
failure | VendorFailure | Nee | `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 | Nee | Served from the previous identical run rather than the model. |
created_card_ids | Uuid[] | Nee | — |
run_id | Uuid | Nee | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422