agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this board.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
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>> }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
boardId (path) | Uuid | Da | Project board ID (UUIDv7). |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
function | string<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked> | Da | Which AI function to run. |
card_id | Uuid | Nu | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
apply | boolean | Nu | 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 | Nu | 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 | Nu | Per-function input. `draft_card` takes `brief` and optionally `source`; `release_notes` takes `column_id`. |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
function | string | Da | — |
text | string | Da | The output, or the reason it was skipped. |
payload | object | Nu | Structured result — labels, sub-tasks, candidate duplicates. |
model | string | Nu | The model that served it. Null on a skip, because none was chosen. |
provider | string | Nu | — |
funding | string<byo, credits, included> | Nu | 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 | Nu | The meter row, so board history and AI spend join up. Null on a skip. |
skipped | boolean | Da | **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 | Nu | 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> | Nu | 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 | Nu | 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 | Nu | `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 | Nu | Served from the previous identical run rather than the model. |
created_card_ids | Uuid[] | Nu | — |
run_id | Uuid | Nu | — |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 422